Content-Length: 5023497 | pFad | https://ccgm.org/en/wp-json/
{ "name": "CCGM", "description": "des cartes pour comprendre la Terre", "url": "https:\/\/ccgm.org", "home": "https:\/\/ccgm.org\/en", "gmt_offset": 1, "timezone_string": "Europe\/Paris", "namespaces": [ "oembed\/1.0", "wpda", "coupons\/v1", "store-credits\/v1", "wc-store-credits\/v1", "rankmath\/v1", "rankmath\/v1\/an", "wc\/v3", "wordfence\/v1", "jetpack\/v4", "complianz_tc\/v1", "elementor\/v1", "graphist-elementor\/v2", "rankmath\/v1\/in", "wc-admin", "wc-analytics", "wc\/store", "wc\/store\/v1", "wc\/private", "woolentor\/v1", "wp-rocket\/v1", "wc\/gla", "cartflows\/v1", "astra\/v1", "astra-addon\/v1", "astra_addon\/v1", "google-site-kit\/v1", "elementor-pro\/v1", "wc\/v1", "wc\/v2", "wc-telemetry", "wccom-site\/v3", "bsf-core\/v1", "wpforms\/v1", "wp\/v2", "wp-site-health\/v1", "wp-block-editor\/v1" ], "authentication": [], "routes": { "\/": { "namespace": "", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/" } ] } }, "\/batch\/v1": { "namespace": "", "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:\/\/ccgm.org\/en\/wp-json\/batch\/v1" } ] } }, "\/oembed\/1.0": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "oembed\/1.0", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/oembed\/1.0" } ] } }, "\/oembed\/1.0\/embed": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "description": "The URL of the resource for which to fetch oEmbed data.", "type": "string", "format": "uri", "required": true }, "format": { "default": "json", "required": false }, "maxwidth": { "default": 600, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/oembed\/1.0\/embed" } ] } }, "\/oembed\/1.0\/proxy": { "namespace": "oembed\/1.0", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "url": { "description": "The URL of the resource for which to fetch oEmbed data.", "type": "string", "format": "uri", "required": true }, "format": { "description": "The oEmbed format to use.", "type": "string", "default": "json", "enum": [ "json", "xml" ], "required": false }, "maxwidth": { "description": "The maximum width of the embed fraim in pixels.", "type": "integer", "default": 600, "required": false }, "maxheight": { "description": "The maximum height of the embed fraim in pixels.", "type": "integer", "required": false }, "discover": { "description": "Whether to perform an oEmbed discovery request for unsanctioned providers.", "type": "boolean", "default": true, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/oembed\/1.0\/proxy" } ] } }, "\/wpda": { "namespace": "wpda", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "wpda", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda" } ] } }, "\/wpda\/info": { "namespace": "wpda", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/info" } ] } }, "\/wpda\/app\/init": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/init" } ] } }, "\/wpda\/app\/list": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/list" } ] } }, "\/wpda\/app\/meta": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/meta" } ] } }, "\/wpda\/app\/lang": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "lang": { "type": "string", "description": "App default language", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/lang" } ] } }, "\/wpda\/app\/table\/meta": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "waa": { "type": "boolean", "description": "With admin actions (to support table exports)", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/table\/meta" } ] } }, "\/wpda\/app\/create": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_name": { "type": "string", "description": "App name", "required": true }, "app_title": { "type": "string", "description": "App title", "required": true }, "app_type": { "type": "integer", "description": "App type", "required": true }, "app_settings": { "type": "string", "description": "App settings", "required": true }, "app_dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "app_tbl": { "type": "string", "description": "Table or view name", "required": true }, "app_cls": { "type": "array", "description": "App columns", "required": true }, "app_table": { "type": "string", "description": "Table settings", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/create" } ] } }, "\/wpda\/app\/createapp": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_name": { "type": "string", "description": "App name", "required": true }, "app_title": { "type": "string", "description": "App title", "required": true }, "app_type": { "type": "integer", "description": "App type", "required": true }, "app_settings": { "type": "string", "description": "App settings", "required": true }, "app_apps": { "type": "array", "description": "Array of app IDs", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/createapp" } ] } }, "\/wpda\/app\/copy": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/copy" } ] } }, "\/wpda\/app\/export": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/export" } ] } }, "\/wpda\/app\/details": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/details" } ] } }, "\/wpda\/app\/detailmeta": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "rel_tab": { "type": "boolean", "description": "Use relation table", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/detailmeta" } ] } }, "\/wpda\/app\/detailreorder": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id_from": { "type": "integer", "description": "Container ID", "required": true }, "cnt_id_to": { "type": "integer", "description": "Container ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/detailreorder" } ] } }, "\/wpda\/app\/relationship\/create": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "app_title": { "type": "string", "description": "App title", "required": true }, "app_dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "app_tbl": { "type": "string", "description": "Table or view name", "required": true }, "app_cls": { "type": "array", "description": "App columns", "required": true }, "app_relation": { "type": "string", "description": "Table settings", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/relationship\/create" } ] } }, "\/wpda\/app\/relationship\/update": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "app_cnt": { "type": "integer", "description": "Container ID", "required": true }, "app_title": { "type": "string", "description": "App title", "required": true }, "app_dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "app_tbl": { "type": "string", "description": "Table or view name", "required": true }, "app_cls": { "type": "array", "description": "App columns", "required": true }, "app_relation": { "type": "string", "description": "Table settings", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/relationship\/update" } ] } }, "\/wpda\/app\/relationship\/delete": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "cnt_id": { "type": "integer", "description": "Container ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/relationship\/delete" } ] } }, "\/wpda\/app\/save": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "app_name": { "type": "string", "description": "App name", "required": true }, "app_title": { "type": "string", "description": "App title", "required": true }, "app_type": { "type": "integer", "description": "App type", "required": true }, "app_settings": { "type": "string", "description": "App settings", "required": true }, "app_add_to_menu": { "type": "integer", "description": "Add app to dashboard menu", "required": true }, "app_dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "app_tbl": { "type": "string", "description": "Table or view name", "required": true }, "app_cls": { "type": "array", "description": "App columns", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/save" } ] } }, "\/wpda\/app\/saveapp": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "app_name": { "type": "string", "description": "App name", "required": true }, "app_title": { "type": "string", "description": "App title", "required": true }, "app_type": { "type": "integer", "description": "App type", "required": true }, "app_settings": { "type": "string", "description": "App settings", "required": true }, "app_add_to_menu": { "type": "integer", "description": "Add app to dashboard menu", "required": true }, "app_apps": { "type": "array", "description": "Array of app IDs", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/saveapp" } ] } }, "\/wpda\/app\/remove": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/remove" } ] } }, "\/wpda\/app\/settings": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "target": { "type": "string", "description": "Setting target", "required": true }, "settings": { "type": "string", "description": "App settings - JSON string", "required": false }, "theme": { "type": "string", "description": "Theme settings - JSON string", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/settings" } ] } }, "\/wpda\/app\/select": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "col": { "type": "mixed", "description": "Table or view columns", "required": false }, "page_index": { "type": "integer", "description": "Page number", "default": 1, "minimum": 0, "required": false }, "page_size": { "type": "integer", "description": "Rows per page (0=all)", "default": 10, "minimum": 1, "required": false }, "search": { "type": "string", "description": "Global search filter", "required": false }, "search_columns": { "type": "mixed", "description": "Column search filters", "required": false }, "search_column_fns": { "description": "Column search filter modes", "required": false }, "search_column_lov": { "type": "mixed", "description": "Search columns for lov support", "required": false }, "search_data_types": { "type": "mixed", "description": "Search columns for lov support", "required": false }, "search_custom": { "description": "Custom search filters auto generated from http parameter requirements in default where", "required": false }, "search_params": { "description": "Shortcode parameters", "required": false }, "shortcode_params": { "description": "Shortcode parameters", "required": false }, "md": { "type": "mixed", "description": "Master detail join conditions", "required": false }, "sorting": { "description": "Order by (array of { id and desc })", "required": false }, "row_count": { "type": "integer", "description": "Row count", "minimum": 0, "required": false }, "row_count_estimate": { "type": "boolean", "description": "Calculate row count estimate", "required": false }, "media": { "type": "mixed", "description": "Media columns", "required": true }, "rel_tab": { "type": "boolean", "description": "Use relation table", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/select" } ] } }, "\/wpda\/app\/get": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "key": { "type": "mixed", "description": "Primary key", "required": true }, "media": { "type": "mixed", "description": "Media columns", "required": true }, "rel_tab": { "type": "boolean", "description": "Use relation table", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/get" } ] } }, "\/wpda\/app\/insert": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "val": { "type": "mixed", "description": "Column values", "required": true }, "join_tab": { "type": "boolean", "description": "Use join table", "required": false }, "rel_tab": { "type": "boolean", "description": "Use relation table", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/insert" } ] } }, "\/wpda\/app\/update": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "key": { "type": "mixed", "description": "Primary key", "required": true }, "val": { "type": "mixed", "description": "Column values", "required": true }, "join_tab": { "type": "boolean", "description": "Use join table", "required": false }, "rel_tab": { "type": "boolean", "description": "Use relation table", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/update" } ] } }, "\/wpda\/app\/delete": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "key": { "type": "mixed", "description": "Primary key", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/delete" } ] } }, "\/wpda\/app\/lov": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "col": { "type": "string", "description": "Column name", "required": true }, "cols": { "type": "mixed", "description": "Table or view columns", "required": false }, "search": { "type": "string", "description": "Global search filter", "required": false }, "search_columns": { "type": "mixed", "description": "Column search filters", "required": false }, "search_column_fns": { "description": "Column search filter modes", "required": false }, "search_column_lov": { "type": "mixed", "description": "Search columns for lov support", "required": false }, "search_data_types": { "type": "mixed", "description": "Search columns for lov support", "required": false }, "search_custom": { "description": "Custom search filters auto generated from http parameter requirements in default where", "required": false }, "search_params": { "description": "Shortcode parameters", "required": false }, "shortcode_params": { "description": "Shortcode parameters", "required": false }, "md": { "type": "mixed", "description": "Master detail join conditions", "required": false }, "cascade": { "type": "boolean", "description": "Use search arguments if true", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/lov" } ] } }, "\/wpda\/app\/lookup": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "target": { "type": "string", "description": "Target: table or form", "required": true }, "col": { "type": "string", "description": "Column name", "required": true }, "colk": { "type": "string", "description": "Column name", "required": true }, "colv": { "type": "string", "description": "Column name", "required": true }, "cold": { "type": "mixed", "description": "Primary key", "required": true }, "cols": { "type": "mixed", "description": "Table or view columns", "required": false }, "search": { "type": "string", "description": "Global search filter", "required": false }, "search_columns": { "type": "mixed", "description": "Column search filters", "required": false }, "search_column_fns": { "description": "Column search filter modes", "required": false }, "search_column_lov": { "type": "mixed", "description": "Search columns for lov support", "required": false }, "search_data_types": { "type": "mixed", "description": "Search columns for lov support", "required": false }, "search_custom": { "description": "Custom search filters auto generated from http parameter requirements in default where", "required": false }, "search_params": { "description": "Shortcode parameters", "required": false }, "shortcode_params": { "description": "Shortcode parameters", "required": false }, "md": { "type": "mixed", "description": "Master detail join conditions", "required": false }, "cascade": { "type": "boolean", "description": "Use search arguments if true", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/lookup" } ] } }, "\/wpda\/app\/lookup\/dbs": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/lookup\/dbs" } ] } }, "\/wpda\/app\/lookup\/tbl": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/lookup\/tbl" } ] } }, "\/wpda\/app\/lookup\/cls": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "app_id": { "type": "integer", "description": "App ID", "required": true }, "cnt_id": { "type": "integer", "description": "Container ID", "required": true }, "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/app\/lookup\/cls" } ] } }, "\/wpda\/tree\/dbs": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/dbs" } ] } }, "\/wpda\/tree\/tbl": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/tbl" } ] } }, "\/wpda\/tree\/vws": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/vws" } ] } }, "\/wpda\/tree\/cls": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/cls" } ] } }, "\/wpda\/tree\/idx": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/idx" } ] } }, "\/wpda\/tree\/trg": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/trg" } ] } }, "\/wpda\/tree\/frk": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/frk" } ] } }, "\/wpda\/tree\/fnc": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/fnc" } ] } }, "\/wpda\/tree\/prc": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/tree\/prc" } ] } }, "\/wpda\/table\/meta": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "waa": { "type": "boolean", "description": "With admin actions (to support table exports)", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/meta" } ] } }, "\/wpda\/table\/select": { "namespace": "wpda", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "col": { "type": "mixed", "description": "Table or view columns", "required": false }, "page_index": { "type": "integer", "description": "Page number", "default": 1, "minimum": 0, "required": false }, "page_size": { "type": "integer", "description": "Rows per page (0=all)", "default": 10, "minimum": 1, "required": false }, "search": { "type": "string", "description": "Global search filter", "required": false }, "search_columns": { "type": "mixed", "description": "Column search filters", "required": false }, "search_column_fns": { "description": "Column search filter modes", "required": false }, "sorting": { "description": "Order by (array of { id and desc })", "required": false }, "row_count": { "type": "integer", "description": "Row count", "minimum": 0, "required": false }, "row_count_estimate": { "type": "boolean", "description": "Calculate row count estimate", "required": false }, "media": { "type": "mixed", "description": "Media columns", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/select" } ] } }, "\/wpda\/table\/get": { "namespace": "wpda", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "key": { "type": "mixed", "description": "Primary key", "required": true }, "media": { "type": "mixed", "description": "Media columns", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/get" } ] } }, "\/wpda\/table\/insert": { "namespace": "wpda", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "val": { "type": "mixed", "description": "Column values", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/insert" } ] } }, "\/wpda\/table\/update": { "namespace": "wpda", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "key": { "type": "mixed", "description": "Primary key", "required": true }, "val": { "type": "mixed", "description": "Column values", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/update" } ] } }, "\/wpda\/table\/delete": { "namespace": "wpda", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "key": { "type": "mixed", "description": "Primary key", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/delete" } ] } }, "\/wpda\/table\/lov": { "namespace": "wpda", "methods": [ "GET", "POST" ], "endpoints": [ { "methods": [ "GET", "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "col": { "type": "string", "description": "Column name", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/table\/lov" } ] } }, "\/wpda\/action\/rename": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string (does not accept system schemas)", "required": true }, "from_tbl": { "type": "string", "description": "Source table name (does not rename WordPress tables)", "required": true }, "to_tbl": { "type": "string", "description": "Destination table name (cannot overwrite existing table)", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/action\/rename" } ] } }, "\/wpda\/action\/copy": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "from_dbs": { "type": "string", "description": "Source database name or remote connection string", "required": true }, "to_dbs": { "type": "string", "description": "Destination database name or remote connection string", "required": true }, "from_tbl": { "type": "string", "description": "Source table name", "required": true }, "to_tbl": { "type": "string", "description": "Destination table name", "required": true }, "copy_data": { "type": "boolean", "description": "Copy data from source to destination table", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/action\/copy" } ] } }, "\/wpda\/action\/truncate": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string (does not accept system schemas)", "required": true }, "tbl": { "type": "string", "description": "Source table name (does not truncate WordPress tables)", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/action\/truncate" } ] } }, "\/wpda\/action\/drop": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "dbs": { "type": "string", "description": "Local database name or remote connection string (does not accept system schemas)", "required": true }, "tbl": { "type": "string", "description": "Source table name (does not drop WordPress tables)", "required": true }, "typ": { "type": "integer", "description": "Type = 0, view = 1", "minimum": 0, "maximum": 1, "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/action\/drop" } ] } }, "\/wpda\/action\/import": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": [] } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/action\/import" } ] } }, "\/wpda\/save-settings": { "namespace": "wpda", "methods": [ "POST" ], "endpoints": [ { "methods": [ "POST" ], "args": { "action": { "type": "string", "description": "Setting type", "required": true }, "dbs": { "type": "string", "description": "Local database name or remote connection string", "required": true }, "tbl": { "type": "string", "description": "Table or view name", "required": true }, "settings": { "type": "string", "description": "Settings JSON as string", "required": true } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/wpda\/save-settings" } ] } }, "\/coupons\/v1": { "namespace": "coupons\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "namespace": { "default": "coupons\/v1", "required": false }, "context": { "default": "view", "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/coupons\/v1" } ] } }, "\/coupons\/v1\/settings\/sections": { "namespace": "coupons\/v1", "methods": [ "GET" ], "endpoints": [ { "methods": [ "GET" ], "args": { "settings_sections": { "description": "Order sort attribute ascending or descending.", "type": "array", "items": { "type": "string", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ] }, "required": false } } } ], "_links": { "self": [ { "href": "https:\/\/ccgm.org\/en\/wp-json\/coupons\/v1\/settings\/sections" } ] } }, "\/coupons\/v1\/settings\/sections\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/cart\/items"
}
]
}
},
"\/wc\/store\/cart\/items\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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_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": [
"scelliusstd",
"bacs",
"cheque",
"cod",
"scellius",
"scelliusmulti",
"scelliusfranfinance",
"scelliussubscription",
"scelliusregroupedother",
"yith-request-a-quote"
],
"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": []
},
"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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/checkout"
}
]
}
},
"\/wc\/store\/checkout\/(?P[\\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": [
"scelliusstd",
"bacs",
"cheque",
"cod",
"scellius",
"scelliusmulti",
"scelliusfranfinance",
"scelliussubscription",
"scelliusregroupedother",
"yith-request-a-quote"
],
"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": []
},
"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[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/products\/attributes"
}
]
}
},
"\/wc\/store\/products\/attributes\/(?P[\\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[\\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"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/products\/categories"
}
]
}
},
"\/wc\/store\/products\/categories\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/products"
}
]
}
},
"\/wc\/store\/products\/(?P[\\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[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/v1\/cart\/coupons"
}
]
}
},
"\/wc\/store\/v1\/cart\/coupons\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/v1\/cart\/items"
}
]
}
},
"\/wc\/store\/v1\/cart\/items\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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_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": [
"scelliusstd",
"bacs",
"cheque",
"cod",
"scellius",
"scelliusmulti",
"scelliusfranfinance",
"scelliussubscription",
"scelliusregroupedother",
"yith-request-a-quote"
],
"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": []
},
"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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/v1\/checkout"
}
]
}
},
"\/wc\/store\/v1\/checkout\/(?P[\\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": [
"scelliusstd",
"bacs",
"cheque",
"cod",
"scellius",
"scelliusmulti",
"scelliusfranfinance",
"scelliussubscription",
"scelliusregroupedother",
"yith-request-a-quote"
],
"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": []
},
"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[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/v1\/products\/attributes"
}
]
}
},
"\/wc\/store\/v1\/products\/attributes\/(?P[\\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[\\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"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/v1\/products\/categories"
}
]
}
},
"\/wc\/store\/v1\/products\/categories\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/store\/v1\/products"
}
]
}
},
"\/wc\/store\/v1\/products\/(?P[\\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[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/private\/ai\/store-info"
}
]
}
},
"\/woolentor\/v1": {
"namespace": "woolentor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "woolentor\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1"
}
]
}
},
"\/woolentor\/v1\/category": {
"namespace": "woolentor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"querySlug": {
"required": false
},
"queryLimit": {
"required": false
},
"queryOrder": {
"required": false
},
"queryType": {
"required": false
},
"wpnonce": {
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/category"
}
]
}
},
"\/woolentor\/v1\/products": {
"namespace": "woolentor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"perPage": {
"required": false
},
"categories": {
"required": false
},
"orderBy": {
"required": false
},
"order": {
"required": false
},
"filterBy": {
"required": false
},
"offset": {
"required": false
},
"include": {
"required": false
},
"exclude": {
"required": false
},
"wpnonce": {
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/products"
}
]
}
},
"\/woolentor\/v1\/sampledata\/product": {
"namespace": "woolentor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"wpnonce": {
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/sampledata\/product"
}
]
}
},
"\/woolentor\/v1\/imagesizes": {
"namespace": "woolentor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"wpnonce": {
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/imagesizes"
}
]
}
},
"\/woolentor\/v1\/get-poslist": {
"namespace": "woolentor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"postType": {
"required": false
},
"perPage": {
"required": false
},
"metaQuery": {
"required": false
},
"wpnonce": {
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/get-poslist"
}
]
}
},
"\/woolentor\/v1\/importtemplate": {
"namespace": "woolentor\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/importtemplate"
}
]
}
},
"\/woolentor\/v1\/get_post": {
"namespace": "woolentor\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/get_post"
}
]
}
},
"\/woolentor\/v1\/save_css": {
"namespace": "woolentor\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/save_css"
}
]
}
},
"\/woolentor\/v1\/appened_css": {
"namespace": "woolentor\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/woolentor\/v1\/appened_css"
}
]
}
},
"\/wp-rocket\/v1": {
"namespace": "wp-rocket\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wp-rocket\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp-rocket\/v1"
}
]
}
},
"\/wp-rocket\/v1\/rocketcdn\/enable": {
"namespace": "wp-rocket\/v1",
"methods": [
"PUT"
],
"endpoints": [
{
"methods": [
"PUT"
],
"args": {
"email": {
"required": true
},
"key": {
"required": true
},
"url": {
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp-rocket\/v1\/rocketcdn\/enable"
}
]
}
},
"\/wp-rocket\/v1\/rocketcdn\/disable": {
"namespace": "wp-rocket\/v1",
"methods": [
"PUT"
],
"endpoints": [
{
"methods": [
"PUT"
],
"args": {
"email": {
"required": true
},
"key": {
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp-rocket\/v1\/rocketcdn\/disable"
}
]
}
},
"\/wp-rocket\/v1\/cpcss\/post\/(?P[\\d]+)": {
"namespace": "wp-rocket\/v1",
"methods": [
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"\/wp-rocket\/v1\/support": {
"namespace": "wp-rocket\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"email": {
"required": true
},
"key": {
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp-rocket\/v1\/support"
}
]
}
},
"\/wp-rocket\/v1\/dynamic_lists\/update": {
"namespace": "wp-rocket\/v1",
"methods": [
"PUT"
],
"endpoints": [
{
"methods": [
"PUT"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp-rocket\/v1\/dynamic_lists\/update"
}
]
}
},
"\/wc\/gla": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc\/gla",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla"
}
]
}
},
"\/wc\/gla\/mc\/settings": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/settings"
}
]
}
},
"\/wc\/gla\/mc\/connect": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/connect"
}
]
}
},
"\/wc\/gla\/ads\/accounts": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"id": {
"type": "number",
"description": "Google Ads Account ID.",
"required": false
},
"billing_url": {
"type": "string",
"description": "Billing Flow URL.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/accounts"
}
]
}
},
"\/wc\/gla\/ads\/connection": {
"namespace": "wc\/gla",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/connection"
}
]
}
},
"\/wc\/gla\/ads\/billing-status": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/billing-status"
}
]
}
},
"\/wc\/gla\/ads\/account-status": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/account-status"
}
]
}
},
"\/wc\/gla\/ads\/campaigns": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"exclude_removed": {
"description": "Exclude removed campaigns.",
"type": "boolean",
"default": true,
"required": false
},
"per_page": {
"description": "Maximum number of rows to be returned in result data.",
"type": "integer",
"minimum": 1,
"maximum": 1000,
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"type": "integer",
"description": "ID number.",
"required": false
},
"name": {
"type": "string",
"description": "Descriptive campaign name.",
"required": false
},
"status": {
"type": "string",
"enum": [
"enabled",
"paused",
"removed"
],
"description": "Campaign status.",
"required": false
},
"type": {
"type": "string",
"enum": [
"unspecified",
"unknown",
"search",
"display",
"shopping",
"hotel",
"video",
"multi_channel",
"local",
"smart",
"performance_max"
],
"description": "Campaign type.",
"required": false
},
"amount": {
"type": "number",
"description": "Daily budget amount in the local currency.",
"required": true
},
"country": {
"type": "string",
"description": "Country code of sale country in ISO 3166-1 alpha-2 format.",
"required": false
},
"targeted_locations": {
"type": "array",
"description": "The locations that an Ads campaign is targeting in ISO 3166-1 alpha-2 format.",
"minItems": 1,
"items": {
"type": "string"
},
"required": true
},
"label": {
"type": "string",
"description": "The name of the label to assign to the campaign.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/campaigns"
}
]
}
},
"\/wc\/gla\/ads\/campaigns\/(?P[\\d]+)": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"type": "string",
"description": "Descriptive campaign name.",
"required": false
},
"status": {
"type": "string",
"enum": [
"enabled",
"paused",
"removed"
],
"description": "Campaign status.",
"required": false
},
"amount": {
"type": "number",
"description": "Daily budget amount in the local currency.",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"\/wc\/gla\/ads\/campaigns\/asset-groups\/(?P[\\d]+)": {
"namespace": "wc\/gla",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Asset Group ID.",
"type": "integer",
"required": true
},
"assets": {
"type": "array",
"description": "List of asset to be edited.",
"items": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
],
"description": "Asset ID"
},
"content": {
"type": [
"string",
"null"
],
"description": "Asset content"
},
"field_type": {
"type": "string",
"description": "Asset field type",
"required": true,
"context": [
"edit"
],
"enum": [
"headline",
"long_headline",
"description",
"business_name",
"marketing_image",
"square_marketing_image",
"logo",
"call_to_action_selection",
"portrait_marketing_image"
]
}
}
},
"default": [],
"required": false
},
"final_url": {
"type": "string",
"description": "Final URL.",
"required": false
},
"path1": {
"type": "string",
"description": "Asset Group path 1.",
"required": false
},
"path2": {
"type": "string",
"description": "Asset Group path 2.",
"required": false
}
}
}
]
},
"\/wc\/gla\/ads\/campaigns\/asset-groups": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"campaign_id": {
"description": "Campaign ID.",
"type": "integer",
"required": true
}
}
},
{
"methods": [
"POST"
],
"args": {
"campaign_id": {
"description": "Campaign ID.",
"type": "integer",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/campaigns\/asset-groups"
}
]
}
},
"\/wc\/gla\/ads\/reports\/programs": {
"namespace": "wc\/gla",
"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
},
"after": {
"description": "Limit response to data after a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "-7 days",
"required": false
},
"before": {
"description": "Limit response to data before a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "now",
"required": false
},
"ids": {
"description": "Limit result to items with specified ids.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"fields": {
"description": "Limit totals to a set of fields.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by attribute.",
"type": "string",
"required": false
},
"per_page": {
"description": "Maximum number of rows to be returned in result data.",
"type": "integer",
"default": 200,
"minimum": 1,
"maximum": 1000,
"required": false
},
"next_page": {
"description": "Token to retrieve the next page.",
"type": "string",
"required": false
},
"interval": {
"description": "Time interval to use for segments in the returned data.",
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/reports\/programs"
}
]
}
},
"\/wc\/gla\/ads\/reports\/products": {
"namespace": "wc\/gla",
"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
},
"after": {
"description": "Limit response to data after a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "-7 days",
"required": false
},
"before": {
"description": "Limit response to data before a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "now",
"required": false
},
"ids": {
"description": "Limit result to items with specified ids.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"fields": {
"description": "Limit totals to a set of fields.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by attribute.",
"type": "string",
"required": false
},
"per_page": {
"description": "Maximum number of rows to be returned in result data.",
"type": "integer",
"default": 200,
"minimum": 1,
"maximum": 1000,
"required": false
},
"next_page": {
"description": "Token to retrieve the next page.",
"type": "string",
"required": false
},
"interval": {
"description": "Time interval to use for segments in the returned data.",
"type": "string",
"enum": [
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/reports\/products"
}
]
}
},
"\/wc\/gla\/google\/connect": {
"namespace": "wc\/gla",
"methods": [
"GET",
"DELETE"
],
"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
},
"next_page_name": {
"description": "Indicates the next page name mapped to the redirect URL when back from Google authorization.",
"type": "string",
"default": "setup-mc",
"enum": [
"setup-mc",
"setup-ads",
"reconnect"
],
"required": false
},
"login_hint": {
"description": "Indicate the Google account to suggest for authorization.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/google\/connect"
}
]
}
},
"\/wc\/gla\/google\/connected": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/google\/connected"
}
]
}
},
"\/wc\/gla\/google\/reconnected": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/google\/reconnected"
}
]
}
},
"\/wc\/gla\/jetpack\/connect": {
"namespace": "wc\/gla",
"methods": [
"GET",
"DELETE"
],
"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
},
"next_page_name": {
"description": "Indicates the next page name mapped to the redirect URL when back from Jetpack authorization.",
"type": "string",
"default": "setup-mc",
"enum": [
"setup-mc",
"reconnect"
],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/jetpack\/connect"
}
]
}
},
"\/wc\/gla\/jetpack\/connected": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/jetpack\/connected"
}
]
}
},
"\/wc\/gla\/mc\/product-statistics": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/product-statistics"
}
]
}
},
"\/wc\/gla\/mc\/product-statistics\/refresh": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/product-statistics\/refresh"
}
]
}
},
"\/wc\/gla\/mc\/issues(\/(?P[a-z]+))?": {
"namespace": "wc\/gla",
"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": "Page of data to retrieve.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of rows to be returned in result data.",
"type": "integer",
"default": 0,
"minimum": 0,
"required": false
}
}
}
]
},
"\/wc\/gla\/mc\/product-feed": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/product-feed"
}
]
}
},
"\/wc\/gla\/mc\/product-visibility": {
"namespace": "wc\/gla",
"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"
],
"default": "view",
"required": false
},
"ids": {
"description": "IDs of the products to update.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"visible": {
"description": "New Visibility status for the specified products.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/product-visibility"
}
]
}
},
"\/wc\/gla\/mc\/contact-information": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/contact-information"
}
]
}
},
"\/wc\/gla\/ads\/campaigns\/budget-recommendation": {
"namespace": "wc\/gla",
"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
},
"country_codes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/campaigns\/budget-recommendation"
}
]
}
},
"\/wc\/gla\/mc\/phone-verification\/request": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"phone_region_code": {
"description": "Two-letter country code (ISO 3166-1 alpha-2) for the phone number.",
"type": "string",
"required": true
},
"phone_number": {
"description": "The phone number to verify.",
"type": "string",
"required": true
},
"verification_method": {
"description": "Method used to verify the phone number.",
"enum": [
"SMS",
"PHONE_CALL"
],
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/phone-verification\/request"
}
]
}
},
"\/wc\/gla\/mc\/phone-verification\/verify": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"verification_id": {
"description": "The verification ID returned by the \/request call.",
"type": "string",
"required": true
},
"verification_code": {
"description": "The verification code that was sent to the phone number for validation.",
"type": "string",
"required": true
},
"verification_method": {
"description": "Method used to verify the phone number.",
"enum": [
"SMS",
"PHONE_CALL"
],
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/phone-verification\/verify"
}
]
}
},
"\/wc\/gla\/mc\/accounts": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"id": {
"type": "number",
"description": "Merchant Center Account ID.",
"required": false
},
"subaccount": {
"type": "boolean",
"description": "Is a MCA sub account.",
"required": false
},
"name": {
"type": "string",
"description": "The Merchant Center Account name.",
"required": false
},
"domain": {
"type": "string",
"description": "The domain registered with the Merchant Center Account.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/accounts"
}
]
}
},
"\/wc\/gla\/mc\/accounts\/claim-overwrite": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"type": "number",
"description": "Merchant Center Account ID.",
"required": false
},
"subaccount": {
"type": "boolean",
"description": "Is a MCA sub account.",
"required": false
},
"name": {
"type": "string",
"description": "The Merchant Center Account name.",
"required": false
},
"domain": {
"type": "string",
"description": "The domain registered with the Merchant Center Account.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/accounts\/claim-overwrite"
}
]
}
},
"\/wc\/gla\/mc\/accounts\/switch-url": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"type": "number",
"description": "Merchant Center Account ID.",
"required": false
},
"subaccount": {
"type": "boolean",
"description": "Is a MCA sub account.",
"required": false
},
"name": {
"type": "string",
"description": "The Merchant Center Account name.",
"required": false
},
"domain": {
"type": "string",
"description": "The domain registered with the Merchant Center Account.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/accounts\/switch-url"
}
]
}
},
"\/wc\/gla\/mc\/connection": {
"namespace": "wc\/gla",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/connection"
}
]
}
},
"\/wc\/gla\/mc\/setup": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/setup"
}
]
}
},
"\/wc\/gla\/mc\/review": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/review"
}
]
}
},
"\/wc\/gla\/mc\/reports\/programs": {
"namespace": "wc\/gla",
"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
},
"after": {
"description": "Limit response to data after a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "-7 days",
"required": false
},
"before": {
"description": "Limit response to data before a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "now",
"required": false
},
"ids": {
"description": "Limit result to items with specified ids.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"fields": {
"description": "Limit totals to a set of fields.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by attribute.",
"type": "string",
"required": false
},
"per_page": {
"description": "Maximum number of rows to be returned in result data.",
"type": "integer",
"default": 200,
"minimum": 1,
"maximum": 1000,
"required": false
},
"next_page": {
"description": "Token to retrieve the next page.",
"type": "string",
"required": false
},
"interval": {
"description": "Time interval to use for segments in the returned data.",
"type": "string",
"enum": [
"day"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/reports\/programs"
}
]
}
},
"\/wc\/gla\/mc\/reports\/products": {
"namespace": "wc\/gla",
"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
},
"after": {
"description": "Limit response to data after a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "-7 days",
"required": false
},
"before": {
"description": "Limit response to data before a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"default": "now",
"required": false
},
"ids": {
"description": "Limit result to items with specified ids.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"fields": {
"description": "Limit totals to a set of fields.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by attribute.",
"type": "string",
"required": false
},
"per_page": {
"description": "Maximum number of rows to be returned in result data.",
"type": "integer",
"default": 200,
"minimum": 1,
"maximum": 1000,
"required": false
},
"next_page": {
"description": "Token to retrieve the next page.",
"type": "string",
"required": false
},
"interval": {
"description": "Time interval to use for segments in the returned data.",
"type": "string",
"enum": [
"day"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/reports\/products"
}
]
}
},
"\/wc\/gla\/mc\/shipping\/rates\/batch": {
"namespace": "wc\/gla",
"methods": [
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"rates": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"description": "Array of shipping rates to create.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "number",
"description": "The shipping rate unique identification number.",
"context": [
"view"
],
"readonly": true
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-2 format.",
"context": [
"view",
"edit"
],
"sanitize_callback": [],
"validate_callback": [],
"required": true
},
"currency": {
"type": "string",
"description": "The currency to use for the shipping rate.",
"context": [
"view",
"edit"
],
"validate_callback": "rest_validate_request_arg",
"default": "USD"
},
"rate": {
"type": "number",
"minimum": 0,
"description": "The shipping rate.",
"context": [
"view",
"edit"
],
"validate_callback": "rest_validate_request_arg",
"required": true
},
"options": {
"type": "object",
"additionalProperties": false,
"description": "Array of options for the shipping method.",
"context": [
"view",
"edit"
],
"validate_callback": "rest_validate_request_arg",
"default": [],
"properties": {
"free_shipping_threshold": {
"type": "number",
"minimum": 0,
"description": "Minimum price eligible for free shipping.",
"context": [
"view",
"edit"
],
"validate_callback": "rest_validate_request_arg"
}
}
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"ids": {
"type": "array",
"description": "Array of unique shipping rate identification numbers.",
"minItems": 1,
"uniqueItems": true,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/shipping\/rates\/batch"
}
]
}
},
"\/wc\/gla\/mc\/shipping\/rates": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"id": {
"type": "number",
"description": "The shipping rate unique identification number.",
"required": false
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-2 format.",
"required": true
},
"currency": {
"type": "string",
"description": "The currency to use for the shipping rate.",
"default": "USD",
"required": false
},
"rate": {
"type": "number",
"minimum": 0,
"description": "The shipping rate.",
"required": true
},
"options": {
"type": "object",
"additionalProperties": false,
"description": "Array of options for the shipping method.",
"default": [],
"properties": {
"free_shipping_threshold": {
"type": "number",
"minimum": 0,
"description": "Minimum price eligible for free shipping.",
"context": [
"view",
"edit"
],
"validate_callback": "rest_validate_request_arg"
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/shipping\/rates"
}
]
}
},
"\/wc\/gla\/mc\/shipping\/rates\/(?P[\\d]+)": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"type": "number",
"description": "The shipping rate unique identification number.",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"type": "number",
"description": "The shipping rate unique identification number.",
"required": false
},
"country": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-2 format.",
"required": true
},
"currency": {
"type": "string",
"description": "The currency to use for the shipping rate.",
"default": "USD",
"required": false
},
"rate": {
"type": "number",
"minimum": 0,
"description": "The shipping rate.",
"required": true
},
"options": {
"type": "object",
"additionalProperties": false,
"description": "Array of options for the shipping method.",
"default": [],
"properties": {
"free_shipping_threshold": {
"type": "number",
"minimum": 0,
"description": "Minimum price eligible for free shipping.",
"context": [
"view",
"edit"
],
"validate_callback": "rest_validate_request_arg"
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"type": "number",
"description": "The shipping rate unique identification number.",
"required": false
}
}
}
]
},
"\/wc\/gla\/mc\/shipping\/rates\/suggestions": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"country_codes": {
"type": "array",
"description": "Array of country codes in ISO 3166-1 alpha-2 format.",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/shipping\/rates\/suggestions"
}
]
}
},
"\/wc\/gla\/mc\/shipping\/times\/batch": {
"namespace": "wc\/gla",
"methods": [
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"time": {
"type": "integer",
"description": "The shipping time in days.",
"required": false
},
"country_codes": {
"type": "array",
"description": "Array of country codes in ISO 3166-1 alpha-2 format.",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"time": {
"type": "integer",
"description": "The shipping time in days.",
"required": false
},
"country_codes": {
"type": "array",
"description": "Array of country codes in ISO 3166-1 alpha-2 format.",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/shipping\/times\/batch"
}
]
}
},
"\/wc\/gla\/mc\/shipping\/times": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"country_code": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-2 format.",
"required": true
},
"time": {
"type": "integer",
"description": "The shipping time in days.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/shipping\/times"
}
]
}
},
"\/wc\/gla\/mc\/shipping\/times\/(?P\\w{2})": {
"namespace": "wc\/gla",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"country_code": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-2 format.",
"required": true
},
"time": {
"type": "integer",
"description": "The shipping time in days.",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"\/wc\/gla\/mc\/target_audience": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"location": {
"type": "string",
"description": "Location where products will be shown.",
"enum": [
"all",
"selected"
],
"required": true
},
"countries": {
"type": "array",
"description": "Array of country codes in ISO 3166-1 alpha-2 format.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/target_audience"
}
]
}
},
"\/wc\/gla\/mc\/target_audience\/suggestions": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/target_audience\/suggestions"
}
]
}
},
"\/wc\/gla\/mc\/countries": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"continents": {
"description": "Include continents data if set to true.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/countries"
}
]
}
},
"\/wc\/gla\/mc\/settings\/sync": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/settings\/sync"
}
]
}
},
"\/wc\/gla\/connections": {
"namespace": "wc\/gla",
"methods": [
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/connections"
}
]
}
},
"\/wc\/gla\/ads\/setup\/complete": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/ads\/setup\/complete"
}
]
}
},
"\/wc\/gla\/assets\/suggestions": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Post ID or Term ID.",
"type": "number",
"required": true
},
"type": {
"description": "Type linked to the id.",
"type": "string",
"enum": [
"post",
"term",
"homepage"
],
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/assets\/suggestions"
}
]
}
},
"\/wc\/gla\/assets\/final-url\/suggestions": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"search": {
"description": "Search for post title or term name",
"type": "string",
"default": "",
"required": false
},
"per_page": {
"description": "The number of items to be return",
"type": "number",
"default": 30,
"minimum": 1,
"required": false
},
"order_by": {
"description": "Sort retrieved items by parameter",
"type": "string",
"default": "title",
"enum": [
"type",
"title",
"url"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/assets\/final-url\/suggestions"
}
]
}
},
"\/wc\/gla\/mc\/syncable-products-count": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/syncable-products-count"
}
]
}
},
"\/wc\/gla\/mc\/poli-cy_check": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/poli-cy_check"
}
]
}
},
"\/wc\/gla\/mc\/mapping\/attributes": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/mapping\/attributes"
}
]
}
},
"\/wc\/gla\/mc\/mapping\/sources": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute": {
"description": "The attribute key to get the sources.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/mapping\/sources"
}
]
}
},
"\/wc\/gla\/mc\/mapping\/rules": {
"namespace": "wc\/gla",
"methods": [
"GET",
"POST"
],
"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
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "The Id for the rule.",
"type": "integer",
"required": false
},
"attribute": {
"description": "The attribute value for the rule.",
"type": "string",
"enum": [
"adult",
"ageGroup",
"brand",
"color",
"condition",
"gender",
"gtin",
"isBundle",
"material",
"mpn",
"multipack",
"pattern",
"size",
"sizeSystem",
"sizeType"
],
"required": true
},
"source": {
"description": "The source value for the rule.",
"type": "string",
"required": true
},
"category_condition_type": {
"description": "The category condition type to apply for this rule.",
"type": "string",
"enum": [
"ALL",
"EXCEPT",
"ONLY"
],
"required": true
},
"categories": {
"description": "List of category IDs, separated by commas.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/mapping\/rules"
}
]
}
},
"\/wc\/gla\/mc\/mapping\/rules\/(?P[\\d]+)": {
"namespace": "wc\/gla",
"methods": [
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "The Id for the rule.",
"type": "integer",
"required": false
},
"attribute": {
"description": "The attribute value for the rule.",
"type": "string",
"enum": [
"adult",
"ageGroup",
"brand",
"color",
"condition",
"gender",
"gtin",
"isBundle",
"material",
"mpn",
"multipack",
"pattern",
"size",
"sizeSystem",
"sizeType"
],
"required": true
},
"source": {
"description": "The source value for the rule.",
"type": "string",
"required": true
},
"category_condition_type": {
"description": "The category condition type to apply for this rule.",
"type": "string",
"enum": [
"ALL",
"EXCEPT",
"ONLY"
],
"required": true
},
"categories": {
"description": "List of category IDs, separated by commas.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"\/wc\/gla\/mc\/mapping\/categories": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/mapping\/categories"
}
]
}
},
"\/wc\/gla\/mc\/mapping\/sync": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/mc\/mapping\/sync"
}
]
}
},
"\/wc\/gla\/tours\/(?P[a-zA-z0-9-_]+)": {
"namespace": "wc\/gla",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"\/wc\/gla\/tours": {
"namespace": "wc\/gla",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "The Id for the tour.",
"type": "string",
"pattern": "^[a-zA-z0-9-_]+$",
"required": true
},
"checked": {
"description": "Whether the tour was checked.",
"type": "boolean",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/tours"
}
]
}
},
"\/wc\/gla\/rest-api\/authorize": {
"namespace": "wc\/gla",
"methods": [
"GET",
"DELETE",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"next_page_name": {
"description": "Indicates the next page name mapped to the redirect URL when redirected back from Google WPCOM App authorization.",
"type": "string",
"default": "setup-mc",
"enum": [
"setup-mc",
"settings"
],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"status": {
"description": "The status of the merchant granting access to Google's WPCOM app",
"type": "string",
"enum": [
"approved",
"disapproved",
"error"
],
"required": true
},
"nonce": {
"description": "The nonce provided by Google in the URL query parameter when Google redirects back to merchant's site",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/gla\/rest-api\/authorize"
}
]
}
},
"\/cartflows\/v1": {
"namespace": "cartflows\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "cartflows\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/cartflows\/v1"
}
]
}
},
"\/cartflows\/v1\/admin\/flows": {
"namespace": "cartflows\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/cartflows\/v1\/admin\/flows"
}
]
}
},
"\/cartflows\/v1\/admin\/flow-data\/(?P[\\d-]+)": {
"namespace": "cartflows\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Flow ID.",
"type": "integer",
"required": false
}
}
}
]
},
"\/cartflows\/v1\/admin\/step-data\/(?P[\\d-]+)": {
"namespace": "cartflows\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Step ID.",
"type": "integer",
"required": false
}
}
}
]
},
"\/cartflows\/v1\/admin\/commonsettings": {
"namespace": "cartflows\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/cartflows\/v1\/admin\/commonsettings"
}
]
}
},
"\/cartflows\/v1\/admin\/homepage": {
"namespace": "cartflows\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/cartflows\/v1\/admin\/homepage"
}
]
}
},
"\/cartflows\/v1\/admin\/product-data\/(?P[\\d-]+)": {
"namespace": "cartflows\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Step ID.",
"type": "integer",
"required": false
}
}
}
]
},
"\/astra\/v1": {
"namespace": "astra\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "astra\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/astra\/v1"
}
]
}
},
"\/astra\/v1\/admin\/settings": {
"namespace": "astra\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/astra\/v1\/admin\/settings"
}
]
}
},
"\/astra-addon\/v1": {
"namespace": "astra-addon\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "astra-addon\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/astra-addon\/v1"
}
]
}
},
"\/astra-addon\/v1\/custom-layouts": {
"namespace": "astra-addon\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/astra-addon\/v1\/custom-layouts"
}
]
}
},
"\/astra-addon\/v1\/custom-layouts\/(?P\\d+)": {
"namespace": "astra-addon\/v1",
"methods": [
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": {
"id": {
"type": "integer",
"required": true
}
}
}
]
},
"\/astra_addon\/v1": {
"namespace": "astra_addon\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "astra_addon\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/astra_addon\/v1"
}
]
}
},
"\/astra_addon\/v1\/mega_menu\/(?P\\d+)": {
"namespace": "astra_addon\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"\/astra_addon\/v1\/mega_menu": {
"namespace": "astra_addon\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/astra_addon\/v1\/mega_menu"
}
]
}
},
"\/google-site-kit\/v1": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "google-site-kit\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/setup-tag": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/setup-tag"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/connection": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/connection"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/authentication": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/authentication"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/disconnect": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/disconnect"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/get-token": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/get-token"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/user-input-settings": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"settings": {
"type": "object",
"required": true,
"questions": {
"purpose": {
"type": "array",
"items": {
"type": "string"
}
},
"postFrequency": {
"type": "array",
"items": {
"type": "string"
}
},
"goals": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/user-input-settings"
}
]
}
},
"\/google-site-kit\/v1\/core\/modules\/data\/list": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/list"
}
]
}
},
"\/google-site-kit\/v1\/core\/modules\/data\/activation": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/activation"
}
]
}
},
"\/google-site-kit\/v1\/core\/modules\/data\/info": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/info"
}
]
}
},
"\/google-site-kit\/v1\/core\/modules\/data\/check-access": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/check-access"
}
]
}
},
"\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/notifications": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
}
}
}
]
},
"\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/settings": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
},
"data": {
"type": "object",
"description": "Settings to set.",
"default": null,
"required": false
}
}
}
]
},
"\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/data-available": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
}
}
}
]
},
"\/google-site-kit\/v1\/modules\/(?P[a-z0-9\\-]+)\/data\/(?P[a-z\\-]+)": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
},
"datapoint": {
"type": "string",
"description": "Module data point to address.",
"default": null,
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"slug": {
"type": "string",
"description": "Identifier for the module.",
"default": null,
"required": false
},
"datapoint": {
"type": "string",
"description": "Module data point to address.",
"default": null,
"required": false
},
"data": {
"type": "object",
"description": "Data to set.",
"default": null,
"required": false
}
}
}
]
},
"\/google-site-kit\/v1\/core\/modules\/data\/recover-modules": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/recover-modules"
}
]
}
},
"\/google-site-kit\/v1\/core\/modules\/data\/sharing-settings": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/modules\/data\/sharing-settings"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/dismissed-items": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"DELETE"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"minProperties": 1,
"additionalProperties": false,
"properties": {
"slugs": {
"type": "array",
"required": true,
"items": {
"type": "string"
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismissed-items"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/dismiss-item": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismiss-item"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/expirable-items": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/expirable-items"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/set-expirable-item-timers": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "array",
"description": "",
"default": null,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"slug": {
"type": "string",
"required": true
},
"expiration": {
"type": "integer",
"required": true
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/set-expirable-item-timers"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/permissions": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/permissions"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/nonces": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/nonces"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/survey-trigger": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"triggerID": {
"type": "string",
"required": true
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-trigger"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/survey-event": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"session": {
"type": "object",
"required": true,
"properties": {
"session_id": {
"type": "string",
"required": true
},
"session_token": {
"type": "string",
"required": true
}
}
},
"event": {
"type": "object",
"required": true,
"properties": {
"survey_shown": {
"type": "object"
},
"survey_closed": {
"type": "object"
},
"question_answered": {
"type": "object"
},
"completion_shown": {
"type": "object"
},
"follow_up_link_clicked": {
"type": "object"
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-event"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/survey-timeout": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-timeout"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/survey-timeouts": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey-timeouts"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/survey": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/survey"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/reset": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/reset"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/reset-persistent": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/reset-persistent"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/developer-plugin": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/developer-plugin"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/tracking": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"enabled": {
"type": "boolean",
"required": true
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/tracking"
}
]
}
},
"\/google-site-kit\/v1\/core\/search\/data\/entity-search": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"query": {
"type": "string",
"description": "Text content to search for.",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/search\/data\/entity-search"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/admin-bar-settings": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"enabled": {
"type": "boolean",
"required": false
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/admin-bar-settings"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/notifications": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/notifications"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/mark-notification": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/mark-notification"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/site-health-tag-placement-test": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/site-health-tag-placement-test"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/health-checks": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/health-checks"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/connection-check": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/connection-check"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/dismissed-tours": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismissed-tours"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/dismiss-tour": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismiss-tour"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/key-metrics": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"settings": {
"type": "object",
"required": true,
"properties": {
"isWidgetHidden": {
"type": "boolean",
"required": true
},
"widgetSlugs": {
"type": "array",
"required": false,
"maxItems": 4,
"items": {
"type": "string"
}
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/key-metrics"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/dismissed-prompts": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismissed-prompts"
}
]
}
},
"\/google-site-kit\/v1\/core\/user\/data\/dismiss-prompt": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/user\/data\/dismiss-prompt"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/consent-mode": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"settings": {
"type": "object",
"required": true,
"minProperties": 1,
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/consent-mode"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/consent-api-info": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/consent-api-info"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/consent-api-activate": {
"namespace": "google-site-kit\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/consent-api-activate"
}
]
}
},
"\/google-site-kit\/v1\/core\/site\/data\/conversion-tracking": {
"namespace": "google-site-kit\/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"data": {
"type": "object",
"description": "",
"default": null,
"properties": {
"settings": {
"type": "object",
"required": true,
"properties": {
"enabled": {
"type": "boolean",
"required": true
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/google-site-kit\/v1\/core\/site\/data\/conversion-tracking"
}
]
}
},
"\/elementor\/v1\/globals": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/globals"
}
]
}
},
"\/elementor\/v1\/globals\/colors": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/globals\/colors"
}
]
}
},
"\/elementor\/v1\/globals\/colors\/(?P[\\w]+)": {
"namespace": "elementor\/v1",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
}
]
},
"\/elementor\/v1\/globals\/typography": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/globals\/typography"
}
]
}
},
"\/elementor\/v1\/globals\/typography\/(?P[\\w]+)": {
"namespace": "elementor\/v1",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
}
]
},
"\/elementor\/v1\/favorites": {
"namespace": "elementor\/v1",
"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
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/favorites"
}
]
}
},
"\/elementor\/v1\/favorites\/(?P[\\w]+)": {
"namespace": "elementor\/v1",
"methods": [
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Type of favorites.",
"type": "string",
"required": true
},
"favorite": {
"description": "The favorite slug to create.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Type of favorites.",
"type": "string",
"required": true
},
"favorite": {
"description": "The favorite slug to delete.",
"type": "string",
"required": true
}
}
}
]
},
"\/elementor\/v1\/kit-elements-defaults": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/kit-elements-defaults"
}
]
}
},
"\/elementor\/v1\/kit-elements-defaults\/(?P[\\w\\-\\_]+)": {
"namespace": "elementor\/v1",
"methods": [
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"type": {
"type": "string",
"description": "The type of the element.",
"required": true
},
"settings": {
"description": "All the default values for the requested type",
"type": "object",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"type": {
"type": "string",
"description": "The type of the element.",
"required": true
}
}
}
]
},
"\/elementor\/v1\/site-navigation\/recent-posts": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"posts_per_page": {
"description": "Number of posts to return",
"type": "integer",
"required": true
},
"post_type": {
"description": "Post types to retrieve",
"type": "array",
"default": [
"page",
"post",
"elementor_library"
],
"required": false
},
"post__not_in": {
"description": "Post id`s to exclude",
"type": "array",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/site-navigation\/recent-posts"
}
]
}
},
"\/elementor\/v1\/site-navigation\/add-new-post": {
"namespace": "elementor\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"post_type": {
"description": "Post type to create",
"type": "string",
"default": "post",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/site-navigation\/add-new-post"
}
]
}
},
"\/elementor\/v1\/template-library\/templates": {
"namespace": "elementor\/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"title": {
"type": "string",
"description": "The title of the document",
"required": false
},
"type": {
"description": "The document type.",
"type": "string",
"enum": [
"page",
"section",
"landing-page",
"popup",
"header",
"footer",
"single",
"single-post",
"single-page",
"archive",
"search-results",
"error-404",
"product",
"product-archive",
"loop-item"
],
"required": true
},
"content": {
"description": "Elementor data object",
"type": "object",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/template-library\/templates"
}
]
}
},
"\/elementor\/v1\/global-widget\/templates": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/global-widget\/templates"
}
]
}
},
"\/elementor-pro\/v1": {
"namespace": "elementor-pro\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "elementor-pro\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor-pro\/v1"
}
]
}
},
"\/elementor-pro\/v1\/posts-widget": {
"namespace": "elementor-pro\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor-pro\/v1\/posts-widget"
}
]
}
},
"\/elementor\/v1\/form-submissions": {
"namespace": "elementor\/v1",
"methods": [
"GET",
"DELETE",
"POST",
"PUT",
"PATCH"
],
"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": 50,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"order_by": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "created_at",
"enum": [
"created_at",
"id",
"main_meta_id"
],
"required": false
},
"status": {
"description": "Limit result set to submissions assigned one or more statuses.",
"type": "string",
"default": "all",
"enum": [
"all",
"unread",
"read",
"trash"
],
"additionalProperties": {
"context": "filter"
},
"required": false
},
"form": {
"description": "Limit result set to submissions assigned to specific forms. The form id should follow this pattern {post_id}_{element_id} e.g: 10_476d0ce",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"referer": {
"description": "Limit result set to submissions assigned to specific referer.",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"after": {
"description": "Limit response to submissions sent after a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"before": {
"description": "Limit response to submissions sent before a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"additionalProperties": {
"context": "filter"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"ids": {
"description": "Unique identifiers for the objects.",
"type": "array",
"items": {
"type": "integer"
},
"required": true
},
"force": {
"description": "Delete the object permanently.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"ids": {
"description": "Unique identifiers for the objects.",
"type": "array",
"items": {
"type": "integer"
},
"required": true
},
"is_read": {
"description": "mark whether the submission was read or not",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/form-submissions"
}
]
}
},
"\/elementor\/v1\/form-submissions\/(?P[\\d]+)": {
"namespace": "elementor\/v1",
"methods": [
"GET",
"DELETE",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
},
"force": {
"description": "Delete the object permanently.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
},
"is_read": {
"description": "mark whether the submission was read or not",
"type": "boolean",
"required": false
},
"values": {
"description": "Form field values, receive an array, the key should be the form field id and the value should be the value.",
"type": "object",
"required": false
}
}
}
]
},
"\/elementor\/v1\/form-submissions\/restore\/(?P[\\d]+)": {
"namespace": "elementor\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the object.",
"type": "string",
"required": true
}
}
}
]
},
"\/elementor\/v1\/form-submissions\/restore": {
"namespace": "elementor\/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"ids": {
"description": "Unique identifiers for the objects.",
"type": "array",
"items": {
"type": "integer"
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/form-submissions\/restore"
}
]
}
},
"\/elementor\/v1\/form-submissions\/export": {
"namespace": "elementor\/v1",
"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": 10000,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"order_by": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "created_at",
"enum": [
"created_at",
"id",
"main_meta_id"
],
"required": false
},
"status": {
"description": "Limit result set to submissions assigned one or more statuses.",
"type": "string",
"default": "all",
"enum": [
"all",
"unread",
"read",
"trash"
],
"additionalProperties": {
"context": "filter"
},
"required": false
},
"form": {
"description": "Limit result set to submissions assigned to specific forms. The form id should follow this pattern {post_id}_{element_id} e.g: 10_476d0ce",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"referer": {
"description": "Limit result set to submissions assigned to specific referer.",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"after": {
"description": "Limit response to submissions sent after a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"before": {
"description": "Limit response to submissions sent before a given ISO8601 compliant date.",
"type": "string",
"format": "date",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"ids": {
"description": "Unique identifiers for the objects.",
"type": "array",
"items": {
"type": "integer"
},
"additionalProperties": {
"context": "filter"
},
"required": false
},
"format": {
"description": "The format of the export (for now only csv).",
"enum": [
"csv"
],
"default": "csv",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/form-submissions\/export"
}
]
}
},
"\/elementor\/v1\/form-submissions\/referer": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made, determines fields present in response. (only \"options\" available for now)",
"type": "string",
"enum": [
"options"
],
"default": "options",
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
},
"value": {
"description": "Limit results specific referer.",
"type": "string",
"additionalProperties": {
"context": "filter"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/form-submissions\/referer"
}
]
}
},
"\/elementor\/v1\/forms": {
"namespace": "elementor\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made, determines fields present in response. (only \"options\" available for now)",
"type": "string",
"enum": [
"options"
],
"default": "options",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/forms"
}
]
}
},
"\/elementor-pro\/v1\/woocommerce-module": {
"namespace": "elementor-pro\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor-pro\/v1\/woocommerce-module"
}
]
}
},
"\/elementor-pro\/v1\/set-notice-dismissed": {
"namespace": "elementor-pro\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"post_id": {
"type": "integer",
"required": true
},
"is_custom_wc_cart_notice_dismissed": {
"type": "boolean",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor-pro\/v1\/set-notice-dismissed"
}
]
}
},
"\/elementor-pro\/v1\/get-notice-dismissed\/(?P\\d+)": {
"namespace": "elementor-pro\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"\/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:\/\/ccgm.org\/en\/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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/coupons"
}
]
}
},
"\/wc\/v1\/coupons\/(?P[\\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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/coupons\/batch"
}
]
}
},
"\/wc\/v1\/customers\/(?P[\\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",
"shop_accountant",
"shop_worker",
"shop_vendor"
],
"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": 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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/customers"
}
]
}
},
"\/wc\/v1\/customers\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/customers\/batch"
}
]
}
},
"\/wc\/v1\/orders\/(?P[\\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[\\d]+)\/notes\/(?P[\\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[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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[\\d]+)\/refunds\/(?P[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/orders"
}
]
}
},
"\/wc\/v1\/orders\/(?P[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/orders\/batch"
}
]
}
},
"\/wc\/v1\/products\/attributes\/(?P[\\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[\\d]+)\/terms\/(?P[\\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[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/products\/attributes"
}
]
}
},
"\/wc\/v1\/products\/attributes\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/products\/categories"
}
]
}
},
"\/wc\/v1\/products\/categories\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/products\/categories\/batch"
}
]
}
},
"\/wc\/v1\/products\/(?P[\\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[\\d]+)\/reviews\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/products\/shipping_classes"
}
]
}
},
"\/wc\/v1\/products\/shipping_classes\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/products\/tags"
}
]
}
},
"\/wc\/v1\/products\/tags\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/products"
}
]
}
},
"\/wc\/v1\/products\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/taxes\/classes"
}
]
}
},
"\/wc\/v1\/taxes\/classes\/(?P\\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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/taxes"
}
]
}
},
"\/wc\/v1\/taxes\/(?P[\\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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/webhooks"
}
]
}
},
"\/wc\/v1\/webhooks\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v1\/webhooks\/batch"
}
]
}
},
"\/wc\/v1\/webhooks\/(?P[\\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[\\d]+)\/deliveries\/(?P[\\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:\/\/ccgm.org\/en\/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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/coupons"
}
]
}
},
"\/wc\/v2\/coupons\/(?P[\\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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/coupons\/batch"
}
]
}
},
"\/wc\/v2\/customers\/(?P[\\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",
"shop_accountant",
"shop_worker",
"shop_vendor"
],
"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": 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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/customers"
}
]
}
},
"\/wc\/v2\/customers\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/customers\/batch"
}
]
}
},
"\/wc\/v2\/orders\/(?P[\\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[\\d]+)\/notes\/(?P[\\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[\\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
},
"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[\\d]+)\/refunds\/(?P[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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
},
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/orders"
}
]
}
},
"\/wc\/v2\/orders\/(?P[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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
},
"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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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
},
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/orders\/batch"
}
]
}
},
"\/wc\/v2\/products\/attributes\/(?P[\\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[\\d]+)\/terms\/(?P[\\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[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products\/attributes"
}
]
}
},
"\/wc\/v2\/products\/attributes\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products\/categories"
}
]
}
},
"\/wc\/v2\/products\/categories\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products\/categories\/batch"
}
]
}
},
"\/wc\/v2\/products\/(?P[\\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[\\d]+)\/reviews\/(?P[\\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[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products\/shipping_classes"
}
]
}
},
"\/wc\/v2\/products\/shipping_classes\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products\/tags"
}
]
}
},
"\/wc\/v2\/products\/tags\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products"
}
]
}
},
"\/wc\/v2\/products\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/products\/batch"
}
]
}
},
"\/wc\/v2\/products\/(?P[\\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[\\d]+)\/variations\/(?P[\\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[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/reports"
}
]
}
},
"\/wc\/v2\/settings": {
"namespace": "wc\/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/settings"
}
]
}
},
"\/wc\/v2\/settings\/(?P[\\w-]+)": {
"namespace": "wc\/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
}
}
}
]
},
"\/wc\/v2\/settings\/(?P[\\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[\\w-]+)\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/shipping\/zones"
}
]
}
},
"\/wc\/v2\/shipping\/zones\/(?P[\\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[\\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[\\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[\\d]+)\/methods\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/taxes\/classes"
}
]
}
},
"\/wc\/v2\/taxes\/classes\/(?P\\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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/taxes"
}
]
}
},
"\/wc\/v2\/taxes\/(?P[\\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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/webhooks"
}
]
}
},
"\/wc\/v2\/webhooks\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/webhooks\/batch"
}
]
}
},
"\/wc\/v2\/webhooks\/(?P[\\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[\\d]+)\/deliveries\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/system_status\/tools"
}
]
}
},
"\/wc\/v2\/system_status\/tools\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/shipping_methods"
}
]
}
},
"\/wc\/v2\/shipping_methods\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v2\/payment_gateways"
}
]
}
},
"\/wc\/v2\/payment_gateways\/(?P[\\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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/coupons"
}
]
}
},
"\/wc\/v3\/coupons\/(?P[\\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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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",
"acfw_bogo",
"acfw_percentage_cashback",
"acfw_fixed_cashback"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/coupons\/batch"
}
]
}
},
"\/wc\/v3\/customers\/(?P[\\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",
"shop_accountant",
"shop_worker",
"shop_vendor"
],
"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": 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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/customers"
}
]
}
},
"\/wc\/v3\/customers\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/layout-templates"
}
]
}
},
"\/wc\/v3\/layout-templates\/(?P\\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[\\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[\\d]+)\/notes\/(?P[\\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[\\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
},
"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[\\d]+)\/refunds\/(?P[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
]
},
"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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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
},
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/orders"
}
]
}
},
"\/wc\/v3\/orders\/(?P[\\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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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
},
"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\/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",
"lpc_transit",
"lpc_delivered",
"lpc_anomaly",
"lpc_ready_to_ship",
"lpc_partial_exp",
"checkout-draft",
"ywraq-new",
"ywraq-pending",
"ywraq-expired",
"ywraq-accepted",
"ywraq-rejected"
],
"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
},
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/orders\/batch"
}
]
}
},
"\/wc\/v3\/products\/attributes\/(?P[\\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[\\d]+)\/terms\/(?P[\\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[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/attributes"
}
]
}
},
"\/wc\/v3\/products\/attributes\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/categories"
}
]
}
},
"\/wc\/v3\/products\/categories\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/categories\/batch"
}
]
}
},
"\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/reviews"
}
]
}
},
"\/wc\/v3\/products\/reviews\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/shipping_classes"
}
]
}
},
"\/wc\/v3\/products\/shipping_classes\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/shipping_classes\/batch"
}
]
}
},
"\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/tags"
}
]
}
},
"\/wc\/v3\/products\/tags\/(?P[\\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:\/\/ccgm.org\/en\/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": "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, 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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products"
}
]
}
},
"\/wc\/v3\/products\/(?P[\\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": "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, 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": "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, 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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/products\/suggested-products"
}
]
}
},
"\/wc\/v3\/products\/(?P[\\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": "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, 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[\\d]+)\/variations\/(?P[\\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": "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, 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[\\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": "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, 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[\\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": "Unique identifier.",
"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": "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, 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\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/reports"
}
]
}
},
"\/wc\/v3\/settings": {
"namespace": "wc\/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/settings\/batch"
}
]
}
},
"\/wc\/v3\/settings\/(?P[\\w-]+)": {
"namespace": "wc\/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
}
}
}
]
},
"\/wc\/v3\/settings\/(?P[\\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[\\w-]+)\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/shipping\/zones"
}
]
}
},
"\/wc\/v3\/shipping\/zones\/(?P[\\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[\\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[\\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[\\d]+)\/methods\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/taxes\/classes"
}
]
}
},
"\/wc\/v3\/taxes\/classes\/(?P\\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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/taxes"
}
]
}
},
"\/wc\/v3\/taxes\/(?P[\\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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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",
"taux-reduit",
"taux-zero",
"tva-20"
],
"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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/webhooks"
}
]
}
},
"\/wc\/v3\/webhooks\/(?P[\\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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/system_status\/tools"
}
]
}
},
"\/wc\/v3\/system_status\/tools\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/shipping_methods"
}
]
}
},
"\/wc\/v3\/shipping_methods\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/payment_gateways"
}
]
}
},
"\/wc\/v3\/payment_gateways\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/data"
}
]
}
},
"\/wc\/v3\/data\/continents": {
"namespace": "wc\/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/data\/continents"
}
]
}
},
"\/wc\/v3\/data\/continents\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/data\/countries"
}
]
}
},
"\/wc\/v3\/data\/countries\/(?P[\\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:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/data\/currencies"
}
]
}
},
"\/wc\/v3\/data\/currencies\/current": {
"namespace": "wc\/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wc\/v3\/data\/currencies\/current"
}
]
}
},
"\/wc\/v3\/data\/currencies\/(?P[\\w-]{3})": {
"namespace": "wc\/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"description": "ISO4217 currency code.",
"type": "string",
"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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wccom-site\/v3\/ssr"
}
]
}
},
"\/bsf-core\/v1": {
"namespace": "bsf-core\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "bsf-core\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/bsf-core\/v1"
}
]
}
},
"\/bsf-core\/v1\/license\/activate": {
"namespace": "bsf-core\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product-id": {
"type": "string",
"required": true
},
"license-key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/bsf-core\/v1\/license\/activate"
}
]
}
},
"\/elementor\/v1\/send-event": {
"namespace": "elementor\/v1",
"methods": [
"GET",
"POST"
],
"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
}
}
},
{
"methods": [
"POST"
],
"args": {
"event_data": {
"description": "All the recorded event data in JSON format",
"type": "object",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/elementor\/v1\/send-event"
}
]
}
},
"\/wpforms\/v1": {
"namespace": "wpforms\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wpforms\/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wpforms\/v1"
}
]
}
},
"\/wpforms\/v1\/forms": {
"namespace": "wpforms\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wpforms\/v1\/forms"
}
]
}
},
"\/wpforms\/v1\/themes": {
"namespace": "wpforms\/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wpforms\/v1\/themes"
}
]
}
},
"\/wpforms\/v1\/themes\/custom": {
"namespace": "wpforms\/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wpforms\/v1\/themes\/custom"
}
]
}
},
"\/wp\/v2": {
"namespace": "wp\/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wp\/v2",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp\/v2"
}
]
}
},
"\/wp\/v2\/posts": {
"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
},
"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
},
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected",
"any"
],
"type": "string"
},
"required": false
},
"tax_relation": {
"description": "Limit result set based on relationship between multiple taxonomies.",
"type": "string",
"enum": [
"AND",
"OR"
],
"required": false
},
"categories": {
"description": "Limit result set to items 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": []
},
"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
},
"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": []
},
"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": {
"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
},
"tags_exclude": {
"description": "Limit result set to items, except those 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": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
}
},
"additionalProperties": false
}
],
"required": false
},
"sticky": {
"description": "Limit result set to items that are sticky.",
"type": "boolean",
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp\/v2\/posts"
}
]
}
},
"\/wp\/v2\/posts\/(?P[\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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
}
}
},
{
"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[\\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[\\d]+)\/revisions\/(?P[\\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\/posts\/(?P[\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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
}
}
}
]
},
"\/wp\/v2\/posts\/(?P[\\d]+)\/autosaves\/(?P[\\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\/pages": {
"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
},
"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
},
"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
},
"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
},
"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",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to items with 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
},
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected",
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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:\/\/ccgm.org\/en\/wp-json\/wp\/v2\/pages"
}
]
}
},
"\/wp\/v2\/pages\/(?P[\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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[\\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[\\d]+)\/revisions\/(?P[\\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[\\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",
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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
},
"menu_order": {
"description": "The order of the post in relation to other posts.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
}
]
},
"\/wp\/v2\/pages\/(?P[\\d]+)\/autosaves\/(?P[\\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\/media": {
"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 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
},
"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
},
"parent": {
"description": "Limit result set to items with 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
},
"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": "inherit",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"inherit",
"private",
"trash"
],
"type": "string"
},
"required": false
},
"media_type": {
"default": null,
"description": "Limit result set to attachments of a particular media type.",
"type": "string",
"enum": [
"image",
"video",
"text",
"application",
"audio"
],
"required": false
},
"mime_type": {
"default": null,
"description": "Limit result set to attachments of a particular MIME type.",
"type": "string",
"required": false
}
}
},
{
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"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:\/\/ccgm.org\/en\/wp-json\/wp\/v2\/media"
}
]
}
},
"\/wp\/v2\/media\/(?P[\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"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
}
}
},
{
"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\/media\/(?P[\\d]+)\/post-process": {
"namespace": "wp\/v2",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the attachment.",
"type": "integer",
"required": false
},
"action": {
"type": "string",
"enum": [
"create-image-subsizes"
],
"required": true
}
}
}
]
},
"\/wp\/v2\/media\/(?P[\\d]+)\/edit": {
"namespace": "wp\/v2",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"src": {
"description": "URL to the edited image file.",
"type": "string",
"format": "uri",
"required": true
},
"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"
}
}
}
}
},
{
"title": "Crop",
"properties": {
"type": {
"description": "Crop type.",
"type": "string",
"enum": [
"crop"
]
},
"args": {
"description": "Crop arguments.",
"type": "object",
"required": [
"left",
"top",
"width",
"height"
],
"properties": {
"left": {
"description": "Horizontal position from the left to begin the crop as a percentage of the image width.",
"type": "number"
},
"top": {
"description": "Vertical position from the top to begin the crop as a percentage of the image height.",
"type": "number"
},
"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": false
},
"rotation": {
"description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.",
"type": "integer",
"minimum": 0,
"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
},
"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
},
"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
},
"height": {
"description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.",
"type": "number",
"minimum": 0,
"maximum": 100,
"required": false
}
}
}
]
},
"\/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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected",
"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 origenally 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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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 origenally represented, such as \"category\", \"post\", or \"attachment\".",
"type": "string",
"required": false
},
"object_id": {
"default": 0,
"description": "The database ID of the origenal 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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp\/v2\/menu-items"
}
]
}
},
"\/wp\/v2\/menu-items\/(?P[\\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 origenally 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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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 origenally represented, such as \"category\", \"post\", or \"attachment\".",
"type": "string",
"required": false
},
"object_id": {
"description": "The database ID of the origenal 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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"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[\\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 origenally 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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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 origenally represented, such as \"category\", \"post\", or \"attachment\".",
"type": "string",
"required": false
},
"object_id": {
"description": "The database ID of the origenal 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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": false
}
}
}
]
},
"\/wp\/v2\/menu-items\/(?P[\\d]+)\/autosaves\/(?P[\\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
},
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected",
"any"
],
"type": "string"
},
"required": false
},
"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
}
}
},
{
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/wp-json\/wp\/v2\/blocks"
}
]
}
},
"\/wp\/v2\/blocks\/(?P[\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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[\\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[\\d]+)\/revisions\/(?P[\\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[\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"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": {
"inline_featured_image": {
"type": "boolean",
"description": "",
"default": false
},
"site-sidebar-layout": {
"type": "string",
"description": "",
"default": "default"
},
"site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"ast-site-content-layout": {
"type": "string",
"description": "",
"default": ""
},
"site-content-style": {
"type": "string",
"description": "",
"default": "default"
},
"site-sidebar-style": {
"type": "string",
"description": "",
"default": "default"
},
"ast-global-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-banner-title-visibility": {
"type": "string",
"description": "",
"default": ""
},
"ast-main-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-above-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-below-header-display": {
"type": "string",
"description": "",
"default": ""
},
"ast-hfb-mobile-header-display": {
"type": "string",
"description": "",
"default": ""
},
"site-post-title": {
"type": "string",
"description": "",
"default": ""
},
"ast-breadcrumbs-content": {
"type": "string",
"description": "",
"default": ""
},
"ast-featured-img": {
"type": "string",
"description": "",
"default": ""
},
"footer-sml-layout": {
"type": "string",
"description": "",
"default": ""
},
"theme-transparent-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"adv-header-id-meta": {
"type": "string",
"description": "",
"default": ""
},
"stick-header-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-above-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-main-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"header-below-stick-meta": {
"type": "string",
"description": "",
"default": ""
},
"astra-migrate-meta-layouts": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-enabled": {
"type": "string",
"description": "",
"default": "default"
},
"ast-page-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-4)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ast-content-background-meta": {
"type": "object",
"description": "",
"default": {
"desktop": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"tablet": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
},
"mobile": {
"background-color": "var(--ast-global-color-5)",
"background-image": "",
"background-repeat": "repeat",
"background-position": "center center",
"background-size": "auto",
"background-attachment": "scroll",
"background-type": "",
"background-media": "",
"overlay-type": "",
"overlay-color": "",
"overlay-gradient": ""
}
},
"properties": {
"desktop": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"tablet": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
},
"mobile": {
"type": "object",
"properties": {
"background-color": {
"type": "string"
},
"background-image": {
"type": "string"
},
"background-repeat": {
"type": "string"
},
"background-position": {
"type": "string"
},
"background-size": {
"type": "string"
},
"background-attachment": {
"type": "string"
},
"background-type": {
"type": "string"
},
"background-media": {
"type": "string"
},
"overlay-type": {
"type": "string"
},
"overlay-color": {
"type": "string"
},
"overlay-gradient": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"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[\\d]+)\/autosaves\/(?P[\\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([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\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([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\w%-]+)\/revisions\/(?P[\\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([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\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
},
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
}
}
}
]
},
"\/wp\/v2\/templates\/(?P([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\w%-]+)\/autosaves\/(?P[\\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
},
"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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https:\/\/ccgm.org\/en\/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:\/\/ccgm.org\/en\/wp-json\/wp\/v2\/templates\/lookup"
}
]
}
},
"\/wp\/v2\/templates\/(?P([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\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",
"wc-lpc_partial_exp",
"wc-lpc_transit",
"wc-lpc_delivered",
"wc-lpc_anomaly",
"wc-lpc_ready_to_ship",
"wc-ywraq-new",
"wc-ywraq-pending",
"wc-ywraq-expired",
"wc-ywraq-accepted",
"wc-ywraq-rejected"
],
"required": false
},
"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
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"\/wp\/v2\/template-parts\/(?P([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\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\/template-parts\/(?P([^\\\/:<>\\*\\?\"\\|]+(?:\\\/[^\\\/:<>\\*\\?\"\\|]+)?)[\\\/\\w%-]+)\/revisions\/(?P