{ "_links": { "help": [ { "href": "https://developer.wordpress.org/rest-api/" } ] }, "authentication": [], "description": "", "gmt_offset": 2, "home": "https://haikuatelier.fr.ddev.site", "name": "Haiku Atelier", "namespaces": [ "carbon-fields/v1", "jetpack/v4", "wc-admin", "wc-analytics", "wc-telemetry", "wc/private", "wc/store", "wc/store/v1", "wc/v1", "wc/v2", "wc/v3", "wccom-site/v3", "wp-block-editor/v1", "wp-site-health/v1", "wp/v2" ], "routes": { "/": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "" }, "/batch/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/batch/v1" } ] }, "endpoints": [ { "args": { "requests": { "items": { "properties": { "body": { "additionalProperties": true, "properties": [], "type": "object" }, "headers": { "additionalProperties": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "properties": [], "type": "object" }, "method": { "default": "POST", "enum": [ "DELETE", "PATCH", "POST", "PUT" ], "type": "string" }, "path": { "required": true, "type": "string" } }, "type": "object" }, "maxItems": 25, "required": true, "type": "array" }, "validation": { "default": "normal", "enum": [ "normal", "require-all-validate" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "" }, "/carbon-fields/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "carbon-fields/v1", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/association": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/association" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/association/options": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/association/options" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/attachment": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/attachment" } ] }, "endpoints": [ { "args": { "type": { "description": "The requested type: ID or URL.", "required": true, "type": "string" }, "value": { "description": "The ID / URL of the attachment", "required": true, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/block-renderer": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/block-renderer" } ] }, "endpoints": [ { "args": { "content": { "description": "The content of the block.", "required": true, "type": "string" }, "name": { "description": "The name of the block.", "required": true, "type": "string" }, "post_id": { "description": "ID of the post context.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/comments/(?P\\d+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/options": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/options" } ] }, "endpoints": [ { "args": [], "methods": [ "GET", "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/posts/(?P\\d+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/terms/(?P\\d+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/users/(?P\\d+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "carbon-fields/v1" }, "/jetpack/v4": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "jetpack/v4", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": { "isActive": { "description": "Set to false will trigger the site to disconnect.", "required": true } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/authorize_url": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/authorize_url" } ] }, "endpoints": [ { "args": { "redirect_uri": { "description": "URI of the admin page where the user should be redirected after connection flow", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/data": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/data" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/owner": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/owner" } ] }, "endpoints": [ { "args": { "owner": { "description": "New owner", "required": true, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/plugins": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/plugins" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/reconnect": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/reconnect" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/connection/register": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/register" } ] }, "endpoints": [ { "args": { "from": { "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", "required": false, "type": "string" }, "plugin_slug": { "description": "Indicates from what plugin the request is coming from", "required": false, "type": "string" }, "redirect_uri": { "description": "URI of the admin page where the user should be redirected after connection flow", "required": false, "type": "string" }, "registration_nonce": { "description": "The registration nonce", "required": true, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/remote_authorize": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/remote_authorize" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/user-token": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/user-token" } ] }, "endpoints": [ { "args": { "is_connection_owner": { "description": "Is connection owner", "required": false, "type": "boolean" }, "user_token": { "description": "New user token", "required": true, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/verify_registration": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_registration" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "jetpack/v4" }, "/jetpack/v4/verify_xmlrpc_error": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_xmlrpc_error" } ] }, "endpoints": [ { "args": { "nonce": { "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "jetpack/v4" }, "/wc-admin": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc-admin", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/experiments/assignment": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/experiments/assignment" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/features": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/features" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/initialize-coming-soon": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/initialize-coming-soon" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/survey-completed": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/survey-completed" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/update-survey-status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/update-survey-status" } ] }, "endpoints": [ { "args": { "status": { "enum": [ "no", "yes" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/woopayments/test-orders": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders" } ] }, "endpoints": [ { "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE" ], "namespace": "wc-admin" }, "/wc-admin/launch-your-store/woopayments/test-orders/count": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders/count" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/campaign-types": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaign-types" } ] }, "endpoints": [ { "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/campaigns": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaigns" } ] }, "endpoints": [ { "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/channels": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/channels" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/knowledge-base": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/knowledge-base" } ] }, "endpoints": [ { "args": { "category": { "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/overview/activate-plugin": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/activate-plugin" } ] }, "endpoints": [ { "args": { "plugin": { "required": true, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/marketing/overview/installed-plugins": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/installed-plugins" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/recommendations": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommendations" } ] }, "endpoints": [ { "args": { "category": { "enum": [ "channels", "extensions" ], "required": true, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/marketing/recommended": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommended" } ] }, "endpoints": [ { "args": { "category": { "required": false, "type": "string" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/mobile-app": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/mobile-app/send-magic-link": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app/send-magic-link" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/navigation/favorites/me": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/navigation/favorites/me" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": { "item_id": { "required": true } }, "methods": [ "POST" ] }, { "args": { "item_id": { "required": true } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "POST" ], "namespace": "wc-admin" }, "/wc-admin/notice/dismiss": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/notice/dismiss" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/free-extensions": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/free-extensions" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/install-and-activate": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/install-and-activate-async": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate-async" } ] }, "endpoints": [ { "args": { "plugins": { "description": "A list of plugins to install", "items": "string", "required": true, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/jetpack-authorization-url": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/jetpack-authorization-url" } ] }, "endpoints": [ { "args": { "from": { "default": "woocommerce-onboarding", "description": "from value for the jetpack authorization page", "required": false, "type": "string" }, "redirect_url": { "description": "The URL to redirect to after authorization", "required": true, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/plugins/scheduled-installs/(?P\\w+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/product-types": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/product-types" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/products" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/profile": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": { "business_extensions": { "description": "Extra business extensions to install.", "items": { "type": "string" }, "required": false, "type": "array" }, "completed": { "description": "Whether or not the profile was completed.", "required": false, "type": "boolean" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "industry": { "description": "Industry.", "items": { "type": "object" }, "required": false, "type": "array" }, "is_agree_marketing": { "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", "required": false, "type": "boolean" }, "is_plugins_page_skipped": { "description": "Whether or not plugins step in core profiler was skipped.", "required": false, "type": "boolean" }, "is_store_country_set": { "description": "Whether or not this store country is set via onboarding profiler.", "required": false, "type": "boolean" }, "number_employees": { "description": "Number of employees of the store.", "enum": [ "+250", "<10", "1", "10-50", "50-250", "not specified" ], "required": false, "type": "string" }, "other_platform": { "description": "Name of other platform used to sell.", "enum": [ "amazon", "bigcommerce", "ebay", "etsy", "magento", "other", "shopify", "squarespace", "wix" ], "required": false, "type": "string" }, "other_platform_name": { "description": "Name of other platform used to sell (not listed).", "required": false, "type": "string" }, "product_count": { "description": "Number of products to be added.", "enum": [ "0", "1-10", "1000+", "101-1000", "11-100" ], "required": false, "type": "string" }, "product_types": { "description": "Types of products sold.", "items": { "enum": [ "bookings", "downloads", "memberships", "physical", "product-add-ons", "product-bundles", "subscriptions" ], "type": "string" }, "required": false, "type": "array" }, "revenue": { "description": "Current annual revenue of the store.", "enum": [ "10000-50000", "2500-10000", "50000-250000", "more-than-250000", "none", "rather-not-say", "up-to-2500" ], "required": false, "type": "string" }, "selling_venues": { "description": "Other places the store is selling products.", "enum": [ "brick-mortar", "brick-mortar-other", "no", "other", "other-woocommerce" ], "required": false, "type": "string" }, "setup_client": { "description": "Whether or not this store was setup for a client.", "required": false, "type": "boolean" }, "skipped": { "description": "Whether or not the profile was skipped.", "required": false, "type": "boolean" }, "store_email": { "description": "Store email address.", "required": false, "type": "string" }, "theme": { "description": "Selected store theme.", "required": false, "type": "string" }, "wccom_connected": { "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", "required": false, "type": "boolean" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/profile/experimental_get_email_prefill": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile/experimental_get_email_prefill" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks" } ] }, "endpoints": [ { "args": { "ids": { "description": "Optional parameter to get only specific task lists by ID.", "items": { "enum": [ "extended", "secret_tasklist", "setup" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "extended_tasks": { "description": "List of extended deprecated tasks from the client-side filter.", "required": false, "type": "array" }, "ids": { "description": "Optional parameter to get only specific task lists by ID.", "items": { "enum": [ "extended", "secret_tasklist", "setup" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_-]+)/snooze": { "endpoints": [ { "args": { "duration": { "description": "Time period to snooze the task.", "required": false, "type": "string" }, "task_list_id": { "description": "Optional parameter to query specific task list.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/action": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/dismiss": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/hide": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/undo_dismiss": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/undo_snooze": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/unhide": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/create_homepage": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_homepage" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/create_product_from_template": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_product_from_template" } ] }, "endpoints": [ { "args": { "template_name": { "description": "Product template name.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/tasks/import_sample_products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/import_sample_products" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/themes/activate": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/activate" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/themes/install": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/install" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/onboarding/themes/recommended": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/recommended" } ] }, "endpoints": [ { "args": { "currency": { "default": "USD", "description": "Returns pricing in this currency (optional, default: USD)", "enum": [ "AUD", "CAD", "EUR", "GBP", "USD" ], "required": false, "type": "string" }, "industry": { "description": "Limits the results to themes relevant for this industry (optional)", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/options": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/options" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/payment-gateway-suggestions": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions" } ] }, "endpoints": [ { "args": { "force_default_suggestions": { "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", "required": false, "type": "boolean" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/payment-gateway-suggestions/dismiss": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions/dismiss" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/plugins/activate": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/plugins/activate/status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate/status" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/activate/status/(?P[a-z0-9_\\-]+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/active": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/active" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/connect-jetpack": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-jetpack" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/connect-square": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-square" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/plugins/connect-wcpay": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-wcpay" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/plugins/finish-wccom-connect": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/finish-wccom-connect" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/plugins/install": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-admin/plugins/install/status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install/status" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/install/status/(?P[a-z0-9_\\-]+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/installed": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/installed" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/plugins/request-wccom-connect": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/request-wccom-connect" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-admin" }, "/wc-admin/shipping-partner-suggestions": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/shipping-partner-suggestions" } ] }, "endpoints": [ { "args": { "force_default_suggestions": { "description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no", "required": false, "type": "boolean" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-admin" }, "/wc-admin/themes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/themes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "pluginzip": { "description": "A zip file of the theme to be uploaded.", "required": false, "type": "file" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-admin" }, "/wc-analytics": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc-analytics", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "note_id", "status", "title", "type" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "source": { "description": "Source of note.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "description": "Status of note.", "items": { "enum": [ "actioned", "pending", "sent", "snoozed", "unactioned" ], "type": "string" }, "required": false, "type": "array" }, "type": { "description": "Type of note.", "items": { "enum": [ "email", "error", "info", "marketing", "survey", "update", "warning" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "note_id", "status", "title", "type" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "source": { "description": "Source of note.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "description": "Status of note.", "items": { "enum": [ "actioned", "pending", "sent", "snoozed", "unactioned" ], "type": "string" }, "required": false, "type": "array" }, "type": { "description": "Type of note.", "items": { "enum": [ "email", "error", "info", "marketing", "survey", "update", "warning" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/(?P[\\d-]+)": { "endpoints": [ { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/(?P[\\d-]+)/action/(?P[\\d-]+)": { "endpoints": [ { "args": { "action_id": { "description": "Unique ID for the Note Action.", "required": false, "type": "integer" }, "note_id": { "description": "Unique ID for the Note.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "action_id": { "description": "Unique ID for the Note Action.", "required": false, "type": "integer" }, "note_id": { "description": "Unique ID for the Note.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/delete/(?P[\\d-]+)": { "endpoints": [ { "args": [], "methods": [ "DELETE" ] }, { "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/delete/all": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/delete/all" } ] }, "endpoints": [ { "args": { "status": { "description": "Status of note.", "items": { "enum": [ "actioned", "pending", "sent", "snoozed", "unactioned" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "DELETE" ] }, { "args": { "status": { "description": "Status of note.", "items": { "enum": [ "actioned", "pending", "sent", "snoozed", "unactioned" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/experimental-activate-promo/(?P[\\w-]+)": { "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] }, { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/tracker/(?P[\\d-]+)/user/(?P[\\d-]+)": { "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/admin/notes/update": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/update" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] }, { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "code": { "description": "Limit result set to resources with a specific code.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to coupons with codes matching a given string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": true, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "code": { "description": "Limit result set to resources with a specific code.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to coupons with codes matching a given string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": true, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/coupons/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons/batch" } ] }, "endpoints": [ { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/customers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/customers" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "required": false, "type": "number" }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "required": false, "type": "number" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "required": false, "type": "string" }, "country_includes": { "description": "Limit response to objects with specific countries.", "required": false, "type": "string" }, "email_excludes": { "description": "Limit response to objects excluding emails.", "required": false, "type": "string" }, "email_includes": { "description": "Limit response to objects including emails.", "required": false, "type": "string" }, "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "items": { "enum": [ "city", "country", "email", "name", "postcode", "state" ], "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "include": { "description": "Limit result to items with specified customer IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "required": false, "type": "string" }, "name_includes": { "description": "Limit response to objects with specific names.", "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_registered", "description": "Sort collection by object attribute.", "enum": [ "avg_order_value", "city", "country", "date_last_active", "date_registered", "name", "orders_count", "postcode", "state", "total_spend", "username" ], "required": false, "type": "string" }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "required": false, "type": "integer" }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "required": false, "type": "integer" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "required": false, "type": "string" }, "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "enum": [ "all", "email", "name", "username" ], "required": false, "type": "string" }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "required": false, "type": "number" }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "required": false, "type": "number" }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "required": false, "type": "string" }, "username_includes": { "description": "Limit response to objects with specific usernames.", "required": false, "type": "string" }, "users": { "description": "Limit result to items with specified user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/customers/(?P[\\d-]+)": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "required": false, "type": "number" }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "required": false, "type": "number" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "required": false, "type": "string" }, "country_includes": { "description": "Limit response to objects with specific countries.", "required": false, "type": "string" }, "email_excludes": { "description": "Limit response to objects excluding emails.", "required": false, "type": "string" }, "email_includes": { "description": "Limit response to objects including emails.", "required": false, "type": "string" }, "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "items": { "enum": [ "city", "country", "email", "name", "postcode", "state" ], "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" }, "include": { "description": "Limit result to items with specified customer IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "required": false, "type": "string" }, "name_includes": { "description": "Limit response to objects with specific names.", "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_registered", "description": "Sort collection by object attribute.", "enum": [ "avg_order_value", "city", "country", "date_last_active", "date_registered", "name", "orders_count", "postcode", "state", "total_spend", "username" ], "required": false, "type": "string" }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "required": false, "type": "integer" }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "required": false, "type": "integer" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "required": false, "type": "string" }, "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "enum": [ "all", "email", "name", "username" ], "required": false, "type": "string" }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "required": false, "type": "number" }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "required": false, "type": "number" }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "required": false, "type": "string" }, "username_includes": { "description": "Limit response to objects with specific usernames.", "required": false, "type": "string" }, "users": { "description": "Limit result to items with specified user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/data": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/data/countries": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/data/countries/(?P[\\w-]+)": { "endpoints": [ { "args": { "location": { "description": "ISO3166 alpha-2 country code.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "location": { "description": "ISO3166 alpha-2 country code.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/data/countries/locales": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries/locales" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/data/download-ips": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/download-ips" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/leaderboards": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 5, "description": "Maximum number of items to be returned in result set.", "maximum": 20, "minimum": 1, "required": false, "type": "integer" }, "persisted_query": { "description": "URL query to persist across links.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/leaderboards/(?P\\w+)": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "leaderboard": { "enum": [ "categories", "coupons", "customers", "products" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 5, "description": "Maximum number of items to be returned in result set.", "maximum": 20, "minimum": 1, "required": false, "type": "integer" }, "persisted_query": { "description": "URL query to persist across links.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/leaderboards/allowed": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards/allowed" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/orders": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "required": false, "type": "integer" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "number": { "description": "Limit result set to orders matching part of an order number.", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "description": "Limit result set to orders assigned a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": [ "any" ], "description": "Limit result set to orders which have specific statuses.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "default": false, "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "default": "pending", "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "required": false, "type": "integer" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "number": { "description": "Limit result set to orders matching part of an order number.", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "description": "Limit result set to orders assigned a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": [ "any" ], "description": "Limit result set to orders which have specific statuses.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "default": false, "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "default": "pending", "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/orders/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "low_in_stock": { "default": false, "description": "Limit result set to products that are low or out of stock. (Deprecated)", "required": false, "type": "boolean" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "popularity", "price", "rating", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar product name or SKU.", "required": false, "type": "string" }, "search_sku": { "description": "Limit results to those with a SKU that partially matches a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "default": false, "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "default": "publish", "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "default": false, "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "low_in_stock": { "default": false, "description": "Limit result set to products that are low or out of stock. (Deprecated)", "required": false, "type": "boolean" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "popularity", "price", "rating", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar product name or SKU.", "required": false, "type": "string" }, "search_sku": { "description": "Limit results to those with a SKU that partially matches a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "default": false, "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "default": "publish", "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "default": false, "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/(?P[\\d]+)/duplicate": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/(?P[\\d]+)/variations": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "GET", "GET", "POST", "POST", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/(?P[\\d]+)/variations/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "DELETE", "DELETE", "GET", "GET", "GET", "GET", "PATCH", "PATCH", "PATCH", "PATCH", "POST", "POST", "POST", "POST", "PUT", "PUT", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/(?P[\\d]+)/variations/batch": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "PATCH", "PATCH", "POST", "POST", "POST", "POST", "PUT", "PUT", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/(?P[\\d]+)/variations/generate": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_values": { "description": "Default values for generated variations.", "properties": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "description": { "description": "Variation description.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "downloadable": { "description": "If the variation is downloadable.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "integer", "null" ], "validate_callback": "rest_validate_request_arg" }, "manage_stock": { "description": "Stock management at variation level.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "menu_order": { "description": "Menu order, used to custom sort products.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "name": { "description": "Product parent name.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "parent_id": { "description": "Product parent ID.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "regular_price": { "description": "Variation regular price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sale_price": { "description": "Variation sale price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "shipping_class": { "description": "Shipping class slug.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sku": { "description": "Stock Keeping Unit.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "stock_quantity": { "description": "Stock quantity.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_class": { "description": "Tax class.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "type": { "description": "Product type.", "enum": [ "variation" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "virtual": { "description": "If the variation is virtual.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "weight": { "description": "Variation weight (kg).", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" } }, "required": false, "type": "object" }, "delete": { "description": "Deletes unused variations.", "required": false, "type": "boolean" }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_values": { "description": "Default values for generated variations.", "properties": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "description": { "description": "Variation description.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "downloadable": { "description": "If the variation is downloadable.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "integer", "null" ], "validate_callback": "rest_validate_request_arg" }, "manage_stock": { "description": "Stock management at variation level.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "menu_order": { "description": "Menu order, used to custom sort products.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "name": { "description": "Product parent name.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "parent_id": { "description": "Product parent ID.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "regular_price": { "description": "Variation regular price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sale_price": { "description": "Variation sale price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "shipping_class": { "description": "Shipping class slug.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sku": { "description": "Stock Keeping Unit.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "stock_quantity": { "description": "Stock quantity.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_class": { "description": "Tax class.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "type": { "description": "Product type.", "enum": [ "variation" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "virtual": { "description": "If the variation is virtual.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "weight": { "description": "Variation weight (kg).", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" } }, "required": false, "type": "object" }, "delete": { "description": "Deletes unused variations.", "required": false, "type": "boolean" }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_values": { "description": "Default values for generated variations.", "properties": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "description": { "description": "Variation description.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "downloadable": { "description": "If the variation is downloadable.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "integer", "null" ], "validate_callback": "rest_validate_request_arg" }, "manage_stock": { "description": "Stock management at variation level.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "menu_order": { "description": "Menu order, used to custom sort products.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "name": { "description": "Product parent name.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "parent_id": { "description": "Product parent ID.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "regular_price": { "description": "Variation regular price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sale_price": { "description": "Variation sale price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "shipping_class": { "description": "Shipping class slug.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sku": { "description": "Stock Keeping Unit.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "stock_quantity": { "description": "Stock quantity.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_class": { "description": "Tax class.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "type": { "description": "Product type.", "enum": [ "variation" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "virtual": { "description": "If the variation is virtual.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "weight": { "description": "Variation weight (kg).", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" } }, "required": false, "type": "object" }, "delete": { "description": "Deletes unused variations.", "required": false, "type": "boolean" }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_values": { "description": "Default values for generated variations.", "properties": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "description": { "description": "Variation description.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "downloadable": { "description": "If the variation is downloadable.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "integer", "null" ], "validate_callback": "rest_validate_request_arg" }, "manage_stock": { "description": "Stock management at variation level.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "menu_order": { "description": "Menu order, used to custom sort products.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "name": { "description": "Product parent name.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "parent_id": { "description": "Product parent ID.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "regular_price": { "description": "Variation regular price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sale_price": { "description": "Variation sale price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "shipping_class": { "description": "Shipping class slug.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sku": { "description": "Stock Keeping Unit.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "stock_quantity": { "description": "Stock quantity.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_class": { "description": "Tax class.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "type": { "description": "Product type.", "enum": [ "variation" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "virtual": { "description": "If the variation is virtual.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "weight": { "description": "Variation weight (kg).", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" } }, "required": false, "type": "object" }, "delete": { "description": "Deletes unused variations.", "required": false, "type": "boolean" }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product parent name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "variation", "description": "Product type.", "enum": [ "variation" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST", "POST", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "search": { "description": "Search by similar attribute name.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "default": false, "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "order_by": { "default": "menu_order", "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "default": "select", "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "search": { "description": "Search by similar attribute name.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "default": false, "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "order_by": { "default": "menu_order", "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "default": "select", "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/(?P[a-z0-9_\\-]+)": { "endpoints": [ { "args": { "slug": { "description": "Slug identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "slug": { "description": "Slug identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/(?P[a-z0-9_\\-]+)/terms": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/products/attributes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes/batch" } ] }, "endpoints": [ { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/batch" } ] }, "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "default": "default", "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "default": "default", "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/categories/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/count-low-in-stock": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/count-low-in-stock" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/products/low-in-stock": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/low-in-stock" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "status": { "default": "publish", "description": "Limit result set to products assigned a specific status.", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/products/reviews": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by object attribute.", "enum": [ "date", "date_gmt", "id", "include", "product" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": [], "description": "Limit result set to reviews assigned to specific product IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "reviewer": { "description": "Limit result set to reviews assigned to specific user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "reviewer_email": { "default": null, "description": "Limit result set to that from a specific author email.", "format": "email", "required": false, "type": "string" }, "reviewer_exclude": { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", "enum": [ "all", "approved", "hold", "spam", "trash" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "product_id": { "description": "Unique identifier for the product.", "required": true, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "Review content.", "required": true, "type": "string" }, "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, "status": { "default": "approved", "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by object attribute.", "enum": [ "date", "date_gmt", "id", "include", "product" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": [], "description": "Limit result set to reviews assigned to specific product IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "reviewer": { "description": "Limit result set to reviews assigned to specific user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "reviewer_email": { "default": null, "description": "Limit result set to that from a specific author email.", "format": "email", "required": false, "type": "string" }, "reviewer_exclude": { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", "enum": [ "all", "approved", "hold", "spam", "trash" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "product_id": { "description": "Unique identifier for the product.", "required": true, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "Review content.", "required": true, "type": "string" }, "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, "status": { "default": "approved", "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/products/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the product that the review belongs to.", "required": false, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" }, "reviewer": { "description": "Reviewer name.", "required": false, "type": "string" }, "reviewer_email": { "description": "Reviewer email.", "format": "email", "required": false, "type": "string" }, "status": { "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the product that the review belongs to.", "required": false, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" }, "reviewer": { "description": "Reviewer name.", "required": false, "type": "string" }, "reviewer_email": { "description": "Reviewer email.", "format": "email", "required": false, "type": "string" }, "status": { "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/reviews/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews/batch" } ] }, "endpoints": [ { "args": { "product_id": { "description": "Unique identifier for the product that the review belongs to.", "required": false, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" }, "reviewer": { "description": "Reviewer name.", "required": false, "type": "string" }, "reviewer_email": { "description": "Reviewer email.", "format": "email", "required": false, "type": "string" }, "status": { "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "product_id": { "description": "Unique identifier for the product that the review belongs to.", "required": false, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" }, "reviewer": { "description": "Reviewer name.", "required": false, "type": "string" }, "reviewer_email": { "description": "Reviewer email.", "format": "email", "required": false, "type": "string" }, "status": { "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/products/suggested-products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/suggested-products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "default": [], "description": "Limit result set to specific product categorie ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "limit": { "default": 5, "description": "Limit result set to specific amount of suggested products.", "required": false, "type": "integer" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tags": { "default": [], "description": "Limit result set to specific product tag ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "default": [], "description": "Limit result set to specific product categorie ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "limit": { "default": 5, "description": "Limit result set to specific amount of suggested products.", "required": false, "type": "integer" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tags": { "default": [], "description": "Limit result set to specific product tag ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/(?P[a-z]+)/export": { "endpoints": [ { "args": { "email": { "description": "When true, email a link to download the export to the requesting user.", "required": false, "type": "boolean" }, "report_args": { "description": "Parameters to pass on to the exported report.", "required": false, "type": "object" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/(?P[a-z]+)/export/(?P[a-z0-9]+)/status": { "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/categories" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "extended_info": { "default": false, "description": "Add additional piece of info about each category to the report.", "required": false, "type": "boolean" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "category_id", "description": "Sort collection by object attribute.", "enum": [ "category", "category_id", "items_sold", "net_revenue", "orders_count", "products_count" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "status_is": { "description": "Limit result set to items that have the specified order status.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" }, "status_is_not": { "description": "Limit result set to items that don't have the specified order status.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "coupons": { "description": "Limit result set to coupons assigned specific coupon IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "extended_info": { "default": false, "description": "Add additional piece of info about each coupon to the report.", "required": false, "type": "boolean" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "coupon_id", "description": "Sort collection by object attribute.", "enum": [ "amount", "code", "coupon_id", "orders_count" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/coupons/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "coupons": { "description": "Limit result set to coupons assigned specific coupon IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "amount", "coupons_count", "date", "orders_count" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "segmentby": { "description": "Segment the response by additional constraint.", "enum": [ "category", "coupon", "product", "variation" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/customers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "required": false, "type": "number" }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "required": false, "type": "number" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "required": false, "type": "string" }, "country_includes": { "description": "Limit response to objects with specific countries.", "required": false, "type": "string" }, "customers": { "description": "Limit result to items with specified customer IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "email_excludes": { "description": "Limit response to objects excluding emails.", "required": false, "type": "string" }, "email_includes": { "description": "Limit response to objects including emails.", "required": false, "type": "string" }, "filter_empty": { "description": "Filter out results where any of the passed fields are empty", "items": { "enum": [ "city", "country", "email", "name", "postcode", "state" ], "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "required": false, "type": "string" }, "name_includes": { "description": "Limit response to objects with specific names.", "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_registered", "description": "Sort collection by object attribute.", "enum": [ "avg_order_value", "city", "country", "date_last_active", "date_registered", "name", "orders_count", "postcode", "state", "total_spend", "username" ], "required": false, "type": "string" }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "required": false, "type": "integer" }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "required": false, "type": "integer" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "required": false, "type": "string" }, "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "enum": [ "all", "email", "name", "username" ], "required": false, "type": "string" }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "required": false, "type": "number" }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "required": false, "type": "number" }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "required": false, "type": "string" }, "username_includes": { "description": "Limit response to objects with specific usernames.", "required": false, "type": "string" }, "users": { "description": "Limit result to items with specified user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/customers/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers/stats" } ] }, "endpoints": [ { "args": { "avg_order_value_between": { "description": "Limit response to objects with an average order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "avg_order_value_max": { "description": "Limit response to objects with an average order spend less than or equal to a given number.", "required": false, "type": "number" }, "avg_order_value_min": { "description": "Limit response to objects with an average order spend greater than or equal to given number.", "required": false, "type": "number" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "country_excludes": { "description": "Limit response to objects excluding specific countries.", "required": false, "type": "string" }, "country_includes": { "description": "Limit response to objects with specific countries.", "required": false, "type": "string" }, "customers": { "description": "Limit result to items with specified customer IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "email_excludes": { "description": "Limit response to objects excluding emails.", "required": false, "type": "string" }, "email_includes": { "description": "Limit response to objects including emails.", "required": false, "type": "string" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "last_active_after": { "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_before": { "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_active_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "last_order_after": { "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "last_order_before": { "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "name_excludes": { "description": "Limit response to objects excluding specific names.", "required": false, "type": "string" }, "name_includes": { "description": "Limit response to objects with specific names.", "required": false, "type": "string" }, "orders_count_between": { "description": "Limit response to objects with an order count between two given integers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orders_count_max": { "description": "Limit response to objects with an order count less than or equal to given integer.", "required": false, "type": "integer" }, "orders_count_min": { "description": "Limit response to objects with an order count greater than or equal to given integer.", "required": false, "type": "integer" }, "registered_after": { "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_before": { "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", "format": "date-time", "required": false, "type": "string" }, "registered_between": { "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", "items": { "type": "string" }, "required": false, "type": "array" }, "search": { "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", "required": false, "type": "string" }, "searchby": { "default": "name", "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", "enum": [ "all", "email", "name", "username" ], "required": false, "type": "string" }, "total_spend_between": { "description": "Limit response to objects with a total order spend between two given numbers.", "items": { "type": "integer" }, "required": false, "type": "array" }, "total_spend_max": { "description": "Limit response to objects with a total order spend less than or equal to given number.", "required": false, "type": "number" }, "total_spend_min": { "description": "Limit response to objects with a total order spend greater than or equal to given number.", "required": false, "type": "number" }, "username_excludes": { "description": "Limit response to objects excluding specific usernames.", "required": false, "type": "string" }, "username_includes": { "description": "Limit response to objects with specific usernames.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/downloads": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer_excludes": { "description": "Limit response to objects that don't have the specified user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "customer_includes": { "description": "Limit response to objects that have the specified user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "ip_address_excludes": { "description": "Limit response to objects that don't have a specified IP address.", "items": { "type": "string" }, "required": false, "type": "array" }, "ip_address_includes": { "description": "Limit response to objects that have a specified IP address.", "items": { "type": "string" }, "required": false, "type": "array" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.", "enum": [ "all", "any" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_excludes": { "description": "Limit result set to items that don't have the specified order IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order_includes": { "description": "Limit result set to items that have the specified order IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "product" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_excludes": { "default": [], "description": "Limit result set to items that don't have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_includes": { "default": [], "description": "Limit result set to items that have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/downloads/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer_excludes": { "description": "Limit response to objects that don't have the specified customer IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "customer_includes": { "description": "Limit response to objects that have the specified customer IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "ip_address_excludes": { "description": "Limit response to objects that don't have a specified IP address.", "items": { "type": "string" }, "required": false, "type": "array" }, "ip_address_includes": { "description": "Limit response to objects that have a specified IP address.", "items": { "type": "string" }, "required": false, "type": "array" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_excludes": { "description": "Limit result set to items that don't have the specified order IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order_includes": { "description": "Limit result set to items that have the specified order IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "download_count" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_excludes": { "default": [], "description": "Limit result set to items that don't have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_includes": { "default": [], "description": "Limit result set to items that have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import" } ] }, "endpoints": [ { "args": { "days": { "description": "Number of days to import.", "minimum": 0, "required": false, "type": "integer" }, "skip_existing": { "default": false, "description": "Skip importing existing order data.", "required": false, "type": "boolean" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/cancel": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/cancel" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/delete": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/delete" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/status" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/import/totals": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/totals" } ] }, "endpoints": [ { "args": { "days": { "description": "Number of days to import.", "minimum": 0, "required": false, "type": "integer" }, "skip_existing": { "default": false, "description": "Skip importing existing order data.", "required": false, "type": "boolean" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/orders": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_is": { "default": [], "description": "Limit result set to orders that include products with the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "attribute_is_not": { "default": [], "description": "Limit result set to orders that don't include products with the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "coupon_excludes": { "default": [], "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "coupon_includes": { "default": [], "description": "Limit result set to items that have the specified coupon(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "customer_type": { "default": "", "description": "Limit result set to returning or new customers.", "enum": [ "", "new", "returning" ], "required": false, "type": "string" }, "extended_info": { "default": false, "description": "Add additional piece of info about each coupon to the report.", "required": false, "type": "boolean" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_excludes": { "description": "Limit result set to items that don't have the specified order IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order_includes": { "description": "Limit result set to items that have the specified order IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "net_total", "num_items_sold" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "product_excludes": { "default": [], "description": "Limit result set to items that don't have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_includes": { "default": [], "description": "Limit result set to items that have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "refunds": { "default": "", "description": "Limit result set to specific types of refunds.", "enum": [ "", "all", "full", "none", "partial" ], "required": false, "type": "string" }, "status_is": { "description": "Limit result set to items that have the specified order status.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" }, "status_is_not": { "description": "Limit result set to items that don't have the specified order status.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" }, "tax_rate_excludes": { "default": [], "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "tax_rate_includes": { "default": [], "description": "Limit result set to items that have the specified tax rate(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variation_excludes": { "default": [], "description": "Limit result set to items that don't have the specified variation(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variation_includes": { "default": [], "description": "Limit result set to items that have the specified variation(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/orders/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_is": { "default": [], "description": "Limit result set to orders that include products with the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "attribute_is_not": { "default": [], "description": "Limit result set to orders that don't include products with the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "coupon_excludes": { "default": [], "description": "Limit result set to items that don't have the specified coupon(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "coupon_includes": { "default": [], "description": "Limit result set to items that have the specified coupon(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "customer": { "description": "Alias for customer_type (deprecated).", "enum": [ "new", "returning" ], "required": false, "type": "string" }, "customer_type": { "description": "Limit result set to orders that have the specified customer_type", "enum": [ "new", "returning" ], "required": false, "type": "string" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "avg_order_value", "date", "net_revenue", "orders_count" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_excludes": { "default": [], "description": "Limit result set to items that don't have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_includes": { "default": [], "description": "Limit result set to items that have the specified product(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "refunds": { "default": "", "description": "Limit result set to specific types of refunds.", "enum": [ "", "all", "full", "none", "partial" ], "required": false, "type": "string" }, "segmentby": { "description": "Segment the response by additional constraint.", "enum": [ "category", "coupon", "customer_type", "product", "variation" ], "required": false, "type": "string" }, "status_is": { "default": null, "description": "Limit result set to items that have the specified order status.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" }, "status_is_not": { "description": "Limit result set to items that don't have the specified order status.", "items": { "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" }, "tax_rate_excludes": { "default": [], "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "tax_rate_includes": { "default": [], "description": "Limit result set to items that have the specified tax rate(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variation_excludes": { "default": [], "description": "Limit result set to items that don't have the specified variation(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variation_includes": { "default": [], "description": "Limit result set to items that have the specified variation(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/performance-indicators": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "stats": { "default": [ "coupons/amount", "coupons/orders_count", "downloads/download_count", "orders/avg_order_value", "orders/orders_count", "products/items_sold", "revenue/gross_sales", "revenue/net_revenue", "revenue/refunds", "revenue/shipping", "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", "taxes/total_tax", "variations/items_sold" ], "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", "items": { "enum": [ "coupons/amount", "coupons/orders_count", "downloads/download_count", "orders/avg_order_value", "orders/orders_count", "products/items_sold", "revenue/gross_sales", "revenue/net_revenue", "revenue/refunds", "revenue/shipping", "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", "taxes/total_tax", "variations/items_sold" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/performance-indicators/allowed": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators/allowed" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "stats": { "default": [ "coupons/amount", "coupons/orders_count", "downloads/download_count", "orders/avg_order_value", "orders/orders_count", "products/items_sold", "revenue/gross_sales", "revenue/net_revenue", "revenue/refunds", "revenue/shipping", "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", "taxes/total_tax", "variations/items_sold" ], "description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.", "items": { "enum": [ "coupons/amount", "coupons/orders_count", "downloads/download_count", "orders/avg_order_value", "orders/orders_count", "products/items_sold", "revenue/gross_sales", "revenue/net_revenue", "revenue/refunds", "revenue/shipping", "revenue/total_sales", "taxes/order_tax", "taxes/shipping_tax", "taxes/total_tax", "variations/items_sold" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "description": "Limit result to items from the specified categories.", "items": { "type": "integer" }, "required": false, "type": "array" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "extended_info": { "default": false, "description": "Add additional piece of info about each product to the report.", "required": false, "type": "boolean" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "items_sold", "net_revenue", "orders_count", "product_name", "sku", "variations" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "products": { "description": "Limit result to items with specified product IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/products/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "description": "Limit result to items from the specified categories.", "items": { "type": "integer" }, "required": false, "type": "array" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "coupons", "date", "items_sold", "net_revenue", "net_revenue", "orders_count", "refunds", "shipping", "taxes" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "products": { "description": "Limit result to items with specified product IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "segmentby": { "description": "Segment the response by additional constraint.", "enum": [ "category", "product", "variation" ], "required": false, "type": "string" }, "variations": { "description": "Limit result to items with specified variation IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/revenue/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/revenue/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "date_type": { "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", "enum": [ "date_completed", "date_created", "date_paid" ], "required": false, "type": "string" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "coupons", "date", "gross_sales", "items_sold", "net_revenue", "orders_count", "refunds", "shipping", "taxes", "total_sales" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "segmentby": { "description": "Segment the response by additional constraint.", "enum": [ "category", "coupon", "customer_type", "product", "variation" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/stock": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "stock_status", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "sku", "stock_quantity", "stock_status", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "type": { "default": "all", "description": "Limit result set to items assigned a stock report type.", "enum": [ "all", "instock", "lowstock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/stock/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock/stats" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/taxes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "tax_rate_id", "description": "Sort collection by object attribute.", "enum": [ "name", "order_tax", "orders_count", "rate", "shipping_tax", "tax_code", "tax_rate_id", "total_tax" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "taxes": { "description": "Limit result set to items assigned one or more tax rates.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/taxes/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "items_sold", "orders_count", "products_count", "total_sales" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "segmentby": { "description": "Segment the response by additional constraint.", "enum": [ "tax_rate_id" ], "required": false, "type": "string" }, "taxes": { "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/variations": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_is": { "default": [], "description": "Limit result set to variations that include the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "attribute_is_not": { "default": [], "description": "Limit result set to variations that don't include the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category_excludes": { "description": "Limit result set to variations not in the specified categories.", "items": { "type": "integer" }, "required": false, "type": "array" }, "category_includes": { "description": "Limit result set to variations in the specified categories.", "items": { "type": "integer" }, "required": false, "type": "array" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "extended_info": { "default": false, "description": "Add additional piece of info about each variation to the report.", "required": false, "type": "boolean" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "items_sold", "net_revenue", "orders_count", "sku" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_excludes": { "default": [], "description": "Limit result set to items that don't have the specified parent product(s).", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_includes": { "default": [], "description": "Limit result set to items that have the specified parent product(s).", "items": { "type": "integer" }, "required": false, "type": "array" }, "products": { "description": "Limit result to items with specified product IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variations": { "description": "Limit result to items with specified variation IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/reports/variations/stats": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations/stats" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_is": { "default": [], "description": "Limit result set to orders that include products with the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "attribute_is_not": { "default": [], "description": "Limit result set to orders that don't include products with the specified attributes.", "items": { "type": "array" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category_excludes": { "description": "Limit result set to variations not in the specified categories.", "items": { "type": "integer" }, "required": false, "type": "array" }, "category_includes": { "description": "Limit result to items from the specified categories.", "items": { "type": "integer" }, "required": false, "type": "array" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "fields": { "description": "Limit stats fields to the specified items.", "items": { "type": "string" }, "required": false, "type": "array" }, "force_cache_refresh": { "description": "Force retrieval of fresh data instead of from the cache.", "required": false, "type": "boolean" }, "interval": { "default": "week", "description": "Time interval to use for buckets in the returned data.", "enum": [ "day", "hour", "month", "quarter", "week", "year" ], "required": false, "type": "string" }, "match": { "default": "all", "description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories", "enum": [ "all", "any" ], "required": false, "type": "string" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "coupons", "date", "items_sold", "net_revenue", "net_revenue", "orders_count", "refunds", "shipping", "taxes" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_excludes": { "default": [], "description": "Limit result set to items that don't have the specified parent product(s).", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_includes": { "default": [], "description": "Limit result set to items that have the specified parent product(s).", "items": { "type": "integer" }, "required": false, "type": "array" }, "segmentby": { "description": "Segment the response by additional constraint.", "enum": [ "category", "product", "variation" ], "required": false, "type": "string" }, "variations": { "description": "Limit result to items with specified variation IDs.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/settings/(?P[\\w-]+)": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-analytics/settings/(?P[\\w-]+)/(?P[\\w-]+)": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/settings/(?P[\\w-]+)/batch": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/taxes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes" } ] }, "endpoints": [ { "args": { "class": { "description": "Sort by tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "include": { "default": [], "description": "Limit result set to items that have the specified rate ID(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar tax code.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "default": "standard", "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "default": 1, "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "args": { "class": { "description": "Sort by tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "include": { "default": [], "description": "Limit result set to items that have the specified rate ID(s) assigned.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar tax code.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "default": "standard", "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "default": 1, "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "GET", "POST", "POST" ], "namespace": "wc-analytics" }, "/wc-analytics/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "DELETE", "GET", "GET", "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/taxes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes/batch" } ] }, "endpoints": [ { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "PATCH", "POST", "POST", "PUT", "PUT" ], "namespace": "wc-analytics" }, "/wc-analytics/variations": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/variations" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Search by similar product name, SKU, or attribute value.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "GET", "GET", "GET" ], "namespace": "wc-analytics" }, "/wc-telemetry": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc-telemetry", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc-telemetry" }, "/wc-telemetry/tracker": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry/tracker" } ] }, "endpoints": [ { "args": { "installation_date": { "description": "Installation date of the WooCommerce mobile app.", "format": "date-time", "required": false, "type": "string" }, "platform": { "description": "Platform to track.", "required": true, "type": "string" }, "version": { "description": "Platform version to track.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc-telemetry" }, "/wc/private": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc/private", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/private" }, "/wc/private/ai/business-description": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/business-description" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "business_description": { "description": "The business description for a given store.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/private" }, "/wc/private/ai/images": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/images" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "business_description": { "description": "The business description for a given store.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/private" }, "/wc/private/ai/patterns": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/patterns" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "business_description": { "description": "The business description for a given store.", "required": false, "type": "string" }, "images": { "description": "The images for a given store.", "required": false, "type": "object" } }, "methods": [ "POST" ] }, { "allow_batch": { "v1": true }, "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "POST" ], "namespace": "wc/private" }, "/wc/private/ai/product": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/product" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "last_product": { "description": "Whether the product being updated is the last one in the loop", "required": false, "type": "boolean" }, "products_information": { "description": "Data generated by AI for updating dummy products.", "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/private" }, "/wc/private/ai/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/products" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "business_description": { "description": "The business description for a given store.", "required": false, "type": "string" }, "images": { "description": "The images for a given store.", "required": false, "type": "object" } }, "methods": [ "POST" ] }, { "allow_batch": { "v1": true }, "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "POST" ], "namespace": "wc/private" }, "/wc/private/ai/store-info": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-info" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/private" }, "/wc/private/ai/store-title": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-title" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "business_description": { "description": "The business description for a given store.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/private" }, "/wc/private/patterns": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/patterns" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": [], "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/private" }, "/wc/store": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc/store", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/batch" } ] }, "endpoints": [ { "args": { "requests": { "items": { "properties": { "body": { "additionalProperties": true, "properties": [], "type": "object" }, "headers": { "additionalProperties": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "properties": [], "type": "object" }, "method": { "default": "POST", "enum": [ "DELETE", "PATCH", "POST", "PUT" ], "type": "string" }, "path": { "required": true, "type": "string" } }, "type": "object" }, "maxItems": 25, "required": true, "type": "array" }, "validation": { "default": "normal", "enum": [ "normal", "require-all-validate" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/cart/add-item": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/add-item" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "id": { "description": "The basket item product or variation ID.", "required": false, "type": "integer" }, "quantity": { "description": "Quantity of this item to add to the basket.", "required": false, "type": "integer" }, "variation": { "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { "context": [ "edit", "view" ], "description": "Variation attribute name.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Variation attribute value.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/apply-coupon": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/apply-coupon" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/coupons" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "code": { "description": "The coupon's unique code.", "required": false, "type": "string" }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "allow_batch": { "v1": true }, "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "POST" ], "namespace": "wc/store" }, "/wc/store/cart/coupons/(?P[\\w-]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/store" }, "/wc/store/cart/extensions": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/extensions" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "data": { "description": "Additional data to pass to the extension", "required": false, "type": "object" }, "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/items": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/items" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "extensions": { "default": [], "properties": [], "required": false, "type": "object" } }, "methods": [ "POST" ] }, { "allow_batch": { "v1": true }, "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "POST" ], "namespace": "wc/store" }, "/wc/store/cart/items/(?P[\\w-]{32})": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "key": { "description": "Unique identifier for the item within the basket.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "extensions": { "properties": [], "required": false, "type": "object" }, "key": { "description": "Unique identifier for the item within the basket.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/store" }, "/wc/store/cart/remove-coupon": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-coupon" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/remove-item": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-item" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/select-shipping-rate": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/select-shipping-rate" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, "type": [ "integer", "null", "string" ] }, "rate_id": { "description": "The chosen rate ID for the package.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/update-customer": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-customer" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "billing_address": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" }, "shipping_address": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/cart/update-item": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-item" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item to update.", "required": false, "type": "string" }, "quantity": { "description": "New quantity of the item in the basket.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/checkout": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/checkout" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "additional_fields": { "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": true, "type": "object" }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "required": false, "type": "boolean" }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "required": false, "type": "string" }, "customer_password": { "description": "Customer password for new accounts, if applicable.", "required": false, "type": "string" }, "extensions": { "default": { "woocommerce/order-attribution": [] }, "properties": { "woocommerce/order-attribution": { "context": [ "edit", "view" ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", "type": [ "null", "string" ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", "type": [ "null", "string" ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", "type": [ "null", "string" ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", "type": [ "null", "string" ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", "type": [ "null", "string" ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", "type": [ "null", "string" ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", "type": [ "null", "string" ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", "type": [ "null", "string" ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", "type": [ "null", "string" ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", "type": [ "null", "string" ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", "type": [ "null", "string" ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", "type": [ "null", "string" ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", "type": [ "null", "string" ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", "type": [ "null", "string" ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", "type": [ "null", "string" ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", "type": [ "null", "string" ] } }, "type": [ "null", "object" ] } }, "required": false, "type": "object" }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "items": { "properties": { "key": { "type": "string" }, "value": { "type": [ "boolean", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "enum": [ "bacs", "cheque", "cod" ], "required": false, "type": "string" }, "shipping_address": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/store" }, "/wc/store/checkout/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "additional_fields": { "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": true, "type": "object" }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "required": false, "type": "string" }, "extensions": { "default": { "woocommerce/order-attribution": [] }, "properties": { "woocommerce/order-attribution": { "context": [ "edit", "view" ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", "type": [ "null", "string" ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", "type": [ "null", "string" ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", "type": [ "null", "string" ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", "type": [ "null", "string" ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", "type": [ "null", "string" ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", "type": [ "null", "string" ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", "type": [ "null", "string" ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", "type": [ "null", "string" ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", "type": [ "null", "string" ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", "type": [ "null", "string" ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", "type": [ "null", "string" ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", "type": [ "null", "string" ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", "type": [ "null", "string" ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", "type": [ "null", "string" ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", "type": [ "null", "string" ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", "type": [ "null", "string" ] } }, "type": [ "null", "object" ] } }, "required": false, "type": "object" }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "items": { "properties": { "key": { "type": "string" }, "value": { "type": [ "boolean", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "enum": [ "bacs", "cheque", "cod" ], "required": false, "type": "string" }, "shipping_address": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store" }, "/wc/store/order/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", "enum": [ "and", "in" ], "required": false, "type": "string" }, "attributes": { "default": [], "description": "Limit result set to products with selected global attributes.", "items": { "properties": { "attribute": { "description": "Attribute taxonomy name.", "sanitize_callback": "wc_sanitize_taxonomy_name", "type": "string" }, "operator": { "description": "Operator to compare product attribute terms.", "enum": [ "and", "in", "not_in" ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "enum": [ "any", "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "category_operator": { "default": "in", "description": "Operator to compare product category terms.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "comment_count", "date", "id", "include", "menu_order", "modified", "popularity", "price", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "rating": { "default": [], "description": "Limit result set to products with a certain average rating.", "items": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "required": false, "type": "string" }, "stock_status": { "default": [], "description": "Limit result set to products with specified stock status.", "items": { "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" }, "required": false, "type": "array" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tag_operator": { "default": "in", "description": "Operator to compare product tags.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable", "variation" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/(?P[\\S]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "slug": { "description": "Slug of the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/attributes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/attributes" } ] }, "endpoints": [ { "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": true, "description": "If true, empty terms will not be returned.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Sort ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", "enum": [ "count", "id", "menu_order", "name", "name_num", "slug" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/categories" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": true, "description": "If true, empty terms will not be returned.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Sort ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", "enum": [ "count", "name", "slug" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/collection-data": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/collection-data" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", "enum": [ "and", "in" ], "required": false, "type": "string" }, "attributes": { "default": [], "description": "Limit result set to products with selected global attributes.", "items": { "properties": { "attribute": { "description": "Attribute taxonomy name.", "sanitize_callback": "wc_sanitize_taxonomy_name", "type": "string" }, "operator": { "description": "Operator to compare product attribute terms.", "enum": [ "and", "in", "not_in" ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "calculate_attribute_counts": { "default": [], "description": "If requested, calculates attribute term counts for products in the collection.", "items": { "properties": { "query_type": { "context": [ "edit", "view" ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", "enum": [ "and", "or" ], "readonly": true, "type": "string" }, "taxonomy": { "context": [ "edit", "view" ], "description": "Taxonomy name.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "calculate_price_range": { "default": false, "description": "If true, calculates the minimum and maximum product prices for the collection.", "required": false, "type": "boolean" }, "calculate_rating_counts": { "default": false, "description": "If true, calculates rating counts for products in the collection.", "required": false, "type": "boolean" }, "calculate_stock_status_counts": { "default": false, "description": "If true, calculates stock counts for products in the collection.", "required": false, "type": "boolean" }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "enum": [ "any", "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "category_operator": { "default": "in", "description": "Operator to compare product category terms.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "comment_count", "date", "id", "include", "menu_order", "modified", "popularity", "price", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "rating": { "default": [], "description": "Limit result set to products with a certain average rating.", "items": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "required": false, "type": "string" }, "stock_status": { "default": [], "description": "Limit result set to products with specified stock status.", "items": { "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" }, "required": false, "type": "array" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tag_operator": { "default": "in", "description": "Operator to compare product tags.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable", "variation" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/reviews": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/reviews" } ] }, "endpoints": [ { "args": { "category_id": { "description": "Limit result set to reviews from specific category IDs.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "date_gmt", "id", "product", "rating" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "product_id": { "description": "Limit result set to reviews from specific product IDs.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/products/tags": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/tags" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": true, "description": "If true, empty terms will not be returned.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Sort ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", "enum": [ "count", "name", "slug" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store" }, "/wc/store/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc/store/v1", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/batch" } ] }, "endpoints": [ { "args": { "requests": { "items": { "properties": { "body": { "additionalProperties": true, "properties": [], "type": "object" }, "headers": { "additionalProperties": { "items": { "type": "string" }, "type": [ "array", "string" ] }, "properties": [], "type": "object" }, "method": { "default": "POST", "enum": [ "DELETE", "PATCH", "POST", "PUT" ], "type": "string" }, "path": { "required": true, "type": "string" } }, "type": "object" }, "maxItems": 25, "required": true, "type": "array" }, "validation": { "default": "normal", "enum": [ "normal", "require-all-validate" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/add-item": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/add-item" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "id": { "description": "The basket item product or variation ID.", "required": false, "type": "integer" }, "quantity": { "description": "Quantity of this item to add to the basket.", "required": false, "type": "integer" }, "variation": { "description": "Chosen attributes (for variations).", "items": { "properties": { "attribute": { "context": [ "edit", "view" ], "description": "Variation attribute name.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Variation attribute value.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/apply-coupon": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/apply-coupon" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/coupons" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "code": { "description": "The coupon's unique code.", "required": false, "type": "string" }, "discount_type": { "description": "The discount type for the coupon (eg percentage or fixed amount)", "required": false, "type": "string" } }, "methods": [ "POST" ] }, { "allow_batch": { "v1": true }, "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/coupons/(?P[\\w-]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/extensions": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/extensions" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "data": { "description": "Additional data to pass to the extension", "required": false, "type": "object" }, "namespace": { "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/items": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/items" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "extensions": { "default": [], "properties": [], "required": false, "type": "object" } }, "methods": [ "POST" ] }, { "allow_batch": { "v1": true }, "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/items/(?P[\\w-]{32})": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "key": { "description": "Unique identifier for the item within the basket.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "extensions": { "properties": [], "required": false, "type": "object" }, "key": { "description": "Unique identifier for the item within the basket.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier for the item within the basket.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/remove-coupon": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-coupon" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "code": { "description": "Unique identifier for the coupon within the basket.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/remove-item": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-item" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/select-shipping-rate": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/select-shipping-rate" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "package_id": { "description": "The ID of the package being shipped. Leave blank to apply to all packages.", "required": false, "type": [ "integer", "null", "string" ] }, "rate_id": { "description": "The chosen rate ID for the package.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/update-customer": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-customer" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "billing_address": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" }, "shipping_address": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/cart/update-item": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-item" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "key": { "description": "Unique identifier (key) for the basket item to update.", "required": false, "type": "string" }, "quantity": { "description": "New quantity of the item in the basket.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/checkout": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/checkout" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "additional_fields": { "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": true, "type": "object" }, "create_account": { "description": "Whether to create a new user account as part of order processing.", "required": false, "type": "boolean" }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "required": false, "type": "string" }, "customer_password": { "description": "Customer password for new accounts, if applicable.", "required": false, "type": "string" }, "extensions": { "default": { "woocommerce/order-attribution": [] }, "properties": { "woocommerce/order-attribution": { "context": [ "edit", "view" ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", "type": [ "null", "string" ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", "type": [ "null", "string" ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", "type": [ "null", "string" ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", "type": [ "null", "string" ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", "type": [ "null", "string" ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", "type": [ "null", "string" ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", "type": [ "null", "string" ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", "type": [ "null", "string" ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", "type": [ "null", "string" ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", "type": [ "null", "string" ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", "type": [ "null", "string" ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", "type": [ "null", "string" ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", "type": [ "null", "string" ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", "type": [ "null", "string" ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", "type": [ "null", "string" ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", "type": [ "null", "string" ] } }, "type": [ "null", "object" ] } }, "required": false, "type": "object" }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "items": { "properties": { "key": { "type": "string" }, "value": { "type": [ "boolean", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "enum": [ "bacs", "cheque", "cod" ], "required": false, "type": "string" }, "shipping_address": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/checkout/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "additional_fields": { "description": "Additional fields to be persisted on the order.", "properties": [], "required": false, "type": "object" }, "billing_address": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": true, "type": "object" }, "customer_note": { "description": "Note added to the order by the customer during checkout.", "required": false, "type": "string" }, "extensions": { "default": { "woocommerce/order-attribution": [] }, "properties": { "woocommerce/order-attribution": { "context": [ "edit", "view" ], "description": "Extension data registered by woocommerce/order-attribution", "properties": { "referrer": { "context": [], "description": "Order attribution field: referrer", "type": [ "null", "string" ] }, "session_count": { "context": [], "description": "Order attribution field: session_count", "type": [ "null", "string" ] }, "session_entry": { "context": [], "description": "Order attribution field: session_entry", "type": [ "null", "string" ] }, "session_pages": { "context": [], "description": "Order attribution field: session_pages", "type": [ "null", "string" ] }, "session_start_time": { "context": [], "description": "Order attribution field: session_start_time", "type": [ "null", "string" ] }, "source_type": { "context": [], "description": "Order attribution field: source_type", "type": [ "null", "string" ] }, "user_agent": { "context": [], "description": "Order attribution field: user_agent", "type": [ "null", "string" ] }, "utm_campaign": { "context": [], "description": "Order attribution field: utm_campaign", "type": [ "null", "string" ] }, "utm_content": { "context": [], "description": "Order attribution field: utm_content", "type": [ "null", "string" ] }, "utm_creative_format": { "context": [], "description": "Order attribution field: utm_creative_format", "type": [ "null", "string" ] }, "utm_id": { "context": [], "description": "Order attribution field: utm_id", "type": [ "null", "string" ] }, "utm_marketing_tactic": { "context": [], "description": "Order attribution field: utm_marketing_tactic", "type": [ "null", "string" ] }, "utm_medium": { "context": [], "description": "Order attribution field: utm_medium", "type": [ "null", "string" ] }, "utm_source": { "context": [], "description": "Order attribution field: utm_source", "type": [ "null", "string" ] }, "utm_source_platform": { "context": [], "description": "Order attribution field: utm_source_platform", "type": [ "null", "string" ] }, "utm_term": { "context": [], "description": "Order attribution field: utm_term", "type": [ "null", "string" ] } }, "type": [ "null", "object" ] } }, "required": false, "type": "object" }, "payment_data": { "description": "Data to pass through to the payment method when processing payment.", "items": { "properties": { "key": { "type": "string" }, "value": { "type": [ "boolean", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "payment_method": { "description": "The ID of the payment method being used to process the payment.", "enum": [ "bacs", "cheque", "cod" ], "required": false, "type": "string" }, "shipping_address": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address", "required": true, "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Flat, suite, etc.", "required": true, "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City", "required": true, "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company", "required": true, "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country/Region code in ISO 3166-1 alpha-2 format.", "required": true, "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name", "required": true, "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name", "required": true, "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone", "required": true, "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postcode", "required": true, "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "State/County code, or name of the state, county, province, or district.", "required": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/store/v1" }, "/wc/store/v1/order/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", "enum": [ "and", "in" ], "required": false, "type": "string" }, "attributes": { "default": [], "description": "Limit result set to products with selected global attributes.", "items": { "properties": { "attribute": { "description": "Attribute taxonomy name.", "sanitize_callback": "wc_sanitize_taxonomy_name", "type": "string" }, "operator": { "description": "Operator to compare product attribute terms.", "enum": [ "and", "in", "not_in" ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "enum": [ "any", "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "category_operator": { "default": "in", "description": "Operator to compare product category terms.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "comment_count", "date", "id", "include", "menu_order", "modified", "popularity", "price", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "rating": { "default": [], "description": "Limit result set to products with a certain average rating.", "items": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "required": false, "type": "string" }, "stock_status": { "default": [], "description": "Limit result set to products with specified stock status.", "items": { "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" }, "required": false, "type": "array" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tag_operator": { "default": "in", "description": "Operator to compare product tags.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable", "variation" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/(?P[\\S]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "slug": { "description": "Slug of the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/attributes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/attributes" } ] }, "endpoints": [ { "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": true, "description": "If true, empty terms will not be returned.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Sort ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", "enum": [ "count", "id", "menu_order", "name", "name_num", "slug" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/categories" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": true, "description": "If true, empty terms will not be returned.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Sort ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", "enum": [ "count", "name", "slug" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/collection-data": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/collection-data" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources created after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute_relation": { "default": "and", "description": "The logical relationship between attributes when filtering across several at once.", "enum": [ "and", "in" ], "required": false, "type": "string" }, "attributes": { "default": [], "description": "Limit result set to products with selected global attributes.", "items": { "properties": { "attribute": { "description": "Attribute taxonomy name.", "sanitize_callback": "wc_sanitize_taxonomy_name", "type": "string" }, "operator": { "description": "Operator to compare product attribute terms.", "enum": [ "and", "in", "not_in" ], "type": "string" }, "slug": { "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", "items": { "type": "string" }, "sanitize_callback": "wp_parse_slug_list", "type": "array" }, "term_id": { "description": "List of attribute term IDs.", "items": { "type": "integer" }, "sanitize_callback": "wp_parse_id_list", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources created before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "calculate_attribute_counts": { "default": [], "description": "If requested, calculates attribute term counts for products in the collection.", "items": { "properties": { "query_type": { "context": [ "edit", "view" ], "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", "enum": [ "and", "or" ], "readonly": true, "type": "string" }, "taxonomy": { "context": [ "edit", "view" ], "description": "Taxonomy name.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "calculate_price_range": { "default": false, "description": "If true, calculates the minimum and maximum product prices for the collection.", "required": false, "type": "boolean" }, "calculate_rating_counts": { "default": false, "description": "If true, calculates rating counts for products in the collection.", "required": false, "type": "boolean" }, "calculate_stock_status_counts": { "default": false, "description": "If true, calculates stock counts for products in the collection.", "required": false, "type": "boolean" }, "catalog_visibility": { "description": "Determines if hidden or visible catalogue products are shown.", "enum": [ "any", "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "category_operator": { "default": "in", "description": "Operator to compare product category terms.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "date_column": { "default": "date", "description": "When limiting response using after/before, which date column to compare against.", "enum": [ "date", "date_gmt", "modified", "modified_gmt" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "comment_count", "date", "id", "include", "menu_order", "modified", "popularity", "price", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "rating": { "default": [], "description": "Limit result set to products with a certain average rating.", "items": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with specific slug(s). Use commas to separate.", "required": false, "type": "string" }, "stock_status": { "default": [], "description": "Limit result set to products with specified stock status.", "items": { "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "sanitize_text_field", "type": "string", "validate_callback": "rest_validate_request_arg" }, "required": false, "type": "array" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tag_operator": { "default": "in", "description": "Operator to compare product tags.", "enum": [ "and", "in", "not_in" ], "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable", "variation" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/reviews": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/reviews" } ] }, "endpoints": [ { "args": { "category_id": { "description": "Limit result set to reviews from specific category IDs.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "date_gmt", "id", "product", "rating" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "product_id": { "description": "Limit result set to reviews from specific product IDs.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/store/v1/products/tags": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/tags" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": true, "description": "If true, empty terms will not be returned.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Sort ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort by term property.", "enum": [ "count", "name", "slug" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", "maximum": 100, "minimum": 0, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/store/v1" }, "/wc/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc/v1", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "code": { "description": "Limit result set to resources with a specific code.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "filter": { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false, "type": "object" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": true, "type": "string" }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "expiry_date": { "description": "UTC DateTime when the coupon expires.", "required": false, "type": [ "null", "string" ] }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "expiry_date": { "description": "UTC DateTime when the coupon expires.", "required": false, "type": [ "null", "string" ] }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/coupons/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons/batch" } ] }, "endpoints": [ { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "expiry_date": { "description": "UTC DateTime when the coupon expires.", "required": false, "type": [ "null", "string" ] }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/customers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "email": { "description": "Limit result set to resources with a specific email.", "format": "email", "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", "enum": [ "id", "include", "name", "registered_date" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "role": { "default": "customer", "description": "Limit result set to resources with a specific role.", "enum": [ "administrator", "all", "author", "contributor", "customer", "editor", "shop_manager", "subscriber" ], "required": false, "type": "string" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "New user email address.", "required": true, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "password": { "description": "New user password.", "required": true, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "New user username.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/customers/(?P[\\d]+)/downloads": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "customer_id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/customers/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "The email address for the customer.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "password": { "description": "Customer password.", "required": false, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "Customer login name.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "reassign": { "default": 0, "description": "ID to reassign posts to.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/customers/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "The email address for the customer.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "password": { "description": "Customer password.", "required": false, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "Customer login name.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/orders": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "required": false, "type": "integer" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "filter": { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false, "type": "object" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "description": "Limit result set to orders assigned a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to orders assigned a specific status.", "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta": { "context": [ "edit", "view" ], "description": "Line item meta data.", "items": { "properties": { "key": { "context": [ "edit", "view" ], "description": "Meta key.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "Meta label.", "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "readonly": true, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "readonly": true, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "readonly": true, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "string" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "default": "pending", "description": "Order status.", "enum": [ "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta": { "context": [ "edit", "view" ], "description": "Line item meta data.", "items": { "properties": { "key": { "context": [ "edit", "view" ], "description": "Meta key.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "Meta label.", "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "readonly": true, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "readonly": true, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "readonly": true, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "string" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/orders/(?P[\\d]+)/notes": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "customer_note": { "default": false, "description": "Shows/define if the note is only for reference or for the customer (the user will be notified).", "required": false, "type": "boolean" }, "note": { "description": "Order note content.", "required": true, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/orders/(?P[\\d]+)/notes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v1" }, "/wc/v1/orders/(?P[\\d]+)/refunds": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "required": false, "type": "integer" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "filter": { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false, "type": "object" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "description": "Limit result set to orders assigned a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to orders assigned a specific status.", "enum": [ "any", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "Refund amount.", "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "reason": { "description": "Reason for refund.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/orders/(?P[\\d]+)/refunds/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v1" }, "/wc/v1/orders/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta": { "context": [ "edit", "view" ], "description": "Line item meta data.", "items": { "properties": { "key": { "context": [ "edit", "view" ], "description": "Meta key.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "Meta label.", "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "readonly": true, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "readonly": true, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "readonly": true, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "string" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "readonly": true, "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1.", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2.", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "filter": { "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "required": false, "type": "object" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with a specific SKU.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_on_sale_from": { "description": "Start date of sale price.", "required": false, "type": "string" }, "date_on_sale_to": { "description": "End data of sale price.", "required": false, "type": "string" }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "download_type": { "default": "standard", "description": "Download type, this controls the schema on the front-end.", "enum": [ "standard" ], "required": false, "type": "string" }, "downloadable": { "default": false, "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "default": false, "description": "Featured product.", "required": false, "type": "boolean" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "in_stock": { "default": true, "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "required": false, "type": "boolean" }, "manage_stock": { "default": false, "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "default": "publish", "description": "Product status (post status).", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variations": { "description": "List of variations.", "items": { "properties": { "attributes": { "context": [ "edit", "view" ], "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "type": "array" }, "backordered": { "context": [ "edit", "view" ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { "context": [ "edit", "view" ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "type": "string" }, "backorders_allowed": { "context": [ "edit", "view" ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_on_sale_from": { "context": [ "edit", "view" ], "description": "Start date of sale price.", "type": "string" }, "date_on_sale_to": { "context": [ "edit", "view" ], "description": "End data of sale price.", "type": "string" }, "dimensions": { "context": [ "edit", "view" ], "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "type": "object" }, "download_expiry": { "context": [ "edit", "view" ], "default": null, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { "context": [ "edit", "view" ], "default": null, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { "context": [ "edit", "view" ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { "context": [ "edit", "view" ], "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "context": [ "edit", "view" ], "description": "Variation ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "in_stock": { "context": [ "edit", "view" ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "context": [ "edit", "view" ], "default": false, "description": "Stock management at variation level.", "type": "boolean" }, "on_sale": { "context": [ "edit", "view" ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { "context": [ "edit", "view" ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { "context": [ "edit", "view" ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, "regular_price": { "context": [ "edit", "view" ], "description": "Variation regular price.", "type": "string" }, "sale_price": { "context": [ "edit", "view" ], "description": "Variation sale price.", "type": "string" }, "shipping_class": { "context": [ "edit", "view" ], "description": "Shipping class slug.", "type": "string" }, "shipping_class_id": { "context": [ "edit", "view" ], "description": "Shipping class ID.", "readonly": true, "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Unique identifier.", "type": "string" }, "stock_quantity": { "context": [ "edit", "view" ], "description": "Stock quantity.", "type": "integer" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "type": "string" }, "virtual": { "context": [ "edit", "view" ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "description": "If the variation is visible.", "type": "boolean" }, "weight": { "context": [ "edit", "view" ], "description": "Variation weight (kg).", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "virtual": { "default": false, "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_on_sale_from": { "description": "Start date of sale price.", "required": false, "type": "string" }, "date_on_sale_to": { "description": "End data of sale price.", "required": false, "type": "string" }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "download_type": { "description": "Download type, this controls the schema on the front-end.", "enum": [ "standard" ], "required": false, "type": "string" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "required": false, "type": "boolean" }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variations": { "description": "List of variations.", "items": { "properties": { "attributes": { "context": [ "edit", "view" ], "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "type": "array" }, "backordered": { "context": [ "edit", "view" ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { "context": [ "edit", "view" ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "type": "string" }, "backorders_allowed": { "context": [ "edit", "view" ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_on_sale_from": { "context": [ "edit", "view" ], "description": "Start date of sale price.", "type": "string" }, "date_on_sale_to": { "context": [ "edit", "view" ], "description": "End data of sale price.", "type": "string" }, "dimensions": { "context": [ "edit", "view" ], "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "type": "object" }, "download_expiry": { "context": [ "edit", "view" ], "default": null, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { "context": [ "edit", "view" ], "default": null, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { "context": [ "edit", "view" ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { "context": [ "edit", "view" ], "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "context": [ "edit", "view" ], "description": "Variation ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "in_stock": { "context": [ "edit", "view" ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "context": [ "edit", "view" ], "default": false, "description": "Stock management at variation level.", "type": "boolean" }, "on_sale": { "context": [ "edit", "view" ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { "context": [ "edit", "view" ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { "context": [ "edit", "view" ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, "regular_price": { "context": [ "edit", "view" ], "description": "Variation regular price.", "type": "string" }, "sale_price": { "context": [ "edit", "view" ], "description": "Variation sale price.", "type": "string" }, "shipping_class": { "context": [ "edit", "view" ], "description": "Shipping class slug.", "type": "string" }, "shipping_class_id": { "context": [ "edit", "view" ], "description": "Shipping class ID.", "readonly": true, "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Unique identifier.", "type": "string" }, "stock_quantity": { "context": [ "edit", "view" ], "description": "Stock quantity.", "type": "integer" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "type": "string" }, "virtual": { "context": [ "edit", "view" ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "description": "If the variation is visible.", "type": "boolean" }, "weight": { "context": [ "edit", "view" ], "description": "Variation weight (kg).", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/(?P[\\d]+)/reviews": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "name": { "description": "Name of the reviewer.", "required": true, "type": "string" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "Review content.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/(?P[\\d]+)/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "email": { "description": "Reviewer email.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Reviewer name.", "required": false, "type": "string" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/attributes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "default": false, "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "order_by": { "default": "menu_order", "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "default": "select", "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/attributes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes/batch" } ] }, "endpoints": [ { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/batch" } ] }, "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_on_sale_from": { "description": "Start date of sale price.", "required": false, "type": "string" }, "date_on_sale_to": { "description": "End data of sale price.", "required": false, "type": "string" }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "download_type": { "description": "Download type, this controls the schema on the front-end.", "enum": [ "standard" ], "required": false, "type": "string" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "required": false, "type": "boolean" }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "variations": { "description": "List of variations.", "items": { "properties": { "attributes": { "context": [ "edit", "view" ], "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "type": "array" }, "backordered": { "context": [ "edit", "view" ], "description": "Shows if the variation is on back-order.", "readonly": true, "type": "boolean" }, "backorders": { "context": [ "edit", "view" ], "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "type": "string" }, "backorders_allowed": { "context": [ "edit", "view" ], "description": "Shows if back-orders are allowed.", "readonly": true, "type": "boolean" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the variation was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the variation was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_on_sale_from": { "context": [ "edit", "view" ], "description": "Start date of sale price.", "type": "string" }, "date_on_sale_to": { "context": [ "edit", "view" ], "description": "End data of sale price.", "type": "string" }, "dimensions": { "context": [ "edit", "view" ], "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "type": "object" }, "download_expiry": { "context": [ "edit", "view" ], "default": null, "description": "Number of days until access to downloadable files expires.", "type": "integer" }, "download_limit": { "context": [ "edit", "view" ], "default": null, "description": "Number of times downloadable files can be downloaded after purchase.", "type": "integer" }, "downloadable": { "context": [ "edit", "view" ], "default": false, "description": "If the variation is downloadable.", "type": "boolean" }, "downloads": { "context": [ "edit", "view" ], "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "context": [ "edit", "view" ], "description": "Variation ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "in_stock": { "context": [ "edit", "view" ], "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "type": "boolean" }, "manage_stock": { "context": [ "edit", "view" ], "default": false, "description": "Stock management at variation level.", "type": "boolean" }, "on_sale": { "context": [ "edit", "view" ], "description": "Shows if the variation is on sale.", "readonly": true, "type": "boolean" }, "permalink": { "context": [ "edit", "view" ], "description": "Variation URL.", "format": "uri", "readonly": true, "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Current variation price.", "readonly": true, "type": "string" }, "purchasable": { "context": [ "edit", "view" ], "description": "Shows if the variation can be bought.", "readonly": true, "type": "boolean" }, "regular_price": { "context": [ "edit", "view" ], "description": "Variation regular price.", "type": "string" }, "sale_price": { "context": [ "edit", "view" ], "description": "Variation sale price.", "type": "string" }, "shipping_class": { "context": [ "edit", "view" ], "description": "Shipping class slug.", "type": "string" }, "shipping_class_id": { "context": [ "edit", "view" ], "description": "Shipping class ID.", "readonly": true, "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Unique identifier.", "type": "string" }, "stock_quantity": { "context": [ "edit", "view" ], "description": "Stock quantity.", "type": "integer" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "type": "string" }, "virtual": { "context": [ "edit", "view" ], "default": false, "description": "If the variation is virtual.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "description": "If the variation is visible.", "type": "boolean" }, "weight": { "context": [ "edit", "view" ], "description": "Variation weight (kg).", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "default": "default", "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/categories/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/shipping_classes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/shipping_classes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/shipping_classes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/tags": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/products/tags/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tag name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/products/tags/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Tag name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/reports": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/reports/sales": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/sales" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "period": { "description": "Report period.", "enum": [ "last_month", "month", "week", "year" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/reports/top_sellers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/top_sellers" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "period": { "description": "Report period.", "enum": [ "last_month", "month", "week", "year" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/taxes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes" } ] }, "endpoints": [ { "args": { "class": { "description": "Sort by tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "city": { "description": "City name.", "required": false, "type": "string" }, "class": { "default": "standard", "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode / ZIP.", "required": false, "type": "string" }, "priority": { "default": 1, "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "city": { "description": "City name.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode / ZIP.", "required": false, "type": "string" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/taxes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/batch" } ] }, "endpoints": [ { "args": { "city": { "description": "City name.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode / ZIP.", "required": false, "type": "string" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/taxes/classes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/classes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/taxes/classes/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "slug": { "description": "Unique slug for the resource.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE" ], "namespace": "wc/v1" }, "/wc/v1/webhooks": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", "enum": [ "active", "all", "disabled", "paused" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "default": "active", "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v1" }, "/wc/v1/webhooks/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v1/webhooks/(?P[\\d]+)/deliveries": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "webhook_id": { "description": "Unique identifier for the webhook.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/webhooks/(?P[\\d]+)/deliveries/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "webhook_id": { "description": "Unique identifier for the webhook.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v1" }, "/wc/v1/webhooks/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks/batch" } ] }, "endpoints": [ { "args": { "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v1" }, "/wc/v2": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc/v2", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "code": { "description": "Limit result set to resources with a specific code.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": true, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/coupons/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons/batch" } ] }, "endpoints": [ { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/customers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "email": { "description": "Limit result set to resources with a specific email.", "format": "email", "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", "enum": [ "id", "include", "name", "registered_date" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "role": { "default": "customer", "description": "Limit result set to resources with a specific role.", "enum": [ "administrator", "all", "author", "contributor", "customer", "editor", "shop_manager", "subscriber" ], "required": false, "type": "string" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "New user email address.", "required": true, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "password": { "description": "New user password.", "required": true, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "New user username.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/customers/(?P[\\d]+)/downloads": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "customer_id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/customers/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "The email address for the customer.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "password": { "description": "Customer password.", "required": false, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "Customer login name.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "reassign": { "default": 0, "description": "ID to reassign posts to.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/customers/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "The email address for the customer.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "password": { "description": "Customer password.", "required": false, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "Customer login name.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/orders": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "required": false, "type": "integer" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "description": "Limit result set to orders assigned a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to orders assigned a specific status.", "enum": [ "any", "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "default": "pending", "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/orders/(?P[\\d]+)/notes": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "type": { "default": "any", "description": "Limit result to customers or internal notes.", "enum": [ "any", "customer", "internal" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "customer_note": { "default": false, "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "required": false, "type": "boolean" }, "note": { "description": "Order note content.", "required": true, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/orders/(?P[\\d]+)/notes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v2" }, "/wc/v2/orders/(?P[\\d]+)/refunds": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "Refund amount.", "required": false, "type": "string" }, "api_refund": { "default": true, "description": "When true, the payment gateway API is used to generate the refund.", "required": false, "type": "boolean" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "reason": { "description": "Reason for refund.", "required": false, "type": "string" }, "refunded_by": { "description": "User ID of user who created the refund.", "required": false, "type": "integer" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/orders/(?P[\\d]+)/refunds/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v2" }, "/wc/v2/orders/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/payment_gateways": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/payment_gateways" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/payment_gateways/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "Payment gateway description on checkout.", "required": false, "type": "string" }, "enabled": { "description": "Payment gateway enabled status.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" }, "order": { "description": "Payment gateway sort order.", "required": false, "type": "integer" }, "settings": { "description": "Payment gateway settings.", "properties": { "default": { "context": [ "edit", "view" ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { "context": [ "edit", "view" ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { "context": [ "edit", "view" ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { "context": [ "edit", "view" ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { "context": [ "edit", "view" ], "description": "Type of setting.", "enum": [ "checkbox", "color", "email", "image_width", "multiselect", "number", "password", "radio", "select", "text", "textarea" ], "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Setting value.", "type": "string" } }, "required": false, "type": "object" }, "title": { "description": "Payment gateway title on checkout.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "default": false, "description": "Featured product.", "required": false, "type": "boolean" }, "grouped_products": { "description": "List of grouped products ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "in_stock": { "default": true, "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "required": false, "type": "boolean" }, "manage_stock": { "default": false, "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "default": "publish", "description": "Product status (post status).", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "default": false, "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "grouped_products": { "description": "List of grouped products ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "required": false, "type": "boolean" }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)/reviews": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "name": { "description": "Name of the reviewer.", "required": true, "type": "string" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "Review content.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "email": { "description": "Reviewer email.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Reviewer name.", "required": false, "type": "string" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)/reviews/batch": { "endpoints": [ { "args": { "date_created": { "description": "The date the review was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the review was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "email": { "description": "Reviewer email.", "required": false, "type": "string" }, "name": { "description": "Reviewer name.", "required": false, "type": "string" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)/variations": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "in_stock": { "default": true, "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "required": false, "type": "boolean" }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "visible": { "default": true, "description": "Define if the variation is visible on the product's page.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)/variations/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "required": false, "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/(?P[\\d]+)/variations/batch": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "in_stock": { "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", "required": false, "type": "boolean" }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "visible": { "description": "Define if the variation is visible on the product's page.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/attributes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "default": false, "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "order_by": { "default": "menu_order", "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "default": "select", "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/attributes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes/batch" } ] }, "endpoints": [ { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/batch" } ] }, "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "grouped_products": { "description": "List of grouped products ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "position": { "context": [ "edit", "view" ], "description": "Image position. 0 means that the image is featured.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "in_stock": { "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", "required": false, "type": "boolean" }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Unique identifier.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "draft", "future", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "default": "default", "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/categories/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" }, "title": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/shipping_classes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/shipping_classes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/shipping_classes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/tags": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/products/tags/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tag name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/products/tags/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Tag name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/reports": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/reports/sales": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/sales" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "period": { "description": "Report period.", "enum": [ "last_month", "month", "week", "year" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/reports/top_sellers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/top_sellers" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "period": { "description": "Report period.", "enum": [ "last_month", "month", "week", "year" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/settings": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/settings" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/settings/(?P[\\w-]+)": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/settings/(?P[\\w-]+)/(?P[\\w-]+)": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/settings/(?P[\\w-]+)/batch": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/shipping/zones": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping/zones" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": { "name": { "description": "Shipping zone name.", "required": true, "type": "string" }, "order": { "description": "Shipping zone order.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/shipping/zones/(?P[\\d]+)": { "endpoints": [ { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" }, "name": { "description": "Shipping zone name.", "required": false, "type": "string" }, "order": { "description": "Shipping zone order.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/shipping/zones/(?P[\\d]+)/locations": { "endpoints": [ { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "code": { "description": "Shipping zone location code.", "required": false, "type": "string" }, "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" }, "type": { "description": "Shipping zone location type.", "enum": [ "continent", "country", "postcode", "state" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/shipping/zones/(?P[\\d]+)/methods": { "endpoints": [ { "args": { "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "enabled": { "description": "Shipping method enabled status.", "required": false, "type": "boolean" }, "method_id": { "description": "Shipping method ID.", "required": true }, "order": { "description": "Shipping method sort order.", "required": false, "type": "integer" }, "settings": { "description": "Shipping method settings.", "properties": { "default": { "context": [ "edit", "view" ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { "context": [ "edit", "view" ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { "context": [ "edit", "view" ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { "context": [ "edit", "view" ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { "context": [ "edit", "view" ], "description": "Type of setting.", "enum": [ "checkbox", "color", "email", "image_width", "multiselect", "number", "password", "radio", "select", "text", "textarea" ], "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Setting value.", "type": "string" } }, "required": false, "type": "object" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/shipping/zones/(?P[\\d]+)/methods/(?P[\\d]+)": { "endpoints": [ { "args": { "instance_id": { "description": "Unique ID for the instance.", "required": false, "type": "integer" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "enabled": { "description": "Shipping method enabled status.", "required": false, "type": "boolean" }, "instance_id": { "description": "Unique ID for the instance.", "required": false, "type": "integer" }, "order": { "description": "Shipping method sort order.", "required": false, "type": "integer" }, "settings": { "description": "Shipping method settings.", "properties": { "default": { "context": [ "edit", "view" ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { "context": [ "edit", "view" ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { "context": [ "edit", "view" ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { "context": [ "edit", "view" ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { "context": [ "edit", "view" ], "description": "Type of setting.", "enum": [ "checkbox", "color", "email", "image_width", "multiselect", "number", "password", "radio", "select", "text", "textarea" ], "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Setting value.", "type": "string" } }, "required": false, "type": "object" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "instance_id": { "description": "Unique ID for the instance.", "required": false, "type": "integer" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/shipping_methods": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping_methods" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/shipping_methods/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/system_status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/system_status/tools": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status/tools" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/system_status/tools/(?P[\\w-]+)": { "endpoints": [ { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "action": { "description": "What running the tool will do.", "required": false, "type": "string" }, "description": { "description": "Tool description.", "required": false, "type": "string" }, "id": { "description": "A unique identifier for the tool.", "required": false, "type": "string" }, "message": { "description": "Tool return message.", "required": false, "type": "string" }, "name": { "description": "Tool name.", "required": false, "type": "string" }, "success": { "description": "Did the tool run successfully?", "required": false, "type": "boolean" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/taxes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes" } ] }, "endpoints": [ { "args": { "class": { "description": "Sort by tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "city": { "description": "City name.", "required": false, "type": "string" }, "class": { "default": "standard", "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode / ZIP.", "required": false, "type": "string" }, "priority": { "default": 1, "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "city": { "description": "City name.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode / ZIP.", "required": false, "type": "string" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/taxes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/batch" } ] }, "endpoints": [ { "args": { "city": { "description": "City name.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode / ZIP.", "required": false, "type": "string" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/taxes/classes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/classes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/taxes/classes/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { "slug": { "description": "Unique slug for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "slug": { "description": "Unique slug for the resource.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v2" }, "/wc/v2/webhooks": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", "enum": [ "active", "all", "disabled", "paused" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "default": "active", "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v2" }, "/wc/v2/webhooks/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v2/webhooks/(?P[\\d]+)/deliveries": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "webhook_id": { "description": "Unique identifier for the webhook.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/webhooks/(?P[\\d]+)/deliveries/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "webhook_id": { "description": "Unique identifier for the webhook.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v2" }, "/wc/v2/webhooks/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks/batch" } ] }, "endpoints": [ { "args": { "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v2" }, "/wc/v3": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wc/v3", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/coupons": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "code": { "description": "Limit result set to resources with a specific code.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": true, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "default": "fixed_cart", "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "default": false, "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "default": false, "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "default": false, "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/coupons/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/coupons/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons/batch" } ] }, "endpoints": [ { "args": { "amount": { "description": "The amount of discount. Should always be numeric, even if setting a percentage.", "required": false, "type": "string" }, "code": { "description": "Coupon code.", "required": false, "type": "string" }, "date_expires": { "description": "The date the coupon expires, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_expires_gmt": { "description": "The date the coupon expires, as GMT.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Coupon description.", "required": false, "type": "string" }, "discount_type": { "description": "Determines the type of discount that will be applied.", "enum": [ "fixed_cart", "fixed_product", "percent" ], "required": false, "type": "string" }, "email_restrictions": { "description": "List of email addresses that can use this coupon.", "items": { "type": "string" }, "required": false, "type": "array" }, "exclude_sale_items": { "description": "If true, this coupon will not be applied to items that have sale prices.", "required": false, "type": "boolean" }, "excluded_product_categories": { "description": "List of category IDs the coupon does not apply to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "excluded_product_ids": { "description": "List of product IDs the coupon cannot be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "free_shipping": { "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", "required": false, "type": "boolean" }, "individual_use": { "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", "required": false, "type": "boolean" }, "limit_usage_to_x_items": { "description": "Max number of items in the basket the coupon can be applied to.", "required": false, "type": "integer" }, "maximum_amount": { "description": "Maximum order amount allowed when using the coupon.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "minimum_amount": { "description": "Minimum order amount that needs to be in the basket before coupon applies.", "required": false, "type": "string" }, "product_categories": { "description": "List of category IDs the coupon applies to.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_ids": { "description": "List of product IDs the coupon can be used on.", "items": { "type": "integer" }, "required": false, "type": "array" }, "status": { "description": "The status of the coupon. Should always be draft, published, or pending review", "required": false, "type": "string" }, "usage_limit": { "description": "How many times the coupon can be used in total.", "required": false, "type": "integer" }, "usage_limit_per_user": { "description": "How many times the coupon can be used per customer.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/customers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "email": { "description": "Limit result set to resources with a specific email.", "format": "email", "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by object attribute.", "enum": [ "id", "include", "name", "registered_date" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "role": { "default": "customer", "description": "Limit result set to resources with a specific role.", "enum": [ "administrator", "all", "author", "contributor", "customer", "editor", "shop_manager", "subscriber" ], "required": false, "type": "string" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "New user email address.", "required": true, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "password": { "description": "New user password.", "required": true, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "New user username.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/customers/(?P[\\d]+)/downloads": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "customer_id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/customers/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "The email address for the customer.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "password": { "description": "Customer password.", "required": false, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "Customer login name.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "reassign": { "default": 0, "description": "ID to reassign posts to.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/customers/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "List of billing address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "email": { "description": "The email address for the customer.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "Customer first name.", "required": false, "type": "string" }, "last_name": { "description": "Customer last name.", "required": false, "type": "string" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "password": { "description": "Customer password.", "required": false, "type": "string" }, "shipping": { "description": "List of shipping address data.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "ISO code of the country.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "username": { "description": "Customer login name.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/data": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/continents": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/continents" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/continents/(?P[\\w-]+)": { "endpoints": [ { "args": { "continent": { "description": "2 character continent code.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/countries": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/countries" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/countries/(?P[\\w-]+)": { "endpoints": [ { "args": { "location": { "description": "ISO3166 alpha-2 country code.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/currencies": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/currencies/(?P[\\w-]{3})": { "endpoints": [ { "args": { "location": { "description": "ISO4217 currency code.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/data/currencies/current": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies/current" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/layout-templates": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/layout-templates" } ] }, "endpoints": [ { "args": { "area": { "default": "", "description": "Area to get templates for.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/layout-templates/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/create-order": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/create-order" } ] }, "endpoints": [ { "args": { "product_id": { "required": true } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/featured": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/featured" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/refresh": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/refresh" } ] }, "endpoints": [ { "args": [], "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/activate": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/activate" } ] }, "endpoints": [ { "args": { "product_key": { "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/connect": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/connect" } ] }, "endpoints": [ { "args": { "product_key": { "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/disconnect": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/disconnect" } ] }, "endpoints": [ { "args": { "product_key": { "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/marketplace/subscriptions/install-url": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/install-url" } ] }, "endpoints": [ { "args": { "product_key": { "required": true, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/orders": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "customer": { "description": "Limit result set to orders assigned a specific customer.", "required": false, "type": "integer" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "description": "Limit result set to orders assigned a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to orders which have specific statuses.", "items": { "enum": [ "any", "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded", "trash" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "default": "EUR", "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "default": 0, "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "default": false, "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "default": false, "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "default": "pending", "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/orders/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/orders/(?P[\\d]+)/receipt": { "endpoints": [ { "args": { "expiration_date": { "default": null, "description": "Expiration date formatted as dd-mm-yyyy.", "required": false, "type": "string" }, "expiration_days": { "default": 1, "description": "Number of days to be added to the current date to get the expiration date.", "required": false, "type": "integer" }, "force_new": { "default": false, "description": "True to force the creation of a new receipt even if one already exists and has not expired yet.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier of the order.", "required": false, "type": "integer" } }, "methods": [ "POST" ] }, { "args": { "id": { "description": "Unique identifier of the order.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/orders/(?P[\\d]+)/notes": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "type": { "default": "any", "description": "Limit result to customers or internal notes.", "enum": [ "any", "customer", "internal" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "added_by_user": { "default": false, "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.", "required": false, "type": "boolean" }, "customer_note": { "default": false, "description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.", "required": false, "type": "boolean" }, "note": { "description": "Order note content.", "required": true, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/orders/(?P[\\d]+)/notes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v3" }, "/wc/v3/orders/(?P[\\d]+)/refunds": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "amount": { "description": "Refund amount.", "required": false, "type": "string" }, "api_refund": { "default": true, "description": "When true, the payment gateway API is used to generate the refund.", "required": false, "type": "boolean" }, "api_restock": { "default": true, "description": "When true, refunded items are restocked.", "required": false, "type": "boolean" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" }, "reason": { "description": "Reason for refund.", "required": false, "type": "string" }, "refunded_by": { "description": "User ID of user who created the refund.", "required": false, "type": "integer" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/orders/(?P[\\d]+)/refunds/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "order_id": { "description": "The order ID.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v3" }, "/wc/v3/orders/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders/batch" } ] }, "endpoints": [ { "args": { "billing": { "description": "Billing address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "email": { "context": [ "edit", "view" ], "description": "Email address.", "format": "email", "type": [ "null", "string" ] }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "phone": { "context": [ "edit", "view" ], "description": "Phone number.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "coupon_lines": { "description": "Coupons line data.", "items": { "properties": { "code": { "context": [ "edit", "view" ], "description": "Coupon code.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "discount": { "context": [ "edit", "view" ], "description": "Discount total.", "readonly": true, "type": "string" }, "discount_tax": { "context": [ "edit", "view" ], "description": "Discount total tax.", "readonly": true, "type": "string" }, "discount_type": { "context": [ "view" ], "description": "Discount type.", "readonly": true, "type": "string" }, "free_shipping": { "context": [ "view" ], "description": "Whether the coupon grants free shipping or not.", "readonly": true, "type": "boolean" }, "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "nominal_amount": { "context": [ "view" ], "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", "readonly": true, "type": "number" } }, "type": "object" }, "required": false, "type": "array" }, "currency": { "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "IRT", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PRB", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ], "required": false, "type": "string" }, "customer_id": { "description": "User ID who owns the order. 0 for guests.", "required": false, "type": "integer" }, "customer_note": { "description": "Note left by customer during checkout.", "required": false, "type": "string" }, "fee_lines": { "description": "Fee lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Fee name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of fee.", "type": "string" }, "tax_status": { "context": [ "edit", "view" ], "description": "Tax status of fee.", "enum": [ "none", "taxable" ], "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "readonly": true, "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "line_items": { "description": "Line items data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "image": { "context": [ "edit", "view" ], "description": "Properties of the main product image.", "properties": { "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "readonly": true, "type": "object" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "display_key": { "context": [ "edit", "view" ], "description": "Meta key for UI display.", "type": "string" }, "display_value": { "context": [ "edit", "view" ], "description": "Meta value for UI display.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "name": { "context": [ "edit", "view" ], "description": "Product name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "parent_name": { "context": [ "edit", "view" ], "description": "Parent product name if the product is a variation.", "type": "string" }, "price": { "context": [ "edit", "view" ], "description": "Product price.", "readonly": true, "type": "number" }, "product_id": { "context": [ "edit", "view" ], "description": "Product ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "quantity": { "context": [ "edit", "view" ], "description": "Quantity ordered.", "type": "integer" }, "sku": { "context": [ "edit", "view" ], "description": "Product SKU.", "readonly": true, "type": "string" }, "subtotal": { "context": [ "edit", "view" ], "description": "Line subtotal (before discounts).", "type": "string" }, "subtotal_tax": { "context": [ "edit", "view" ], "description": "Line subtotal tax (before discounts).", "readonly": true, "type": "string" }, "tax_class": { "context": [ "edit", "view" ], "description": "Tax class of product.", "type": "string" }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "type": "integer" }, "subtotal": { "context": [ "edit", "view" ], "description": "Tax subtotal.", "type": "string" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" }, "variation_id": { "context": [ "edit", "view" ], "description": "Variation ID, if applicable.", "type": "integer" } }, "type": "object" }, "required": false, "type": "array" }, "manual_update": { "description": "Set the action as manual so that the order note registers as \"added by user\".", "required": false, "type": "boolean" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "parent_id": { "description": "Parent order ID.", "required": false, "type": "integer" }, "payment_method": { "description": "Payment method ID.", "required": false, "type": "string" }, "payment_method_title": { "description": "Payment method title.", "required": false, "type": "string" }, "set_paid": { "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", "required": false, "type": "boolean" }, "shipping": { "description": "Shipping address.", "properties": { "address_1": { "context": [ "edit", "view" ], "description": "Address line 1", "type": "string" }, "address_2": { "context": [ "edit", "view" ], "description": "Address line 2", "type": "string" }, "city": { "context": [ "edit", "view" ], "description": "City name.", "type": "string" }, "company": { "context": [ "edit", "view" ], "description": "Company name.", "type": "string" }, "country": { "context": [ "edit", "view" ], "description": "Country code in ISO 3166-1 alpha-2 format.", "type": "string" }, "first_name": { "context": [ "edit", "view" ], "description": "First name.", "type": "string" }, "last_name": { "context": [ "edit", "view" ], "description": "Last name.", "type": "string" }, "postcode": { "context": [ "edit", "view" ], "description": "Postal code.", "type": "string" }, "state": { "context": [ "edit", "view" ], "description": "ISO code or name of the county, state, province or district.", "type": "string" } }, "required": false, "type": "object" }, "shipping_lines": { "description": "Shipping lines data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Item ID.", "readonly": true, "type": "integer" }, "instance_id": { "context": [ "edit", "view" ], "description": "Shipping instance ID.", "type": "string" }, "meta_data": { "context": [ "edit", "view" ], "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "type": "array" }, "method_id": { "context": [ "edit", "view" ], "description": "Shipping method ID.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "method_title": { "context": [ "edit", "view" ], "description": "Shipping method name.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] }, "taxes": { "context": [ "edit", "view" ], "description": "Line taxes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tax rate ID", "readonly": true, "type": "integer" }, "total": { "context": [ "edit", "view" ], "description": "Tax total.", "readonly": true, "type": "string" } }, "type": "object" }, "readonly": true, "type": "array" }, "total": { "context": [ "edit", "view" ], "description": "Line total (after discounts).", "type": "string" }, "total_tax": { "context": [ "edit", "view" ], "description": "Line total tax (after discounts).", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "status": { "description": "Order status.", "enum": [ "auto-draft", "cancelled", "checkout-draft", "completed", "failed", "on-hold", "pending", "processing", "refunded" ], "required": false, "type": "string" }, "transaction_id": { "description": "Unique transaction ID.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/payment_gateways": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/payment_gateways" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/payment_gateways/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "Payment gateway description on checkout.", "required": false, "type": "string" }, "enabled": { "description": "Payment gateway enabled status.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" }, "order": { "description": "Payment gateway sort order.", "required": false, "type": "integer" }, "settings": { "description": "Payment gateway settings.", "properties": { "default": { "context": [ "edit", "view" ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { "context": [ "edit", "view" ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { "context": [ "edit", "view" ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { "context": [ "edit", "view" ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { "context": [ "edit", "view" ], "description": "Type of setting.", "enum": [ "checkbox", "color", "email", "image_width", "multiselect", "number", "password", "radio", "select", "text", "textarea" ], "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Setting value.", "type": "string" } }, "required": false, "type": "object" }, "title": { "description": "Payment gateway title on checkout.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "popularity", "price", "rating", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_sku": { "description": "Limit results to those with a SKU that partially matches a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "default": "visible", "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "default": false, "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "default": true, "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "default": false, "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "default": "publish", "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "default": "simple", "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "default": false, "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/(?P[\\d]+)/duplicate": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/(?P[\\d]+)/variations": { "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attributes": { "description": "Limit result set to products with specified attributes.", "items": { "properties": { "attribute": { "description": "Attribute slug.", "type": "string" }, "term": { "description": "Attribute term.", "type": "string" }, "terms": { "description": "Attribute terms.", "type": "array" } }, "type": "object" }, "required": false, "type": "array" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "has_price": { "description": "Limit result set to products with or without price.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_status": { "description": "Limit result set to products with specified stock status.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/(?P[\\d]+)/variations/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the variation.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/(?P[\\d]+)/variations/batch": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/(?P[\\d]+)/variations/generate": { "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "default": "no", "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_values": { "description": "Default values for generated variations.", "properties": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "null", "string" ], "validate_callback": "rest_validate_request_arg" }, "description": { "description": "Variation description.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "downloadable": { "description": "If the variation is downloadable.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "sanitize_callback": "rest_sanitize_request_arg", "type": "object", "validate_callback": "rest_validate_request_arg" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "sanitize_callback": "rest_sanitize_request_arg", "type": [ "integer", "null" ], "validate_callback": "rest_validate_request_arg" }, "manage_stock": { "description": "Stock management at variation level.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "menu_order": { "description": "Menu order, used to custom sort products.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "sanitize_callback": "rest_sanitize_request_arg", "type": "array", "validate_callback": "rest_validate_request_arg" }, "regular_price": { "description": "Variation regular price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sale_price": { "description": "Variation sale price.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "shipping_class": { "description": "Shipping class slug.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "sku": { "description": "Stock Keeping Unit.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "status": { "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "stock_quantity": { "description": "Stock quantity.", "sanitize_callback": "rest_sanitize_request_arg", "type": "integer", "validate_callback": "rest_validate_request_arg" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_class": { "description": "Tax class.", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" }, "virtual": { "description": "If the variation is virtual.", "sanitize_callback": "rest_sanitize_request_arg", "type": "boolean", "validate_callback": "rest_validate_request_arg" }, "weight": { "description": "Variation weight (kg).", "sanitize_callback": "rest_sanitize_request_arg", "type": "string", "validate_callback": "rest_validate_request_arg" } }, "required": false, "type": "object" }, "delete": { "description": "Deletes unused variations.", "required": false, "type": "boolean" }, "description": { "description": "Variation description.", "required": false, "type": "string" }, "dimensions": { "description": "Variation dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Variation height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Variation length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Variation width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "default": -1, "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "default": -1, "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "default": false, "description": "If the variation is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "image": { "description": "Variation image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "low_stock_amount": { "description": "Low Stock amount for the variation.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "default": false, "description": "Stock management at variation level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "product_id": { "description": "Unique identifier for the variable product.", "required": false, "type": "integer" }, "regular_price": { "description": "Variation regular price.", "required": false, "type": "string" }, "sale_price": { "description": "Variation sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "status": { "default": "publish", "description": "Variation status.", "enum": [ "draft", "pending", "private", "publish" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "default": "instock", "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "default": "taxable", "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "virtual": { "default": false, "description": "If the variation is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Variation weight (kg).", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/attributes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "default": false, "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "order_by": { "default": "menu_order", "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "default": "select", "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/attributes/(?P[\\d]+)/terms": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/attributes/(?P[\\d]+)/terms/batch": { "endpoints": [ { "args": { "attribute_id": { "description": "Unique identifier for the attribute of the terms.", "required": false, "type": "integer" }, "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Term name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/attributes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": true, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/attributes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes/batch" } ] }, "endpoints": [ { "args": { "has_archives": { "description": "Enable/Disable attribute archives.", "required": false, "type": "boolean" }, "name": { "description": "Attribute name.", "required": false, "type": "string" }, "order_by": { "description": "Default sort order.", "enum": [ "id", "menu_order", "name", "name_num" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" }, "type": { "description": "Type of attribute.", "enum": [ "select" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/batch" } ] }, "endpoints": [ { "args": { "attributes": { "description": "List of attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "options": { "context": [ "edit", "view" ], "description": "List of available term names of the attribute.", "items": { "type": "string" }, "type": "array" }, "position": { "context": [ "edit", "view" ], "description": "Attribute position.", "type": "integer" }, "variation": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute can be used as variation.", "type": "boolean" }, "visible": { "context": [ "edit", "view" ], "default": false, "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", "type": "boolean" } }, "type": "object" }, "required": false, "type": "array" }, "backorders": { "description": "If managing stock, this controls if back-orders are allowed.", "enum": [ "no", "notify", "yes" ], "required": false, "type": "string" }, "button_text": { "description": "Product external button text. Only for external products.", "required": false, "type": "string" }, "catalog_visibility": { "description": "Catalogue visibility.", "enum": [ "catalog", "hidden", "search", "visible" ], "required": false, "type": "string" }, "categories": { "description": "List of categories.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Category ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Category name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Category slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "cross_sell_ids": { "description": "List of cross-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "date_created": { "description": "The date the product was created, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_created_gmt": { "description": "The date the product was created, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from": { "description": "Start date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_from_gmt": { "description": "Start date of sale price, as GMT.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "date_on_sale_to_gmt": { "description": "End date of sale price, in the site's timezone.", "required": false, "type": [ "null", "string" ] }, "default_attributes": { "description": "Defaults variation attributes.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Attribute ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Attribute name.", "type": "string" }, "option": { "context": [ "edit", "view" ], "description": "Selected attribute term name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "description": { "description": "Product description.", "required": false, "type": "string" }, "dimensions": { "description": "Product dimensions.", "properties": { "height": { "context": [ "edit", "view" ], "description": "Product height (cm).", "type": "string" }, "length": { "context": [ "edit", "view" ], "description": "Product length (cm).", "type": "string" }, "width": { "context": [ "edit", "view" ], "description": "Product width (cm).", "type": "string" } }, "required": false, "type": "object" }, "download_expiry": { "description": "Number of days until access to downloadable files expires.", "required": false, "type": "integer" }, "download_limit": { "description": "Number of times downloadable files can be downloaded after purchase.", "required": false, "type": "integer" }, "downloadable": { "description": "If the product is downloadable.", "required": false, "type": "boolean" }, "downloads": { "description": "List of downloadable files.", "items": { "properties": { "file": { "context": [ "edit", "view" ], "description": "File URL.", "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "File ID.", "type": "string" }, "name": { "context": [ "edit", "view" ], "description": "File name.", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "external_url": { "description": "Product external URL. Only for external products.", "format": "uri", "required": false, "type": "string" }, "featured": { "description": "Featured product.", "required": false, "type": "boolean" }, "global_unique_id": { "description": "GTIN, UPC, EAN or ISBN.", "required": false, "type": "string" }, "images": { "description": "List of images.", "items": { "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "low_stock_amount": { "description": "Low Stock amount for the product.", "required": false, "type": [ "integer", "null" ] }, "manage_stock": { "description": "Stock management at product level.", "required": false, "type": "boolean" }, "menu_order": { "description": "Menu order, used to custom sort products.", "required": false, "type": "integer" }, "meta_data": { "description": "Meta data.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Meta ID.", "readonly": true, "type": "integer" }, "key": { "context": [ "edit", "view" ], "description": "Meta key.", "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Meta value.", "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "type": "object" }, "required": false, "type": "array" }, "name": { "description": "Product name.", "required": false, "type": "string" }, "parent_id": { "description": "Product parent ID.", "required": false, "type": "integer" }, "post_password": { "description": "Post password.", "required": false, "type": "string" }, "purchase_note": { "description": "Optional note to send the customer after purchase.", "required": false, "type": "string" }, "regular_price": { "description": "Product regular price.", "required": false, "type": "string" }, "reviews_allowed": { "description": "Allow reviews.", "required": false, "type": "boolean" }, "sale_price": { "description": "Product sale price.", "required": false, "type": "string" }, "shipping_class": { "description": "Shipping class slug.", "required": false, "type": "string" }, "short_description": { "description": "Product short description.", "required": false, "type": "string" }, "sku": { "description": "Stock Keeping Unit.", "required": false, "type": "string" }, "slug": { "description": "Product slug.", "required": false, "type": "string" }, "sold_individually": { "description": "Allow one item to be bought in a single order.", "required": false, "type": "boolean" }, "status": { "description": "Product status (post status).", "enum": [ "auto-draft", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "stock_quantity": { "description": "Stock quantity.", "required": false, "type": "integer" }, "stock_status": { "description": "Controls the stock status of the product.", "enum": [ "instock", "onbackorder", "outofstock" ], "required": false, "type": "string" }, "tags": { "description": "List of tags.", "items": { "properties": { "id": { "context": [ "edit", "view" ], "description": "Tag ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Tag name.", "readonly": true, "type": "string" }, "slug": { "context": [ "edit", "view" ], "description": "Tag slug.", "readonly": true, "type": "string" } }, "type": "object" }, "required": false, "type": "array" }, "tax_class": { "description": "Tax class.", "required": false, "type": "string" }, "tax_status": { "description": "Tax status.", "enum": [ "none", "shipping", "taxable" ], "required": false, "type": "string" }, "type": { "description": "Product type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" }, "upsell_ids": { "description": "List of up-sell products IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "virtual": { "description": "If the product is virtual.", "required": false, "type": "boolean" }, "weight": { "description": "Product weight (kg).", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "default": "default", "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/categories/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/categories/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "display": { "description": "Category archive display type.", "enum": [ "both", "default", "products", "subcategories" ], "required": false, "type": "string" }, "image": { "description": "Image data.", "properties": { "alt": { "context": [ "edit", "view" ], "description": "Image alternative text.", "type": "string" }, "date_created": { "context": [ "edit", "view" ], "description": "The date the image was created, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_created_gmt": { "context": [ "edit", "view" ], "description": "The date the image was created, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "date_modified": { "context": [ "edit", "view" ], "description": "The date the image was last modified, in the site's timezone.", "readonly": true, "type": [ "null", "string" ] }, "date_modified_gmt": { "context": [ "edit", "view" ], "description": "The date the image was last modified, as GMT.", "readonly": true, "type": [ "null", "string" ] }, "id": { "context": [ "edit", "view" ], "description": "Image ID.", "type": "integer" }, "name": { "context": [ "edit", "view" ], "description": "Image name.", "type": "string" }, "src": { "context": [ "edit", "view" ], "description": "Image URL.", "format": "uri", "type": "string" } }, "required": false, "type": "object" }, "menu_order": { "description": "Menu order, used to custom sort the resource.", "required": false, "type": "integer" }, "name": { "description": "Category name.", "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the resource.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/custom-fields/names": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/custom-fields/names" } ] }, "endpoints": [ { "args": { "context": { "description": "Scope under which the request is made; determines fields present in response.", "required": false, "type": "string" }, "order": { "default": "asc", "description": "Order sort items ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/products/reviews": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to reviews published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by object attribute.", "enum": [ "date", "date_gmt", "id", "include", "product" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": [], "description": "Limit result set to reviews assigned to specific product IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "reviewer": { "description": "Limit result set to reviews assigned to specific user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "reviewer_email": { "default": null, "description": "Limit result set to that from a specific author email.", "format": "email", "required": false, "type": "string" }, "reviewer_exclude": { "description": "Ensure result set excludes reviews assigned to specific user IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "approved", "description": "Limit result set to reviews assigned a specific status.", "enum": [ "all", "approved", "hold", "spam", "trash" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "product_id": { "description": "Unique identifier for the product.", "required": true, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "Review content.", "required": true, "type": "string" }, "reviewer": { "description": "Name of the reviewer.", "required": true, "type": "string" }, "reviewer_email": { "description": "Email of the reviewer.", "required": true, "type": "string" }, "status": { "default": "approved", "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/reviews/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "product_id": { "description": "Unique identifier for the product that the review belongs to.", "required": false, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" }, "reviewer": { "description": "Reviewer name.", "required": false, "type": "string" }, "reviewer_email": { "description": "Reviewer email.", "format": "email", "required": false, "type": "string" }, "status": { "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/reviews/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews/batch" } ] }, "endpoints": [ { "args": { "product_id": { "description": "Unique identifier for the product that the review belongs to.", "required": false, "type": "integer" }, "product_name": { "description": "Product name.", "required": false, "type": "string" }, "rating": { "description": "Review rating (0 to 5).", "required": false, "type": "integer" }, "review": { "description": "The content of the review.", "required": false, "type": "string" }, "reviewer": { "description": "Reviewer name.", "required": false, "type": "string" }, "reviewer_email": { "description": "Reviewer email.", "format": "email", "required": false, "type": "string" }, "status": { "description": "Status of the review.", "enum": [ "approved", "hold", "spam", "trash", "unspam", "untrash" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/shipping_classes/slug-suggestion": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/slug-suggestion" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Shipping class name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/products/suggested-products": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/suggested-products" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "attribute": { "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", "required": false, "type": "string" }, "attribute_term": { "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "default": [], "description": "Limit result set to specific product categorie ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "category": { "description": "Limit result set to products assigned a specific category ID.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "featured": { "description": "Limit result set to featured products.", "required": false, "type": "boolean" }, "in_stock": { "description": "Limit result set to products in stock or out of stock.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "limit": { "default": 5, "description": "Limit result set to specific amount of suggested products.", "required": false, "type": "integer" }, "max_price": { "description": "Limit result set to products based on a maximum price.", "required": false, "type": "string" }, "min_price": { "description": "Limit result set to products based on a minimum price.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "on_sale": { "description": "Limit result set to products on sale.", "required": false, "type": "boolean" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "menu_order", "modified", "popularity", "popularity", "rating", "rating", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "shipping_class": { "description": "Limit result set to products assigned a specific shipping class ID.", "required": false, "type": "string" }, "sku": { "description": "Limit result set to products with specific SKU(s). Use commas to separate.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to products with a specific slug.", "required": false, "type": "string" }, "status": { "default": "any", "description": "Limit result set to products assigned a specific status.", "enum": [ "any", "draft", "future", "pending", "private", "publish", "trash" ], "required": false, "type": "string" }, "tag": { "description": "Limit result set to products assigned a specific tag ID.", "required": false, "type": "string" }, "tags": { "default": [], "description": "Limit result set to specific product tag ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "type": { "description": "Limit result set to products assigned a specific type.", "enum": [ "external", "grouped", "simple", "variable" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/products/tags": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide resources not assigned to any products.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by resource attribute.", "enum": [ "count", "description", "id", "include", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product": { "default": null, "description": "Limit result set to resources assigned to a specific product.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to resources with a specific slug.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Name for the resource.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/products/tags/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tag name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/products/tags/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags/batch" } ] }, "endpoints": [ { "args": { "description": { "description": "HTML description of the resource.", "required": false, "type": "string" }, "name": { "description": "Tag name.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the resource unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/refunds": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/refunds" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "dates_are_gmt": { "default": false, "description": "Whether to consider GMT post dates when limiting response by published or modified date.", "required": false, "type": "boolean" }, "dp": { "default": 2, "description": "Number of decimal points to use in each resource.", "required": false, "type": "integer" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "exclude_meta": { "default": [], "description": "Ensure meta_data excludes specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include_meta": { "default": [], "description": "Limit meta_data to specific keys.", "items": { "type": "string" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to resources modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to resources modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "order_item_display_meta": { "default": false, "description": "Only show meta which is meant to be displayed for an order.", "required": false, "type": "boolean" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "modified", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to those of particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/coupons/totals": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/coupons/totals" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/customers/totals": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/customers/totals" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/orders/totals": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/orders/totals" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/products/totals": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/products/totals" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/reviews/totals": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/reviews/totals" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/sales": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/sales" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "period": { "description": "Report period.", "enum": [ "last_month", "month", "week", "year" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/reports/top_sellers": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/top_sellers" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "date_max": { "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "date_min": { "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", "format": "date", "required": false, "type": "string" }, "period": { "description": "Report period.", "enum": [ "last_month", "month", "week", "year" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/settings": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/settings/(?P[\\w-]+)": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/settings/(?P[\\w-]+)/(?P[\\w-]+)": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/settings/(?P[\\w-]+)/batch": { "endpoints": [ { "args": { "group": { "description": "Settings group ID.", "required": false, "type": "string" }, "value": { "description": "Setting value.", "required": false, "type": [ "array", "boolean", "integer", "null", "number", "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/settings/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings/batch" } ] }, "endpoints": [ { "args": [], "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/shipping/zones": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping/zones" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": { "name": { "description": "Shipping zone name.", "required": true, "type": "string" }, "order": { "description": "Shipping zone order.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/shipping/zones/(?P[\\d]+)": { "endpoints": [ { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" }, "name": { "description": "Shipping zone name.", "required": false, "type": "string" }, "order": { "description": "Shipping zone order.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/shipping/zones/(?P[\\d]+)/locations": { "endpoints": [ { "args": { "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "code": { "description": "Shipping zone location code.", "required": false, "type": "string" }, "id": { "description": "Unique ID for the resource.", "required": false, "type": "integer" }, "type": { "description": "Shipping zone location type.", "enum": [ "continent", "country", "postcode", "state" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/shipping/zones/(?P[\\d]+)/methods": { "endpoints": [ { "args": { "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "enabled": { "description": "Shipping method enabled status.", "required": false, "type": "boolean" }, "method_id": { "description": "Shipping method ID.", "required": true }, "order": { "description": "Shipping method sort order.", "required": false, "type": "integer" }, "settings": { "description": "Shipping method settings.", "properties": { "default": { "context": [ "edit", "view" ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { "context": [ "edit", "view" ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { "context": [ "edit", "view" ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { "context": [ "edit", "view" ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { "context": [ "edit", "view" ], "description": "Type of setting.", "enum": [ "checkbox", "class", "color", "email", "image_width", "multiselect", "number", "order", "password", "radio", "select", "text", "textarea" ], "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Setting value.", "type": "string" } }, "required": false, "type": "object" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/shipping/zones/(?P[\\d]+)/methods/(?P[\\d]+)": { "endpoints": [ { "args": { "instance_id": { "description": "Unique ID for the instance.", "required": false, "type": "integer" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "enabled": { "description": "Shipping method enabled status.", "required": false, "type": "boolean" }, "instance_id": { "description": "Unique ID for the instance.", "required": false, "type": "integer" }, "order": { "description": "Shipping method sort order.", "required": false, "type": "integer" }, "settings": { "description": "Shipping method settings.", "properties": { "default": { "context": [ "edit", "view" ], "description": "Default value for the setting.", "readonly": true, "type": "string" }, "description": { "context": [ "edit", "view" ], "description": "A human readable description for the setting used in interfaces.", "readonly": true, "type": "string" }, "id": { "context": [ "edit", "view" ], "description": "A unique identifier for the setting.", "readonly": true, "type": "string" }, "label": { "context": [ "edit", "view" ], "description": "A human readable label for the setting used in interfaces.", "readonly": true, "type": "string" }, "placeholder": { "context": [ "edit", "view" ], "description": "Placeholder text to be displayed in text inputs.", "readonly": true, "type": "string" }, "tip": { "context": [ "edit", "view" ], "description": "Additional help text shown to the user about the setting.", "readonly": true, "type": "string" }, "type": { "context": [ "edit", "view" ], "description": "Type of setting.", "enum": [ "checkbox", "class", "color", "email", "image_width", "multiselect", "number", "order", "password", "radio", "select", "text", "textarea" ], "readonly": true, "type": "string" }, "value": { "context": [ "edit", "view" ], "description": "Setting value.", "type": "string" } }, "required": false, "type": "object" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass bin and force deletion.", "required": false, "type": "boolean" }, "instance_id": { "description": "Unique ID for the instance.", "required": false, "type": "integer" }, "zone_id": { "description": "Unique ID for the zone.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/shipping_methods": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping_methods" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/shipping_methods/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/system_status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/system_status/tools": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status/tools" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wc/v3" }, "/wc/v3/system_status/tools/(?P[\\w-]+)": { "endpoints": [ { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "action": { "description": "What running the tool will do.", "required": false, "type": "string" }, "description": { "description": "Tool description.", "required": false, "type": "string" }, "id": { "description": "A unique identifier for the tool.", "required": false, "type": "string" }, "message": { "description": "Tool return message.", "required": false, "type": "string" }, "name": { "description": "Tool name.", "required": false, "type": "string" }, "success": { "description": "Did the tool run successfully?", "required": false, "type": "boolean" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/taxes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes" } ] }, "endpoints": [ { "args": { "class": { "description": "Sort by tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "order", "description": "Sort collection by object attribute.", "enum": [ "id", "order", "priority" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "default": "standard", "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "default": false, "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "default": 1, "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "default": true, "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/taxes/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/taxes/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/batch" } ] }, "endpoints": [ { "args": { "cities": { "description": "List of city names. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "city": { "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", "required": false, "type": "string" }, "class": { "description": "Tax class.", "enum": [ "reduced-rate", "standard", "zero-rate" ], "required": false, "type": "string" }, "compound": { "description": "Whether or not this is a compound rate.", "required": false, "type": "boolean" }, "country": { "description": "Country ISO 3166 code.", "required": false, "type": "string" }, "name": { "description": "Tax rate name.", "required": false, "type": "string" }, "order": { "description": "Indicates the order that will appear in queries.", "required": false, "type": "integer" }, "postcode": { "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", "required": false, "type": "string" }, "postcodes": { "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", "items": { "type": "string" }, "required": false, "type": "array" }, "priority": { "description": "Tax priority.", "required": false, "type": "integer" }, "rate": { "description": "Tax rate.", "required": false, "type": "string" }, "shipping": { "description": "Whether or not this tax rate also gets applied to shipping.", "required": false, "type": "boolean" }, "state": { "description": "State code.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/taxes/classes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/classes" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "name": { "description": "Tax class name.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/taxes/classes/(?P\\w[\\w\\s\\-]*)": { "endpoints": [ { "args": { "slug": { "description": "Unique slug for the resource.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "slug": { "description": "Unique slug for the resource.", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wc/v3" }, "/wc/v3/webhooks": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to resources published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to resources published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific ids.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "all", "description": "Limit result set to webhooks assigned a specific status.", "enum": [ "active", "all", "disabled", "paused" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "delivery_url": { "description": "Webhook delivery URL.", "required": true, "type": "string" }, "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "default": "active", "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wc/v3" }, "/wc/v3/webhooks/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" }, "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as resource does not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the resource.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wc/v3/webhooks/batch": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks/batch" } ] }, "endpoints": [ { "args": { "name": { "description": "A friendly name for the webhook.", "required": false, "type": "string" }, "secret": { "description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.", "required": false, "type": "string" }, "status": { "description": "Webhook status.", "enum": [ "active", "disabled", "paused" ], "required": false, "type": "string" }, "topic": { "description": "Webhook topic.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wc/v3" }, "/wccom-site/v3": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wccom-site/v3", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/installer": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer" } ] }, "endpoints": [ { "args": { "idempotency-key": { "required": true, "type": "string" }, "product-id": { "required": true, "type": "integer" }, "run-until-step": { "enum": [ "activate_product", "download_product", "get_product_info", "move_product", "unpack_product" ], "required": true, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/installer/reset": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer/reset" } ] }, "endpoints": [ { "args": { "idempotency-key": { "required": true, "type": "string" }, "product-id": { "required": true, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "PATCH", "POST", "PUT" ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/ssr": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/ssr" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wccom-site/v3" }, "/wccom-site/v3/status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/status" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wccom-site/v3" }, "/wp-block-editor/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wp-block-editor/v1", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-block-editor/v1" }, "/wp-block-editor/v1/export": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/export" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-block-editor/v1" }, "/wp-block-editor/v1/navigation-fallback": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/navigation-fallback" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-block-editor/v1" }, "/wp-block-editor/v1/url-details": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/url-details" } ] }, "endpoints": [ { "args": { "url": { "description": "The URL to process.", "format": "uri", "required": true, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-block-editor/v1" }, "/wp-site-health/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wp-site-health/v1", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/directory-sizes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/directory-sizes" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/authorization-header": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/authorization-header" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/background-updates": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/background-updates" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/dotorg-communication": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/dotorg-communication" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/https-status": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/https-status" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/loopback-requests": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/loopback-requests" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp-site-health/v1/tests/page-cache": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/page-cache" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp-site-health/v1" }, "/wp/v2": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "required": false }, "namespace": { "default": "wp/v2", "required": false } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/block-directory/search": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-directory/search" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "view" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "term": { "description": "Limit result set to blocks matching the search term.", "minLength": 1, "required": true, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/block-patterns/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/categories" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/block-patterns/patterns": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/patterns" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/block-renderer/(?P[a-z0-9-]+/[a-z0-9-]+)": { "endpoints": [ { "args": { "attributes": { "default": [], "description": "Attributes for the block.", "required": false, "type": "object" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit" ], "required": false, "type": "string" }, "name": { "description": "Unique registered name for the block.", "required": false, "type": "string" }, "post_id": { "description": "ID of the post context.", "required": false, "type": "integer" } }, "methods": [ "GET", "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/block-types": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-types" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "namespace": { "description": "Block namespace.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/block-types/(?P[a-zA-Z0-9_-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "namespace": { "description": "Block namespace.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/block-types/(?P[a-zA-Z0-9_-]+)/(?P[a-zA-Z0-9_-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "name": { "description": "Block name.", "required": false, "type": "string" }, "namespace": { "description": "Block namespace.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/blocks": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "any", "auto-draft", "draft", "future", "inherit", "pending", "private", "publish", "request-completed", "request-confirmed", "request-failed", "request-pending", "trash", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "type": "string" }, "required": false, "type": "array" }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "enum": [ "AND", "OR" ], "required": false, "type": "string" }, "wp_pattern_category": { "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", "enum": [ "AND", "OR" ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "wp_pattern_category_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the post, as it exists in the database.", "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" }, "wp_pattern_sync_status": { "default": "", "description": "", "enum": [ "partial", "unsynced" ], "type": "string" } }, "required": false, "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit", "view" ], "description": "Title for the object, as it exists in the database.", "type": "string" } }, "required": false, "type": "object" }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/blocks/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "excerpt_length": { "description": "Override the default excerpt length.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "password": { "description": "The password for the post if it is password protected.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the post, as it exists in the database.", "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" }, "wp_pattern_sync_status": { "default": "", "description": "", "enum": [ "partial", "unsynced" ], "type": "string" } }, "required": false, "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit", "view" ], "description": "Title for the object, as it exists in the database.", "type": "string" } }, "required": false, "type": "object" }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/blocks/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the post, as it exists in the database.", "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" }, "wp_pattern_sync_status": { "default": "", "description": "", "enum": [ "partial", "unsynced" ], "type": "string" } }, "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit", "view" ], "description": "Title for the object, as it exists in the database.", "type": "string" } }, "required": false, "type": "object" }, "wp_pattern_category": { "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/blocks/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/blocks/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "include_slugs", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/blocks/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as revisions do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/categories": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/categories" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide terms not assigned to any posts.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", "enum": [ "count", "description", "id", "include", "include_slugs", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to terms assigned to a specific parent.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": null, "description": "Limit result set to terms assigned to a specific post.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to terms with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, "parent": { "description": "The parent term ID.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/categories/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": false, "type": "string" }, "parent": { "description": "The parent term ID.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as terms do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/comments": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/comments" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to comments published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "author": { "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", "items": { "type": "integer" }, "required": false, "type": "array" }, "author_email": { "default": null, "description": "Limit result set to that from a specific author email. Requires authorisation.", "format": "email", "required": false, "type": "string" }, "author_exclude": { "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", "items": { "type": "integer" }, "required": false, "type": "array" }, "before": { "description": "Limit response to comments published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date_gmt", "description": "Sort collection by comment attribute.", "enum": [ "date", "date_gmt", "id", "include", "parent", "post", "type" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to comments of specific parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Ensure result set excludes specific parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "password": { "description": "The password for the post if it is password protected.", "required": false, "type": "string" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": [], "description": "Limit result set to comments assigned to specific post IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "default": "approve", "description": "Limit result set to comments assigned a specific status. Requires authorisation.", "required": false, "type": "string" }, "type": { "default": "comment", "description": "Limit result set to comments assigned a specific type. Requires authorisation.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID of the user object, if author was a user.", "required": false, "type": "integer" }, "author_email": { "description": "Email address for the comment author.", "format": "email", "required": false, "type": "string" }, "author_ip": { "description": "IP address for the comment author.", "format": "ip", "required": false, "type": "string" }, "author_name": { "description": "Display name for the comment author.", "required": false, "type": "string" }, "author_url": { "description": "URL for the comment author.", "format": "uri", "required": false, "type": "string" }, "author_user_agent": { "description": "User agent for the comment author.", "required": false, "type": "string" }, "content": { "description": "The content for the comment.", "properties": { "raw": { "context": [ "edit" ], "description": "Content for the comment, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML content for the comment, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the comment was published, in the site's time zone.", "format": "date-time", "required": false, "type": "string" }, "date_gmt": { "description": "The date the comment was published, as GMT.", "format": "date-time", "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "parent": { "default": 0, "description": "The ID for the parent of the comment.", "required": false, "type": "integer" }, "post": { "default": 0, "description": "The ID of the associated post object.", "required": false, "type": "integer" }, "status": { "description": "State of the comment.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/comments/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the comment.", "required": false, "type": "integer" }, "password": { "description": "The password for the parent post of the comment (if the post is password protected).", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID of the user object, if author was a user.", "required": false, "type": "integer" }, "author_email": { "description": "Email address for the comment author.", "format": "email", "required": false, "type": "string" }, "author_ip": { "description": "IP address for the comment author.", "format": "ip", "required": false, "type": "string" }, "author_name": { "description": "Display name for the comment author.", "required": false, "type": "string" }, "author_url": { "description": "URL for the comment author.", "format": "uri", "required": false, "type": "string" }, "author_user_agent": { "description": "User agent for the comment author.", "required": false, "type": "string" }, "content": { "description": "The content for the comment.", "properties": { "raw": { "context": [ "edit" ], "description": "Content for the comment, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML content for the comment, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the comment was published, in the site's time zone.", "format": "date-time", "required": false, "type": "string" }, "date_gmt": { "description": "The date the comment was published, as GMT.", "format": "date-time", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the comment.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the comment.", "required": false, "type": "integer" }, "post": { "description": "The ID of the associated post object.", "required": false, "type": "integer" }, "status": { "description": "State of the comment.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the comment.", "required": false, "type": "integer" }, "password": { "description": "The password for the parent post of the comment (if the post is password protected).", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/font-collections": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-collections" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/font-collections/(?P[\\/\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/font-families": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-families" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "id", "description": "Sort collection by post attribute.", "enum": [ "id", "include" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "font_family_settings": { "description": "font-family declaration in theme.json format, encoded as a string.", "required": true, "type": "string" }, "theme_json_version": { "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, "minimum": 2, "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/font-families/(?P[\\d]+)/font-faces": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "font_family_id": { "description": "The ID for the parent font family of the font face.", "required": true, "type": "integer" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "id", "description": "Sort collection by post attribute.", "enum": [ "id", "include" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "font_face_settings": { "description": "font-face declaration in theme.json format, encoded as a string.", "required": true, "type": "string" }, "font_family_id": { "description": "The ID for the parent font family of the font face.", "required": true, "type": "integer" }, "theme_json_version": { "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, "minimum": 2, "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/font-families/(?P[\\d]+)/font-faces/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "font_family_id": { "description": "The ID for the parent font family of the font face.", "required": true, "type": "integer" }, "id": { "description": "Unique identifier for the font face.", "required": true, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "font_family_id": { "description": "The ID for the parent font family of the font face.", "required": true, "type": "integer" }, "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the font face.", "required": true, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/font-families/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "font_family_settings": { "description": "font-family declaration in theme.json format, encoded as a string.", "required": true, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "theme_json_version": { "default": 3, "description": "Version of the theme.json schema used for the typography settings.", "maximum": 3, "minimum": 2, "required": false, "type": "integer" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/global-styles/(?P[\\/\\w-]+)": { "endpoints": [ { "allow_batch": { "v1": false }, "args": { "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": false }, "args": { "settings": { "description": "Global settings.", "required": false, "type": [ "object" ] }, "styles": { "description": "Global styles.", "required": false, "type": [ "object" ] }, "title": { "description": "Title of the global styles variation.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the global styles variation, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/global-styles/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/global-styles/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the global styles revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the global styles revision.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/global-styles/themes/(?P[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": { "endpoints": [ { "allow_batch": { "v1": false }, "args": { "stylesheet": { "description": "The theme identifier", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/global-styles/themes/(?P[^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)": { "endpoints": [ { "allow_batch": { "v1": false }, "args": { "stylesheet": { "description": "The theme identifier", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/media": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/media" } ] }, "endpoints": [ { "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "author": { "default": [], "description": "Limit result set to posts assigned to specific authors.", "items": { "type": "integer" }, "required": false, "type": "array" }, "author_exclude": { "default": [], "description": "Ensure result set excludes posts assigned to specific authors.", "items": { "type": "integer" }, "required": false, "type": "array" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "media_type": { "default": null, "description": "Limit result set to attachments of a particular media type.", "enum": [ "application", "image", "video" ], "required": false, "type": "string" }, "mime_type": { "default": null, "description": "Limit result set to attachments of a particular MIME type.", "required": false, "type": "string" }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to items with particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "inherit", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "inherit", "private", "trash" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "alt_text": { "description": "Alternative text to display when attachment is not displayed.", "required": false, "type": "string" }, "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "caption": { "description": "The attachment caption.", "properties": { "raw": { "context": [ "edit" ], "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML caption for the attachment, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "description": { "description": "The attachment description.", "properties": { "raw": { "context": [ "edit" ], "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML description for the attachment, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "post": { "description": "The ID for the associated post of the attachment.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/media/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "alt_text": { "description": "Alternative text to display when attachment is not displayed.", "required": false, "type": "string" }, "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "caption": { "description": "The attachment caption.", "properties": { "raw": { "context": [ "edit" ], "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML caption for the attachment, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "description": { "description": "The attachment description.", "properties": { "raw": { "context": [ "edit" ], "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML description for the attachment, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "post": { "description": "The ID for the associated post of the attachment.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/media/(?P[\\d]+)/edit": { "endpoints": [ { "args": { "height": { "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.", "maximum": 100, "minimum": 0, "required": false, "type": "number" }, "modifiers": { "description": "Array of image edits.", "items": { "description": "Image edit.", "oneOf": [ { "properties": { "args": { "description": "Rotation arguments.", "properties": { "angle": { "description": "Angle to rotate clockwise in degrees.", "type": "number" } }, "required": [ "angle" ], "type": "object" }, "type": { "description": "Rotation type.", "enum": [ "rotate" ], "type": "string" } }, "title": "Rotation" }, { "properties": { "args": { "description": "Crop arguments.", "properties": { "height": { "description": "Height of the crop as a percentage of the image height.", "type": "number" }, "left": { "description": "Horizontal position from the left to begin the crop as a percentage of the image width.", "type": "number" }, "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" } }, "required": [ "height", "left", "top", "width" ], "type": "object" }, "type": { "description": "Crop type.", "enum": [ "crop" ], "type": "string" } }, "title": "Crop" } ], "required": [ "args", "type" ], "type": "object" }, "minItems": 1, "required": false, "type": "array" }, "rotation": { "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.", "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 360, "minimum": 0, "required": false, "type": "integer" }, "src": { "description": "URL to the edited image file.", "format": "uri", "required": true, "type": "string" }, "width": { "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.", "maximum": 100, "minimum": 0, "required": false, "type": "number" }, "x": { "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.", "maximum": 100, "minimum": 0, "required": false, "type": "number" }, "y": { "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.", "maximum": 100, "minimum": 0, "required": false, "type": "number" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wp/v2" }, "/wp/v2/media/(?P[\\d]+)/post-process": { "endpoints": [ { "args": { "action": { "enum": [ "create-image-subsizes" ], "required": true, "type": "string" }, "id": { "description": "Unique identifier for the attachment.", "required": false, "type": "integer" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wp/v2" }, "/wp/v2/menu-items": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "required": false, "type": "integer" }, "menus": { "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", "enum": [ "AND", "OR" ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "menus_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "menu_order", "description": "Sort collection by object attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "menu_order", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 100, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "any", "auto-draft", "draft", "future", "inherit", "pending", "private", "publish", "request-completed", "request-confirmed", "request-failed", "request-pending", "trash", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "type": "string" }, "required": false, "type": "array" }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "enum": [ "AND", "OR" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "attr_title": { "description": "Text for the title attribute of the link element for this menu item.", "required": false, "type": "string" }, "classes": { "description": "Class names for the link element of this menu item.", "items": { "type": "string" }, "required": false, "type": "array" }, "description": { "description": "The description of this menu item.", "required": false, "type": "string" }, "menu_order": { "default": 1, "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "minimum": 1, "required": false, "type": "integer" }, "menus": { "description": "The terms assigned to the object in the nav_menu taxonomy.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "required": false, "type": "string" }, "object_id": { "default": 0, "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "minimum": 0, "required": false, "type": "integer" }, "parent": { "default": 0, "description": "The ID for the parent of the object.", "minimum": 0, "required": false, "type": "integer" }, "status": { "default": "publish", "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "target": { "description": "The target attribute of the link element for this menu item.", "enum": [ "", "_blank" ], "required": false, "type": "string" }, "title": { "description": "The title for the object.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "default": "custom", "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "enum": [ "custom", "post_type", "post_type_archive", "taxonomy" ], "required": false, "type": "string" }, "url": { "description": "The URL to which this menu item points.", "format": "uri", "required": false, "type": "string" }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/menu-items/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "attr_title": { "description": "Text for the title attribute of the link element for this menu item.", "required": false, "type": "string" }, "classes": { "description": "Class names for the link element of this menu item.", "items": { "type": "string" }, "required": false, "type": "array" }, "description": { "description": "The description of this menu item.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "minimum": 1, "required": false, "type": "integer" }, "menus": { "description": "The terms assigned to the object in the nav_menu taxonomy.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "required": false, "type": "string" }, "object_id": { "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "minimum": 0, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the object.", "minimum": 0, "required": false, "type": "integer" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "target": { "description": "The target attribute of the link element for this menu item.", "enum": [ "", "_blank" ], "required": false, "type": "string" }, "title": { "description": "The title for the object.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "enum": [ "custom", "post_type", "post_type_archive", "taxonomy" ], "required": false, "type": "string" }, "url": { "description": "The URL to which this menu item points.", "format": "uri", "required": false, "type": "string" }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/menu-items/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "attr_title": { "description": "Text for the title attribute of the link element for this menu item.", "required": false, "type": "string" }, "classes": { "description": "Class names for the link element of this menu item.", "items": { "type": "string" }, "required": false, "type": "array" }, "description": { "description": "The description of this menu item.", "required": false, "type": "string" }, "menu_order": { "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", "minimum": 1, "required": false, "type": "integer" }, "menus": { "description": "The terms assigned to the object in the nav_menu taxonomy.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "object": { "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", "required": false, "type": "string" }, "object_id": { "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", "minimum": 0, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the object.", "minimum": 0, "required": false, "type": "integer" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "target": { "description": "The target attribute of the link element for this menu item.", "enum": [ "", "_blank" ], "required": false, "type": "string" }, "title": { "description": "The title for the object.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "enum": [ "custom", "post_type", "post_type_archive", "taxonomy" ], "required": false, "type": "string" }, "url": { "description": "The URL to which this menu item points.", "format": "uri", "required": false, "type": "string" }, "xfn": { "description": "The XFN relationship expressed in the link of this menu item.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/menu-items/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/menu-locations": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-locations" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/menu-locations/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "location": { "description": "An alphanumeric identifier for the menu location.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/menus": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menus" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide terms not assigned to any posts.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", "enum": [ "count", "description", "id", "include", "include_slugs", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": null, "description": "Limit result set to terms assigned to a specific post.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to terms with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "auto_add": { "description": "Whether to automatically add top-level pages to this menu.", "required": false, "type": "boolean" }, "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "locations": { "description": "The locations assigned to the menu.", "items": { "type": "string" }, "required": false, "type": "array" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/menus/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "auto_add": { "description": "Whether to automatically add top-level pages to this menu.", "required": false, "type": "boolean" }, "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" }, "locations": { "description": "The locations assigned to the menu.", "items": { "type": "string" }, "required": false, "type": "array" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as terms do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/navigation": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "any", "auto-draft", "draft", "future", "inherit", "pending", "private", "publish", "request-completed", "request-confirmed", "request-failed", "request-pending", "trash", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit", "embed" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit", "embed" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit", "embed" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/navigation/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "password": { "description": "The password for the post if it is password protected.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit", "embed" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit", "embed" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit", "embed" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/navigation/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit", "embed" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit", "embed" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit", "embed" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/navigation/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/navigation/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "include_slugs", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/navigation/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as revisions do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/pages": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pages" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "author": { "default": [], "description": "Limit result set to posts assigned to specific authors.", "items": { "type": "integer" }, "required": false, "type": "array" }, "author_exclude": { "default": [], "description": "Ensure result set excludes posts assigned to specific authors.", "items": { "type": "integer" }, "required": false, "type": "array" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "menu_order": { "description": "Limit result set to posts with a specific menu_order value.", "required": false, "type": "integer" }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "menu_order", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "default": [], "description": "Limit result set to items with particular parent IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "parent_exclude": { "default": [], "description": "Limit result set to all items except those of a particular parent ID.", "items": { "type": "integer" }, "required": false, "type": "array" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "any", "auto-draft", "draft", "future", "inherit", "pending", "private", "publish", "request-completed", "request-confirmed", "request-failed", "request-pending", "trash", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the object.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/pages/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "excerpt_length": { "description": "Override the default excerpt length.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "password": { "description": "The password for the post if it is password protected.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the object.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/pages/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "menu_order": { "description": "The order of the post in relation to other posts.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the object.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/pages/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/pages/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "include_slugs", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/pages/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as revisions do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/pattern-directory/patterns": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pattern-directory/patterns" } ] }, "endpoints": [ { "args": { "category": { "description": "Limit results to those matching a category ID.", "minimum": 1, "required": false, "type": "integer" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "keyword": { "description": "Limit results to those matching a keyword ID.", "minimum": 1, "required": false, "type": "integer" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "favorite_count", "id", "include", "include_slugs", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 100, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "minLength": 1, "required": false, "type": "string" }, "slug": { "description": "Limit results to those matching a pattern (slug).", "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/plugins": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/plugins" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "status": { "description": "Limits results to plugins with the given status.", "items": { "enum": [ "active", "inactive" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "args": { "slug": { "description": "WordPress.org plugin directory slug.", "pattern": "[\\w\\-]+", "required": true, "type": "string" }, "status": { "default": "inactive", "description": "The plugin activation status.", "enum": [ "active", "inactive" ], "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/plugins/(?P[^.\\/]+(?:\\/[^.\\/]+)?)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "plugin": { "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "plugin": { "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", "required": false, "type": "string" }, "status": { "description": "The plugin activation status.", "enum": [ "active", "inactive" ], "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "plugin": { "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/posts": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/posts" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "author": { "default": [], "description": "Limit result set to posts assigned to specific authors.", "items": { "type": "integer" }, "required": false, "type": "array" }, "author_exclude": { "default": [], "description": "Ensure result set excludes posts assigned to specific authors.", "items": { "type": "integer" }, "required": false, "type": "array" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "categories": { "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "include_children": { "default": false, "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean" }, "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", "enum": [ "AND", "OR" ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "categories_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "include_children": { "default": false, "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "modified", "parent", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "any", "auto-draft", "draft", "future", "inherit", "pending", "private", "publish", "request-completed", "request-confirmed", "request-failed", "request-pending", "trash", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "type": "string" }, "required": false, "type": "array" }, "sticky": { "description": "Limit result set to items that are sticky.", "required": false, "type": "boolean" }, "tags": { "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", "enum": [ "AND", "OR" ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "tags_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "enum": [ "AND", "OR" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "format": { "description": "The format for the post.", "enum": [ "aside", "audio", "chat", "gallery", "image", "link", "quote", "standard", "status", "video" ], "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, "required": false, "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "required": false, "type": "boolean" }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/posts/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "excerpt_length": { "description": "Override the default excerpt length.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "password": { "description": "The password for the post if it is password protected.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "format": { "description": "The format for the post.", "enum": [ "aside", "audio", "chat", "gallery", "image", "link", "quote", "standard", "status", "video" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, "required": false, "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "required": false, "type": "boolean" }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/posts/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID for the author of the post.", "required": false, "type": "integer" }, "categories": { "description": "The terms assigned to the object in the category taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "comment_status": { "description": "Whether or not comments are open on the post.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "format": { "description": "The format for the post.", "enum": [ "aside", "audio", "chat", "gallery", "image", "link", "quote", "standard", "status", "video" ], "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": { "footnotes": { "default": "", "description": "", "type": "string" } }, "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "ping_status": { "description": "Whether or not the post can be pinged.", "enum": [ "closed", "open" ], "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "required": false, "type": "boolean" }, "tags": { "description": "The terms assigned to the object in the post_tag taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/posts/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/posts/(?P[\\d]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "include_slugs", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/posts/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as revisions do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the revision.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/product": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "modified_after": { "description": "Limit response to posts modified after a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", "format": "date-time", "required": false, "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", "include_slugs", "modified", "parent", "popularity", "popularity", "rating", "rating", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "product_cat": { "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "include_children": { "default": false, "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean" }, "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", "enum": [ "AND", "OR" ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "product_cat_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "include_children": { "default": false, "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "product_tag": { "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "operator": { "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", "enum": [ "AND", "OR" ], "type": "string" }, "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "product_tag_exclude": { "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", "oneOf": [ { "description": "Match terms with the listed IDs.", "items": { "type": "integer" }, "title": "Term ID List", "type": "array" }, { "additionalProperties": false, "description": "Perform an advanced term query.", "properties": { "terms": { "default": [], "description": "Term IDs.", "items": { "type": "integer" }, "type": "array" } }, "title": "Term ID Taxonomy Query", "type": "object" } ], "required": false, "type": [ "array", "object" ] }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", "items": { "enum": [ "post_content", "post_excerpt", "post_title" ], "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", "items": { "enum": [ "any", "auto-draft", "draft", "future", "inherit", "pending", "private", "publish", "request-completed", "request-confirmed", "request-failed", "request-pending", "trash", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "type": "string" }, "required": false, "type": "array" }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", "enum": [ "AND", "OR" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "product_cat": { "description": "The terms assigned to the object in the product_cat taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_tag": { "description": "The terms assigned to the object in the product_tag taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/product/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "excerpt_length": { "description": "Override the default excerpt length.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "password": { "description": "The password for the post if it is password protected.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "product_cat": { "description": "The terms assigned to the object in the product_cat taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_tag": { "description": "The terms assigned to the object in the product_tag taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the post.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/product/(?P[\\d]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "content": { "description": "The content for the post.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the post.", "readonly": true, "type": "integer" }, "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the content is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "view" ], "description": "HTML content for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "date_gmt": { "description": "The date the post was published, as GMT.", "format": "date-time", "required": false, "type": [ "null", "string" ] }, "excerpt": { "description": "The excerpt for the post.", "properties": { "protected": { "context": [ "edit", "embed", "view" ], "description": "Whether the excerpt is protected with a password.", "readonly": true, "type": "boolean" }, "raw": { "context": [ "edit" ], "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML excerpt for the post, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" }, "featured_media": { "description": "The ID of the featured media for the post.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" }, "password": { "description": "A password to protect access to the content and excerpt.", "required": false, "type": "string" }, "product_cat": { "description": "The terms assigned to the object in the product_cat taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "product_tag": { "description": "The terms assigned to the object in the product_tag taxonomy.", "items": { "type": "integer" }, "required": false, "type": "array" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "required": false, "type": "string" }, "status": { "description": "A named status for the object.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "template": { "description": "The theme file to use to display the post.", "required": false, "type": "string" }, "title": { "description": "The title for the post.", "properties": { "raw": { "context": [ "edit" ], "description": "Title for the object, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the object, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/product/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID for the parent of the autosave.", "required": false, "type": "integer" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/product_cat": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_cat" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide terms not assigned to any posts.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", "enum": [ "count", "description", "id", "include", "include_slugs", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "Limit result set to terms assigned to a specific parent.", "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": null, "description": "Limit result set to terms assigned to a specific post.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to terms with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, "parent": { "description": "The parent term ID.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/product_cat/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": false, "type": "string" }, "parent": { "description": "The parent term ID.", "required": false, "type": "integer" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as terms do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/product_tag": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_tag" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide terms not assigned to any posts.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", "enum": [ "count", "description", "id", "include", "include_slugs", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": null, "description": "Limit result set to terms assigned to a specific post.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to terms with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/product_tag/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as terms do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/search": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/search" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "subtype": { "default": "any", "description": "Limit results to items of one or more object subtypes.", "items": { "enum": [ "any", "category", "page", "post", "post_tag", "product", "product_cat", "product_tag" ], "type": "string" }, "required": false, "type": "array" }, "type": { "default": "post", "description": "Limit results to items of an object type.", "enum": [ "post", "post-format", "term" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/settings": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/settings" } ] }, "endpoints": [ { "args": [], "methods": [ "GET" ] }, { "args": { "date_format": { "description": "A date format for all date strings.", "required": false, "title": "", "type": "string" }, "default_category": { "description": "Default post category.", "required": false, "title": "", "type": "integer" }, "default_comment_status": { "description": "Allow people to submit comments on new posts.", "enum": [ "closed", "open" ], "required": false, "title": "Allow comments on new posts", "type": "string" }, "default_ping_status": { "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", "enum": [ "closed", "open" ], "required": false, "title": "", "type": "string" }, "default_post_format": { "description": "Default post format.", "required": false, "title": "", "type": "string" }, "description": { "description": "Site tagline.", "required": false, "title": "Tagline", "type": "string" }, "email": { "description": "This address is used for admin purposes, like new user notification.", "format": "email", "required": false, "title": "", "type": "string" }, "language": { "description": "WordPress locale code.", "required": false, "title": "", "type": "string" }, "page_for_posts": { "description": "The ID of the page that should display the latest posts", "required": false, "title": "", "type": "integer" }, "page_on_front": { "description": "The ID of the page that should be displayed on the front page", "required": false, "title": "Page on front", "type": "integer" }, "pickup_location_settings": { "additionalProperties": false, "description": "WooCommerce Local Pickup Method Settings", "properties": { "cost": { "description": "Optional cost to charge for local pickup.", "type": "string" }, "enabled": { "description": "If enabled, this method will appear on the block based checkout.", "enum": [ "no", "yes" ], "type": "string" }, "tax_status": { "description": "If a cost is defined, this controls if taxes are applied to that cost.", "enum": [ "none", "taxable" ], "type": "string" }, "title": { "description": "This controls the title which the user sees during checkout.", "type": "string" } }, "required": false, "title": "", "type": "object" }, "pickup_locations": { "description": "WooCommerce Local Pickup Locations", "items": { "additionalProperties": false, "properties": { "address": { "additionalProperties": false, "properties": { "address_1": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postcode": { "type": "string" }, "state": { "type": "string" } }, "type": "object" }, "details": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "required": false, "title": "", "type": "array" }, "posts_per_page": { "description": "Blog pages show at most.", "required": false, "title": "Maximum posts per page", "type": "integer" }, "show_on_front": { "description": "What to show on the front page", "required": false, "title": "Show on front", "type": "string" }, "site_icon": { "description": "Site icon.", "required": false, "title": "Icon", "type": "integer" }, "site_logo": { "description": "Site logo.", "required": false, "title": "Logo", "type": "integer" }, "start_of_week": { "description": "A day number of the week that the week should start on.", "required": false, "title": "", "type": "integer" }, "time_format": { "description": "A time format for all time strings.", "required": false, "title": "", "type": "string" }, "timezone": { "description": "A city in the same timezone as you.", "required": false, "title": "", "type": "string" }, "title": { "description": "Site title.", "required": false, "title": "Title", "type": "string" }, "url": { "description": "Site URL.", "format": "uri", "required": false, "title": "", "type": "string" }, "use_smilies": { "description": "Convert emoticons like :-) and :-P to graphics on display.", "required": false, "title": "", "type": "boolean" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/sidebars": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/sidebars" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/sidebars/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID of a registered sidebar", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "widgets": { "description": "Nested widgets.", "items": { "type": [ "object", "string" ] }, "required": false, "type": "array" } }, "methods": [ "PATCH", "POST", "PUT" ] } ], "methods": [ "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/statuses": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/statuses" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/statuses/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "status": { "description": "An alphanumeric identifier for the status.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/tags": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/tags" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide terms not assigned to any posts.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", "enum": [ "count", "description", "id", "include", "include_slugs", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": null, "description": "Limit result set to terms assigned to a specific post.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to terms with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/tags/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as terms do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/taxonomies": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/taxonomies" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "type": { "description": "Limit results to taxonomies associated with a specific post type.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/taxonomies/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "taxonomy": { "description": "An alphanumeric identifier for the taxonomy.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/template-parts": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts" } ] }, "endpoints": [ { "args": { "area": { "description": "Limit to the specified template part area.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "post_type": { "description": "Post type for which to get the templates.", "required": false, "type": "string" }, "wp_id": { "description": "Limit to the specified post ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "area": { "description": "Where the template part is intended for use (header, footer, etc)", "required": false, "type": "string" }, "author": { "description": "The ID for the author of the template.", "required": false, "type": "integer" }, "content": { "default": "", "description": "Content of template.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "description": { "default": "", "description": "Description of template.", "required": false, "type": "string" }, "slug": { "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", "required": true, "type": "string" }, "status": { "default": "publish", "description": "Status of template.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "theme": { "description": "Theme identifier for the template.", "required": false, "type": "string" }, "title": { "default": "", "description": "Title of template.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "Type of template.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "area": { "description": "Where the template part is intended for use (header, footer, etc)", "required": false, "type": "string" }, "author": { "description": "The ID for the author of the template.", "required": false, "type": "integer" }, "content": { "description": "Content of template.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "description": { "description": "Description of template.", "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" }, "slug": { "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", "required": false, "type": "string" }, "status": { "description": "Status of template.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "theme": { "description": "Theme identifier for the template.", "required": false, "type": "string" }, "title": { "description": "Title of template.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "Type of template.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "area": { "description": "Where the template part is intended for use (header, footer, etc)", "required": false, "type": "string" }, "author": { "description": "The ID for the author of the template.", "required": false, "type": "integer" }, "content": { "description": "Content of template.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "description": { "description": "Description of template.", "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" }, "slug": { "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", "required": false, "type": "string" }, "status": { "description": "Status of template.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "theme": { "description": "Theme identifier for the template.", "required": false, "type": "string" }, "title": { "description": "Title of template.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "Type of template.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "include_slugs", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/template-parts/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as revisions do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/template-parts/lookup": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts/lookup" } ] }, "endpoints": [ { "args": { "is_custom": { "description": "Indicates if a template is custom or part of the template hierarchy", "required": false, "type": "boolean" }, "slug": { "description": "The slug of the template to get the fallback for", "required": true, "type": "string" }, "template_prefix": { "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/templates": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates" } ] }, "endpoints": [ { "args": { "area": { "description": "Limit to the specified template part area.", "required": false, "type": "string" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "post_type": { "description": "Post type for which to get the templates.", "required": false, "type": "string" }, "wp_id": { "description": "Limit to the specified post ID.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID for the author of the template.", "required": false, "type": "integer" }, "content": { "default": "", "description": "Content of template.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "description": { "default": "", "description": "Description of template.", "required": false, "type": "string" }, "slug": { "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", "required": true, "type": "string" }, "status": { "default": "publish", "description": "Status of template.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "theme": { "description": "Theme identifier for the template.", "required": false, "type": "string" }, "title": { "default": "", "description": "Title of template.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "Type of template.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID for the author of the template.", "required": false, "type": "integer" }, "content": { "description": "Content of template.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "description": { "description": "Description of template.", "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" }, "slug": { "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", "required": false, "type": "string" }, "status": { "description": "Status of template.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "theme": { "description": "Theme identifier for the template.", "required": false, "type": "string" }, "title": { "description": "Title of template.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "Type of template.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Whether to bypass Bin and force deletion.", "required": false, "type": "boolean" }, "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "author": { "description": "The ID for the author of the template.", "required": false, "type": "integer" }, "content": { "description": "Content of template.", "properties": { "block_version": { "context": [ "edit" ], "description": "Version of the content block format used by the template.", "readonly": true, "type": "integer" }, "raw": { "context": [ "edit", "view" ], "description": "Content for the template, as it exists in the database.", "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "description": { "description": "Description of template.", "required": false, "type": "string" }, "id": { "description": "The ID of a template", "required": false, "type": "string" }, "slug": { "description": "Unique slug identifying the template.", "minLength": 1, "pattern": "[a-zA-Z0-9_\\%-]+", "required": false, "type": "string" }, "status": { "description": "Status of template.", "enum": [ "draft", "future", "pending", "private", "publish", "wc-cancelled", "wc-checkout-draft", "wc-completed", "wc-failed", "wc-on-hold", "wc-pending", "wc-processing", "wc-refunded" ], "required": false, "type": "string" }, "theme": { "description": "Theme identifier for the template.", "required": false, "type": "string" }, "title": { "description": "Title of template.", "properties": { "raw": { "context": [ "edit", "embed", "view" ], "description": "Title for the template, as it exists in the database.", "type": "string" }, "rendered": { "context": [ "edit", "embed", "view" ], "description": "HTML title for the template, transformed for display.", "readonly": true, "type": "string" } }, "required": false, "type": [ "object", "string" ] }, "type": { "description": "Type of template.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The ID for the autosave.", "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "desc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "date", "description": "Sort collection by object attribute.", "enum": [ "date", "id", "include", "include_slugs", "relevance", "slug", "title" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" }, "per_page": { "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P[\\d]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as revisions do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the revision.", "required": false, "type": "integer" }, "parent": { "description": "The ID of a template", "required": false, "type": "string" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET" ], "namespace": "wp/v2" }, "/wp/v2/templates/lookup": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates/lookup" } ] }, "endpoints": [ { "args": { "is_custom": { "description": "Indicates if a template is custom or part of the template hierarchy", "required": false, "type": "boolean" }, "slug": { "description": "The slug of the template to get the fallback for", "required": true, "type": "string" }, "template_prefix": { "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/themes": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/themes" } ] }, "endpoints": [ { "args": { "status": { "description": "Limit result set to themes assigned one or more statuses.", "items": { "enum": [ "active", "inactive" ], "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/themes/(?P[^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)": { "endpoints": [ { "args": { "stylesheet": { "description": "The theme's style sheet. This uniquely identifies the theme.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/types": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/types" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/types/(?P[\\w-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "type": { "description": "An alphanumeric identifier for the post type.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/users": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "capabilities": { "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "items": { "type": "string" }, "required": false, "type": "array" }, "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "has_published_posts": { "description": "Limit result set to users who have published posts.", "items": { "enum": { "attachment": "attachment", "nav_menu_item": "nav_menu_item", "page": "page", "post": "post", "product": "product", "wp_block": "wp_block", "wp_font_face": "wp_font_face", "wp_font_family": "wp_font_family", "wp_global_styles": "wp_global_styles", "wp_navigation": "wp_navigation", "wp_template": "wp_template", "wp_template_part": "wp_template_part" }, "type": "string" }, "required": false, "type": [ "array", "boolean" ] }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by user attribute.", "enum": [ "email", "id", "include", "include_slugs", "name", "registered_date", "slug", "url" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "roles": { "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "items": { "type": "string" }, "required": false, "type": "array" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to users with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" }, "who": { "description": "Limit result set to users who are considered authors.", "enum": [ "authors" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "Description of the user.", "required": false, "type": "string" }, "email": { "description": "The email address for the user.", "format": "email", "required": true, "type": "string" }, "first_name": { "description": "First name for the user.", "required": false, "type": "string" }, "last_name": { "description": "Last name for the user.", "required": false, "type": "string" }, "locale": { "description": "Locale for the user.", "enum": [ "", "en_GB", "en_US", "fr_BE", "fr_FR" ], "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": { "persisted_preferences": { "additionalProperties": true, "context": [ "edit" ], "default": [], "description": "", "properties": { "_modified": { "description": "The date and time the preferences were updated.", "format": "date-time", "readonly": false, "type": "string" } }, "type": "object" }, "woocommerce_coming_soon_banner_dismissed": { "default": "", "description": "Indicate whether the user has dismissed the coming soon notice or not.", "type": "string" }, "woocommerce_launch_your_store_tour_hidden": { "default": "", "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", "type": "string" } }, "required": false, "type": "object" }, "name": { "description": "Display name for the user.", "required": false, "type": "string" }, "nickname": { "description": "The nickname for the user.", "required": false, "type": "string" }, "password": { "description": "Password for the user (never included).", "required": true, "type": "string" }, "roles": { "description": "Roles assigned to the user.", "items": { "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "An alphanumeric identifier for the user.", "required": false, "type": "string" }, "url": { "description": "URL of the user.", "format": "uri", "required": false, "type": "string" }, "username": { "description": "Login name for the user.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/users/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the user.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "Description of the user.", "required": false, "type": "string" }, "email": { "description": "The email address for the user.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "First name for the user.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the user.", "required": false, "type": "integer" }, "last_name": { "description": "Last name for the user.", "required": false, "type": "string" }, "locale": { "description": "Locale for the user.", "enum": [ "", "en_GB", "en_US", "fr_BE", "fr_FR" ], "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": { "persisted_preferences": { "additionalProperties": true, "context": [ "edit" ], "default": [], "description": "", "properties": { "_modified": { "description": "The date and time the preferences were updated.", "format": "date-time", "readonly": false, "type": "string" } }, "type": "object" }, "woocommerce_coming_soon_banner_dismissed": { "default": "", "description": "Indicate whether the user has dismissed the coming soon notice or not.", "type": "string" }, "woocommerce_launch_your_store_tour_hidden": { "default": "", "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", "type": "string" } }, "required": false, "type": "object" }, "name": { "description": "Display name for the user.", "required": false, "type": "string" }, "nickname": { "description": "The nickname for the user.", "required": false, "type": "string" }, "password": { "description": "Password for the user (never included).", "required": false, "type": "string" }, "roles": { "description": "Roles assigned to the user.", "items": { "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "An alphanumeric identifier for the user.", "required": false, "type": "string" }, "url": { "description": "URL of the user.", "format": "uri", "required": false, "type": "string" }, "username": { "description": "Login name for the user.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as users do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the user.", "required": false, "type": "integer" }, "reassign": { "description": "Reassign the deleted user's posts and links to this user ID.", "required": true, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/users/(?P(?:[\\d]+|me))/application-passwords": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "app_id": { "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "format": "uuid", "required": false, "type": "string" }, "name": { "description": "The name of the application password.", "minLength": 1, "pattern": ".*\\S.*", "required": true, "type": "string" } }, "methods": [ "POST" ] }, { "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/users/(?P(?:[\\d]+|me))/application-passwords/(?P[\\w\\-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "app_id": { "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.", "format": "uuid", "required": false, "type": "string" }, "name": { "description": "The name of the application password.", "minLength": 1, "pattern": ".*\\S.*", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": [], "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/users/(?P(?:[\\d]+|me))/application-passwords/introspect": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/users/me": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users/me" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "args": { "description": { "description": "Description of the user.", "required": false, "type": "string" }, "email": { "description": "The email address for the user.", "format": "email", "required": false, "type": "string" }, "first_name": { "description": "First name for the user.", "required": false, "type": "string" }, "last_name": { "description": "Last name for the user.", "required": false, "type": "string" }, "locale": { "description": "Locale for the user.", "enum": [ "", "en_GB", "en_US", "fr_BE", "fr_FR" ], "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": { "persisted_preferences": { "additionalProperties": true, "context": [ "edit" ], "default": [], "description": "", "properties": { "_modified": { "description": "The date and time the preferences were updated.", "format": "date-time", "readonly": false, "type": "string" } }, "type": "object" }, "woocommerce_coming_soon_banner_dismissed": { "default": "", "description": "Indicate whether the user has dismissed the coming soon notice or not.", "type": "string" }, "woocommerce_launch_your_store_tour_hidden": { "default": "", "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", "type": "string" } }, "required": false, "type": "object" }, "name": { "description": "Display name for the user.", "required": false, "type": "string" }, "nickname": { "description": "The nickname for the user.", "required": false, "type": "string" }, "password": { "description": "Password for the user (never included).", "required": false, "type": "string" }, "roles": { "description": "Roles assigned to the user.", "items": { "type": "string" }, "required": false, "type": "array" }, "slug": { "description": "An alphanumeric identifier for the user.", "required": false, "type": "string" }, "url": { "description": "URL of the user.", "format": "uri", "required": false, "type": "string" }, "username": { "description": "Login name for the user.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "args": { "force": { "default": false, "description": "Required to be true, as users do not support binning.", "required": false, "type": "boolean" }, "reassign": { "description": "Reassign the deleted user's posts and links to this user ID.", "required": true, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/widget-types": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/widget-types" } ] }, "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)": { "endpoints": [ { "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "The widget type ID.", "required": false, "type": "string" } }, "methods": [ "GET" ] } ], "methods": [ "GET" ], "namespace": "wp/v2" }, "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)/encode": { "endpoints": [ { "args": { "form_data": { "description": "Serialised widget form data to encode into instance settings.", "required": false, "type": "string" }, "id": { "description": "The widget type ID.", "required": true, "type": "string" }, "instance": { "description": "Current instance settings of the widget.", "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wp/v2" }, "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)/render": { "endpoints": [ { "args": { "id": { "description": "The widget type ID.", "required": true, "type": "string" }, "instance": { "description": "Current instance settings of the widget.", "required": false, "type": "object" } }, "methods": [ "POST" ] } ], "methods": [ "POST" ], "namespace": "wp/v2" }, "/wp/v2/widgets": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/widgets" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "sidebar": { "description": "The sidebar for which to return widgets.", "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "form_data": { "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the widget.", "required": false, "type": "string" }, "id_base": { "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "required": false, "type": "string" }, "instance": { "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { "context": [ "edit" ], "description": "Base64 encoded representation of the instance settings.", "type": "string" }, "hash": { "context": [ "edit" ], "description": "Cryptographic hash of the instance settings.", "type": "string" }, "raw": { "context": [ "edit" ], "description": "Unencoded instance settings, if supported.", "type": "object" } }, "required": false, "type": "object" }, "sidebar": { "default": "wp_inactive_widgets", "description": "The sidebar to which the widget belongs.", "required": true, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/widgets/(?P[\\w\\-]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "form_data": { "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the widget.", "required": false, "type": "string" }, "id_base": { "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", "required": false, "type": "string" }, "instance": { "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { "context": [ "edit" ], "description": "Base64 encoded representation of the instance settings.", "type": "string" }, "hash": { "context": [ "edit" ], "description": "Cryptographic hash of the instance settings.", "type": "string" }, "raw": { "context": [ "edit" ], "description": "Unencoded instance settings, if supported.", "type": "object" } }, "required": false, "type": "object" }, "sidebar": { "description": "The sidebar to which the widget belongs.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "description": "Whether to force removal of the widget, or move it to the inactive sidebar.", "required": false, "type": "boolean" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" }, "/wp/v2/wp_pattern_category": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/wp_pattern_category" } ] }, "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "exclude": { "default": [], "description": "Ensure result set excludes specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "hide_empty": { "default": false, "description": "Whether to hide terms not assigned to any posts.", "required": false, "type": "boolean" }, "include": { "default": [], "description": "Limit result set to specific IDs.", "items": { "type": "integer" }, "required": false, "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", "required": false, "type": "integer" }, "order": { "default": "asc", "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], "required": false, "type": "string" }, "orderby": { "default": "name", "description": "Sort collection by term attribute.", "enum": [ "count", "description", "id", "include", "include_slugs", "name", "slug", "term_group" ], "required": false, "type": "string" }, "page": { "default": 1, "description": "Current page of the collection.", "minimum": 1, "required": false, "type": "integer" }, "per_page": { "default": 10, "description": "Maximum number of items to be returned in result set.", "maximum": 100, "minimum": 1, "required": false, "type": "integer" }, "post": { "default": null, "description": "Limit result set to terms assigned to a specific post.", "required": false, "type": "integer" }, "search": { "description": "Limit results to those matching a string.", "required": false, "type": "string" }, "slug": { "description": "Limit result set to terms with one or more specific slugs.", "items": { "type": "string" }, "required": false, "type": "array" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": true, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "POST" ] } ], "methods": [ "GET", "POST" ], "namespace": "wp/v2" }, "/wp/v2/wp_pattern_category/(?P[\\d]+)": { "endpoints": [ { "allow_batch": { "v1": true }, "args": { "context": { "default": "view", "description": "Scope under which the request is made; determines fields present in response.", "enum": [ "edit", "embed", "view" ], "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "GET" ] }, { "allow_batch": { "v1": true }, "args": { "description": { "description": "HTML description of the term.", "required": false, "type": "string" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" }, "meta": { "description": "Meta fields.", "properties": [], "required": false, "type": "object" }, "name": { "description": "HTML title for the term.", "required": false, "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "required": false, "type": "string" } }, "methods": [ "PATCH", "POST", "PUT" ] }, { "allow_batch": { "v1": true }, "args": { "force": { "default": false, "description": "Required to be true, as terms do not support binning.", "required": false, "type": "boolean" }, "id": { "description": "Unique identifier for the term.", "required": false, "type": "integer" } }, "methods": [ "DELETE" ] } ], "methods": [ "DELETE", "GET", "PATCH", "POST", "PUT" ], "namespace": "wp/v2" } }, "site_icon": 0, "site_icon_url": "", "site_logo": 0, "timezone_string": "Europe/Brussels", "url": "https://haikuatelier.fr.ddev.site/wp" }