gcch/haiku-atelier-2024
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
haiku-atelier-2024/lib/wp-json-schema.json
gcch 082202007b 2024-09-06
2024-09-06 10:47:20 +02:00

99225 lines
2.9 MiB
Raw Blame History

{
"name": "Haiku Atelier",
"description": "",
"url": "https://haikuatelier.fr.ddev.site/wp",
"home": "https://haikuatelier.fr.ddev.site",
"gmt_offset": 2,
"timezone_string": "Europe/Brussels",
"namespaces": [
"wc/v3",
"jetpack/v4",
"wc-admin",
"wc-analytics",
"wc/store",
"wc/store/v1",
"wc/private",
"wc/v1",
"wc/v2",
"wc-telemetry",
"wccom-site/v3",
"carbon-fields/v1",
"wp/v2",
"wp-site-health/v1",
"wp-block-editor/v1"
],
"authentication": [],
"routes": {
"/": {
"namespace": "",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/"
}
]
}
},
"/batch/v1": {
"namespace": "",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"validation": {
"type": "string",
"enum": [
"require-all-validate",
"normal"
],
"default": "normal",
"required": false
},
"requests": {
"type": "array",
"maxItems": 25,
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": [
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "POST"
},
"path": {
"type": "string",
"required": true
},
"body": {
"type": "object",
"properties": [],
"additionalProperties": true
},
"headers": {
"type": "object",
"properties": [],
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/batch/v1"
}
]
}
},
"/wc/v3": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc/v3",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3"
}
]
}
},
"/wc/v3/marketplace/featured": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/featured"
}
]
}
},
"/wc/v3/marketplace/refresh": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/refresh"
}
]
}
},
"/wc/v3/marketplace/subscriptions": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions"
}
]
}
},
"/wc/v3/marketplace/subscriptions/connect": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product_key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/connect"
}
]
}
},
"/wc/v3/marketplace/subscriptions/disconnect": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product_key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/disconnect"
}
]
}
},
"/wc/v3/marketplace/subscriptions/activate": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product_key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/activate"
}
]
}
},
"/wc/v3/marketplace/subscriptions/install-url": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/install-url"
}
]
}
},
"/wc/v3/marketplace/create-order": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product_id": {
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/create-order"
}
]
}
},
"/jetpack/v4": {
"namespace": "jetpack/v4",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "jetpack/v4",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4"
}
]
}
},
"/jetpack/v4/verify_xmlrpc_error": {
"namespace": "jetpack/v4",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"nonce": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_xmlrpc_error"
}
]
}
},
"/jetpack/v4/verify_registration": {
"namespace": "jetpack/v4",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_registration"
}
]
}
},
"/jetpack/v4/remote_authorize": {
"namespace": "jetpack/v4",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/remote_authorize"
}
]
}
},
"/jetpack/v4/connection": {
"namespace": "jetpack/v4",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"isActive": {
"description": "Set to false will trigger the site to disconnect.",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection"
}
]
}
},
"/jetpack/v4/connection/data": {
"namespace": "jetpack/v4",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/data"
}
]
}
},
"/jetpack/v4/connection/plugins": {
"namespace": "jetpack/v4",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/plugins"
}
]
}
},
"/jetpack/v4/connection/reconnect": {
"namespace": "jetpack/v4",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/reconnect"
}
]
}
},
"/jetpack/v4/connection/register": {
"namespace": "jetpack/v4",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"from": {
"description": "Indicates where the registration action was triggered for tracking/segmentation purposes",
"type": "string",
"required": false
},
"registration_nonce": {
"description": "The registration nonce",
"type": "string",
"required": true
},
"redirect_uri": {
"description": "URI of the admin page where the user should be redirected after connection flow",
"type": "string",
"required": false
},
"plugin_slug": {
"description": "Indicates from what plugin the request is coming from",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/register"
}
]
}
},
"/jetpack/v4/connection/authorize_url": {
"namespace": "jetpack/v4",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"redirect_uri": {
"description": "URI of the admin page where the user should be redirected after connection flow",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/authorize_url"
}
]
}
},
"/jetpack/v4/user-token": {
"namespace": "jetpack/v4",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"user_token": {
"description": "New user token",
"type": "string",
"required": true
},
"is_connection_owner": {
"description": "Is connection owner",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/user-token"
}
]
}
},
"/jetpack/v4/connection/owner": {
"namespace": "jetpack/v4",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"owner": {
"description": "New owner",
"type": "integer",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/owner"
}
]
}
},
"/wc-admin": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc-admin",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin"
}
]
}
},
"/wc-admin/notice/dismiss": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/notice/dismiss"
}
]
}
},
"/wc-admin/features": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/features"
}
]
}
},
"/wc-admin/experiments/assignment": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/experiments/assignment"
}
]
}
},
"/wc-admin/marketing/recommended": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"category": {
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommended"
}
]
}
},
"/wc-admin/marketing/knowledge-base": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"category": {
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/knowledge-base"
}
]
}
},
"/wc-admin/marketing/overview/activate-plugin": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"plugin": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/activate-plugin"
}
]
}
},
"/wc-admin/marketing/overview/installed-plugins": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/installed-plugins"
}
]
}
},
"/wc-admin/marketing/recommendations": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"category": {
"type": "string",
"enum": [
"channels",
"extensions"
],
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommendations"
}
]
}
},
"/wc-admin/marketing/channels": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/channels"
}
]
}
},
"/wc-admin/marketing/campaigns": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaigns"
}
]
}
},
"/wc-admin/marketing/campaign-types": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaign-types"
}
]
}
},
"/wc-admin/options": {
"namespace": "wc-admin",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/options"
}
]
}
},
"/wc-admin/payment-gateway-suggestions": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"force_default_suggestions": {
"type": "boolean",
"description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions"
}
]
}
},
"/wc-admin/payment-gateway-suggestions/dismiss": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions/dismiss"
}
]
}
},
"/wc-admin/themes": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"pluginzip": {
"description": "A zip file of the theme to be uploaded.",
"type": "file",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/themes"
}
]
}
},
"/wc-admin/plugins/install": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install"
}
]
}
},
"/wc-admin/plugins/install/status": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install/status"
}
]
}
},
"/wc-admin/plugins/install/status/(?P\u003Cjob_id\u003E[a-z0-9_\\-]+)": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/wc-admin/plugins/active": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/active"
}
]
}
},
"/wc-admin/plugins/installed": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/installed"
}
]
}
},
"/wc-admin/plugins/activate": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate"
}
]
}
},
"/wc-admin/plugins/activate/status": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate/status"
}
]
}
},
"/wc-admin/plugins/activate/status/(?P\u003Cjob_id\u003E[a-z0-9_\\-]+)": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/wc-admin/plugins/connect-jetpack": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-jetpack"
}
]
}
},
"/wc-admin/plugins/request-wccom-connect": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/request-wccom-connect"
}
]
}
},
"/wc-admin/plugins/finish-wccom-connect": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/finish-wccom-connect"
}
]
}
},
"/wc-admin/plugins/connect-wcpay": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-wcpay"
}
]
}
},
"/wc-admin/plugins/connect-square": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-square"
}
]
}
},
"/wc-admin/onboarding/free-extensions": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/free-extensions"
}
]
}
},
"/wc-admin/onboarding/product-types": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/product-types"
}
]
}
},
"/wc-admin/onboarding/profile": {
"namespace": "wc-admin",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"completed": {
"type": "boolean",
"description": "Whether or not the profile was completed.",
"required": false
},
"skipped": {
"type": "boolean",
"description": "Whether or not the profile was skipped.",
"required": false
},
"industry": {
"type": "array",
"description": "Industry.",
"items": {
"type": "object"
},
"required": false
},
"product_types": {
"type": "array",
"description": "Types of products sold.",
"items": {
"enum": [
"physical",
"downloads",
"subscriptions",
"memberships",
"bookings",
"product-bundles",
"product-add-ons"
],
"type": "string"
},
"required": false
},
"product_count": {
"type": "string",
"description": "Number of products to be added.",
"enum": [
"0",
"1-10",
"11-100",
"101-1000",
"1000+"
],
"required": false
},
"selling_venues": {
"type": "string",
"description": "Other places the store is selling products.",
"enum": [
"no",
"other",
"brick-mortar",
"brick-mortar-other",
"other-woocommerce"
],
"required": false
},
"number_employees": {
"type": "string",
"description": "Number of employees of the store.",
"enum": [
"1",
"\u003C10",
"10-50",
"50-250",
"+250",
"not specified"
],
"required": false
},
"revenue": {
"type": "string",
"description": "Current annual revenue of the store.",
"enum": [
"none",
"up-to-2500",
"2500-10000",
"10000-50000",
"50000-250000",
"more-than-250000",
"rather-not-say"
],
"required": false
},
"other_platform": {
"type": "string",
"description": "Name of other platform used to sell.",
"enum": [
"shopify",
"bigcommerce",
"magento",
"wix",
"amazon",
"ebay",
"etsy",
"squarespace",
"other"
],
"required": false
},
"other_platform_name": {
"type": "string",
"description": "Name of other platform used to sell (not listed).",
"required": false
},
"business_extensions": {
"type": "array",
"description": "Extra business extensions to install.",
"items": {
"type": "string"
},
"required": false
},
"theme": {
"type": "string",
"description": "Selected store theme.",
"required": false
},
"setup_client": {
"type": "boolean",
"description": "Whether or not this store was setup for a client.",
"required": false
},
"wccom_connected": {
"type": "boolean",
"description": "Whether or not the store was connected to WooCommerce.com during the extension flow.",
"required": false
},
"is_agree_marketing": {
"type": "boolean",
"description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.",
"required": false
},
"store_email": {
"type": "string",
"description": "Store email address.",
"required": false
},
"is_store_country_set": {
"type": "boolean",
"description": "Whether or not this store country is set via onboarding profiler.",
"required": false
},
"is_plugins_page_skipped": {
"type": "boolean",
"description": "Whether or not plugins step in core profiler was skipped.",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile"
}
]
}
},
"/wc-admin/onboarding/profile/experimental_get_email_prefill": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile/experimental_get_email_prefill"
}
]
}
},
"/wc-admin/onboarding/tasks/import_sample_products": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/import_sample_products"
}
]
}
},
"/wc-admin/onboarding/tasks/create_homepage": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_homepage"
}
]
}
},
"/wc-admin/onboarding/tasks/create_product_from_template": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"template_name": {
"type": "string",
"description": "Product template name.",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_product_from_template"
}
]
}
},
"/wc-admin/onboarding/tasks": {
"namespace": "wc-admin",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"ids": {
"description": "Optional parameter to get only specific task lists by ID.",
"type": "array",
"items": {
"enum": [
"setup",
"extended",
"secret_tasklist"
],
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"ids": {
"description": "Optional parameter to get only specific task lists by ID.",
"type": "array",
"items": {
"enum": [
"setup",
"extended",
"secret_tasklist"
],
"type": "string"
},
"required": false
},
"extended_tasks": {
"description": "List of extended deprecated tasks from the client-side filter.",
"type": "array",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks"
}
]
}
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/hide": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/unhide": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/dismiss": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/undo_dismiss": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_-]+)/snooze": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"duration": {
"description": "Time period to snooze the task.",
"type": "string",
"required": false
},
"task_list_id": {
"description": "Optional parameter to query specific task list.",
"type": "string",
"required": false
}
}
}
]
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/action": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/undo_snooze": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-admin/onboarding/themes/install": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/install"
}
]
}
},
"/wc-admin/onboarding/themes/activate": {
"namespace": "wc-admin",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/activate"
}
]
}
},
"/wc-admin/onboarding/themes/recommended": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"industry": {
"type": "string",
"description": "Limits the results to themes relevant for this industry (optional)",
"required": false
},
"currency": {
"type": "string",
"enum": [
"USD",
"AUD",
"CAD",
"EUR",
"GBP"
],
"default": "USD",
"description": "Returns pricing in this currency (optional, default: USD)",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/recommended"
}
]
}
},
"/wc-admin/onboarding/plugins/install-and-activate-async": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"plugins": {
"description": "A list of plugins to install",
"type": "array",
"items": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate-async"
}
]
}
},
"/wc-admin/onboarding/plugins/install-and-activate": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate"
}
]
}
},
"/wc-admin/onboarding/plugins/scheduled-installs/(?P\u003Cjob_id\u003E\\w+)": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/wc-admin/onboarding/plugins/jetpack-authorization-url": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"redirect_url": {
"description": "The URL to redirect to after authorization",
"type": "string",
"required": true
},
"from": {
"description": "from value for the jetpack authorization page",
"type": "string",
"default": "woocommerce-onboarding",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/jetpack-authorization-url"
}
]
}
},
"/wc-admin/onboarding/products": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/products"
}
]
}
},
"/wc-admin/navigation/favorites/me": {
"namespace": "wc-admin",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"item_id": {
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"item_id": {
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/navigation/favorites/me"
}
]
}
},
"/wc-admin/mobile-app/send-magic-link": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app/send-magic-link"
}
]
}
},
"/wc-admin/mobile-app": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app"
}
]
}
},
"/wc-admin/shipping-partner-suggestions": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"force_default_suggestions": {
"type": "boolean",
"description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/shipping-partner-suggestions"
}
]
}
},
"/wc-admin/launch-your-store/initialize-coming-soon": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/initialize-coming-soon"
}
]
}
},
"/wc-admin/launch-your-store/update-survey-status": {
"namespace": "wc-admin",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"status": {
"type": "string",
"enum": [
"yes",
"no"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/update-survey-status"
}
]
}
},
"/wc-admin/launch-your-store/survey-completed": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/survey-completed"
}
]
}
},
"/wc-admin/launch-your-store/woopayments/test-orders/count": {
"namespace": "wc-admin",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders/count"
}
]
}
},
"/wc-admin/launch-your-store/woopayments/test-orders": {
"namespace": "wc-admin",
"methods": [
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders"
}
]
}
},
"/wc-analytics": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc-analytics",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics"
}
]
}
},
"/wc-analytics/customers": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date_registered",
"enum": [
"username",
"name",
"country",
"city",
"state",
"postcode",
"date_registered",
"date_last_active",
"orders_count",
"total_spend",
"avg_order_value"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"registered_before": {
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"registered_after": {
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"search": {
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
"type": "string",
"required": false
},
"searchby": {
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
"type": "string",
"default": "name",
"enum": [
"name",
"username",
"email",
"all"
],
"required": false
},
"name_includes": {
"description": "Limit response to objects with specific names.",
"type": "string",
"required": false
},
"name_excludes": {
"description": "Limit response to objects excluding specific names.",
"type": "string",
"required": false
},
"username_includes": {
"description": "Limit response to objects with specific usernames.",
"type": "string",
"required": false
},
"username_excludes": {
"description": "Limit response to objects excluding specific usernames.",
"type": "string",
"required": false
},
"email_includes": {
"description": "Limit response to objects including emails.",
"type": "string",
"required": false
},
"email_excludes": {
"description": "Limit response to objects excluding emails.",
"type": "string",
"required": false
},
"country_includes": {
"description": "Limit response to objects with specific countries.",
"type": "string",
"required": false
},
"country_excludes": {
"description": "Limit response to objects excluding specific countries.",
"type": "string",
"required": false
},
"last_active_before": {
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_after": {
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"registered_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"orders_count_min": {
"description": "Limit response to objects with an order count greater than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_max": {
"description": "Limit response to objects with an order count less than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_between": {
"description": "Limit response to objects with an order count between two given integers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"total_spend_min": {
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_max": {
"description": "Limit response to objects with a total order spend less than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_between": {
"description": "Limit response to objects with a total order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"avg_order_value_min": {
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"avg_order_value_max": {
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
"type": "number",
"required": false
},
"avg_order_value_between": {
"description": "Limit response to objects with an average order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"last_order_before": {
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_order_after": {
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"users": {
"description": "Limit result to items with specified user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"filter_empty": {
"description": "Filter out results where any of the passed fields are empty",
"type": "array",
"items": {
"type": "string",
"enum": [
"email",
"name",
"country",
"city",
"state",
"postcode"
]
},
"required": false
},
"include": {
"description": "Limit result to items with specified customer IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/customers"
}
]
}
},
"/wc-analytics/customers/(?P\u003Cid\u003E[\\d-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date_registered",
"enum": [
"username",
"name",
"country",
"city",
"state",
"postcode",
"date_registered",
"date_last_active",
"orders_count",
"total_spend",
"avg_order_value"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"registered_before": {
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"registered_after": {
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"search": {
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
"type": "string",
"required": false
},
"searchby": {
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
"type": "string",
"default": "name",
"enum": [
"name",
"username",
"email",
"all"
],
"required": false
},
"name_includes": {
"description": "Limit response to objects with specific names.",
"type": "string",
"required": false
},
"name_excludes": {
"description": "Limit response to objects excluding specific names.",
"type": "string",
"required": false
},
"username_includes": {
"description": "Limit response to objects with specific usernames.",
"type": "string",
"required": false
},
"username_excludes": {
"description": "Limit response to objects excluding specific usernames.",
"type": "string",
"required": false
},
"email_includes": {
"description": "Limit response to objects including emails.",
"type": "string",
"required": false
},
"email_excludes": {
"description": "Limit response to objects excluding emails.",
"type": "string",
"required": false
},
"country_includes": {
"description": "Limit response to objects with specific countries.",
"type": "string",
"required": false
},
"country_excludes": {
"description": "Limit response to objects excluding specific countries.",
"type": "string",
"required": false
},
"last_active_before": {
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_after": {
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"registered_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"orders_count_min": {
"description": "Limit response to objects with an order count greater than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_max": {
"description": "Limit response to objects with an order count less than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_between": {
"description": "Limit response to objects with an order count between two given integers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"total_spend_min": {
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_max": {
"description": "Limit response to objects with a total order spend less than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_between": {
"description": "Limit response to objects with a total order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"avg_order_value_min": {
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"avg_order_value_max": {
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
"type": "number",
"required": false
},
"avg_order_value_between": {
"description": "Limit response to objects with an average order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"last_order_before": {
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_order_after": {
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"users": {
"description": "Limit result to items with specified user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"filter_empty": {
"description": "Filter out results where any of the passed fields are empty",
"type": "array",
"items": {
"type": "string",
"enum": [
"email",
"name",
"country",
"city",
"state",
"postcode"
]
},
"required": false
},
"include": {
"description": "Limit result to items with specified customer IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
]
},
"/wc-analytics/leaderboards": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 5,
"minimum": 1,
"maximum": 20,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"persisted_query": {
"description": "URL query to persist across links.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards"
}
]
}
},
"/wc-analytics/leaderboards/allowed": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards/allowed"
}
]
}
},
"/wc-analytics/leaderboards/(?P\u003Cleaderboard\u003E\\w+)": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"leaderboard": {
"type": "string",
"enum": [
"customers",
"coupons",
"categories",
"products"
],
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 5,
"minimum": 1,
"maximum": 20,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"persisted_query": {
"description": "URL query to persist across links.",
"type": "string",
"required": false
}
}
}
]
},
"/wc-analytics/reports": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports"
}
]
}
},
"/wc-analytics/reports/import": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"days": {
"description": "Number of days to import.",
"type": "integer",
"minimum": 0,
"required": false
},
"skip_existing": {
"description": "Skip importing existing order data.",
"type": "boolean",
"default": false,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import"
}
]
}
},
"/wc-analytics/reports/import/cancel": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/cancel"
}
]
}
},
"/wc-analytics/reports/import/delete": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/delete"
}
]
}
},
"/wc-analytics/reports/import/status": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/status"
}
]
}
},
"/wc-analytics/reports/import/totals": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"days": {
"description": "Number of days to import.",
"type": "integer",
"minimum": 0,
"required": false
},
"skip_existing": {
"description": "Skip importing existing order data.",
"type": "boolean",
"default": false,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/totals"
}
]
}
},
"/wc-analytics/reports/(?P\u003Ctype\u003E[a-z]+)/export": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"report_args": {
"description": "Parameters to pass on to the exported report.",
"type": "object",
"required": false
},
"email": {
"description": "When true, email a link to download the export to the requesting user.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc-analytics/reports/(?P\u003Ctype\u003E[a-z]+)/export/(?P\u003Cexport_id\u003E[a-z0-9]+)/status": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/wc-analytics/reports/products": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"net_revenue",
"orders_count",
"items_sold",
"product_name",
"variations",
"sku"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"categories": {
"description": "Limit result to items from the specified categories.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"products": {
"description": "Limit result to items with specified product IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"extended_info": {
"description": "Add additional piece of info about each product to the report.",
"type": "boolean",
"default": false,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products"
}
]
}
},
"/wc-analytics/reports/variations": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"net_revenue",
"orders_count",
"items_sold",
"sku"
],
"required": false
},
"product_includes": {
"description": "Limit result set to items that have the specified parent product(s).",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"product_excludes": {
"description": "Limit result set to items that don't have the specified parent product(s).",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"variations": {
"description": "Limit result to items with specified variation IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"extended_info": {
"description": "Add additional piece of info about each variation to the report.",
"type": "boolean",
"default": false,
"required": false
},
"attribute_is": {
"description": "Limit result set to variations that include the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"attribute_is_not": {
"description": "Limit result set to variations that don't include the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"category_includes": {
"description": "Limit result set to variations in the specified categories.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"category_excludes": {
"description": "Limit result set to variations not in the specified categories.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"products": {
"description": "Limit result to items with specified product IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations"
}
]
}
},
"/wc-analytics/reports/products/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"net_revenue",
"coupons",
"refunds",
"shipping",
"taxes",
"net_revenue",
"orders_count",
"items_sold"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"categories": {
"description": "Limit result to items from the specified categories.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"products": {
"description": "Limit result to items with specified product IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"variations": {
"description": "Limit result to items with specified variation IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"segmentby": {
"description": "Segment the response by additional constraint.",
"type": "string",
"enum": [
"product",
"category",
"variation"
],
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products/stats"
}
]
}
},
"/wc-analytics/reports/variations/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"net_revenue",
"coupons",
"refunds",
"shipping",
"taxes",
"net_revenue",
"orders_count",
"items_sold"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"category_includes": {
"description": "Limit result to items from the specified categories.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"category_excludes": {
"description": "Limit result set to variations not in the specified categories.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"product_includes": {
"description": "Limit result set to items that have the specified parent product(s).",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"product_excludes": {
"description": "Limit result set to items that don't have the specified parent product(s).",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"variations": {
"description": "Limit result to items with specified variation IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"segmentby": {
"description": "Segment the response by additional constraint.",
"type": "string",
"enum": [
"product",
"category",
"variation"
],
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"attribute_is": {
"description": "Limit result set to orders that include products with the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"attribute_is_not": {
"description": "Limit result set to orders that don't include products with the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations/stats"
}
]
}
},
"/wc-analytics/reports/revenue/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"total_sales",
"coupons",
"refunds",
"shipping",
"taxes",
"net_revenue",
"orders_count",
"items_sold",
"gross_sales"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"segmentby": {
"description": "Segment the response by additional constraint.",
"type": "string",
"enum": [
"product",
"category",
"variation",
"coupon",
"customer_type"
],
"required": false
},
"date_type": {
"description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.",
"type": "string",
"enum": [
"date_paid",
"date_created",
"date_completed"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/revenue/stats"
}
]
}
},
"/wc-analytics/reports/orders": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"num_items_sold",
"net_total"
],
"required": false
},
"product_includes": {
"description": "Limit result set to items that have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"product_excludes": {
"description": "Limit result set to items that don't have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"variation_includes": {
"description": "Limit result set to items that have the specified variation(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"variation_excludes": {
"description": "Limit result set to items that don't have the specified variation(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"coupon_includes": {
"description": "Limit result set to items that have the specified coupon(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"coupon_excludes": {
"description": "Limit result set to items that don't have the specified coupon(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tax_rate_includes": {
"description": "Limit result set to items that have the specified tax rate(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tax_rate_excludes": {
"description": "Limit result set to items that don't have the specified tax rate(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"status_is": {
"description": "Limit result set to items that have the specified order status.",
"type": "array",
"items": {
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"type": "string"
},
"required": false
},
"status_is_not": {
"description": "Limit result set to items that don't have the specified order status.",
"type": "array",
"items": {
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"type": "string"
},
"required": false
},
"customer_type": {
"description": "Limit result set to returning or new customers.",
"type": "string",
"default": "",
"enum": [
"",
"returning",
"new"
],
"required": false
},
"refunds": {
"description": "Limit result set to specific types of refunds.",
"type": "string",
"default": "",
"enum": [
"",
"all",
"partial",
"full",
"none"
],
"required": false
},
"extended_info": {
"description": "Add additional piece of info about each coupon to the report.",
"type": "boolean",
"default": false,
"required": false
},
"order_includes": {
"description": "Limit result set to items that have the specified order IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"order_excludes": {
"description": "Limit result set to items that don't have the specified order IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"attribute_is": {
"description": "Limit result set to orders that include products with the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"attribute_is_not": {
"description": "Limit result set to orders that don't include products with the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders"
}
]
}
},
"/wc-analytics/reports/orders/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"net_revenue",
"orders_count",
"avg_order_value"
],
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"status_is": {
"description": "Limit result set to items that have the specified order status.",
"type": "array",
"default": null,
"items": {
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"type": "string"
},
"required": false
},
"status_is_not": {
"description": "Limit result set to items that don't have the specified order status.",
"type": "array",
"items": {
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"type": "string"
},
"required": false
},
"product_includes": {
"description": "Limit result set to items that have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"product_excludes": {
"description": "Limit result set to items that don't have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"variation_includes": {
"description": "Limit result set to items that have the specified variation(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"variation_excludes": {
"description": "Limit result set to items that don't have the specified variation(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"coupon_includes": {
"description": "Limit result set to items that have the specified coupon(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"coupon_excludes": {
"description": "Limit result set to items that don't have the specified coupon(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tax_rate_includes": {
"description": "Limit result set to items that have the specified tax rate(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tax_rate_excludes": {
"description": "Limit result set to items that don't have the specified tax rate(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"customer": {
"description": "Alias for customer_type (deprecated).",
"type": "string",
"enum": [
"new",
"returning"
],
"required": false
},
"customer_type": {
"description": "Limit result set to orders that have the specified customer_type",
"type": "string",
"enum": [
"new",
"returning"
],
"required": false
},
"refunds": {
"description": "Limit result set to specific types of refunds.",
"type": "string",
"default": "",
"enum": [
"",
"all",
"partial",
"full",
"none"
],
"required": false
},
"attribute_is": {
"description": "Limit result set to orders that include products with the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"attribute_is_not": {
"description": "Limit result set to orders that don't include products with the specified attributes.",
"type": "array",
"items": {
"type": "array"
},
"default": [],
"required": false
},
"segmentby": {
"description": "Segment the response by additional constraint.",
"type": "string",
"enum": [
"product",
"category",
"variation",
"coupon",
"customer_type"
],
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders/stats"
}
]
}
},
"/wc-analytics/reports/categories": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "category_id",
"enum": [
"category_id",
"items_sold",
"net_revenue",
"orders_count",
"products_count",
"category"
],
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"status_is": {
"description": "Limit result set to items that have the specified order status.",
"type": "array",
"items": {
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"type": "string"
},
"required": false
},
"status_is_not": {
"description": "Limit result set to items that don't have the specified order status.",
"type": "array",
"items": {
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"type": "string"
},
"required": false
},
"categories": {
"description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"extended_info": {
"description": "Add additional piece of info about each category to the report.",
"type": "boolean",
"default": false,
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/categories"
}
]
}
},
"/wc-analytics/reports/taxes": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "tax_rate_id",
"enum": [
"name",
"tax_rate_id",
"tax_code",
"rate",
"order_tax",
"total_tax",
"shipping_tax",
"orders_count"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"taxes": {
"description": "Limit result set to items assigned one or more tax rates.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes"
}
]
}
},
"/wc-analytics/reports/taxes/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"items_sold",
"total_sales",
"orders_count",
"products_count"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"taxes": {
"description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"segmentby": {
"description": "Segment the response by additional constraint.",
"type": "string",
"enum": [
"tax_rate_id"
],
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes/stats"
}
]
}
},
"/wc-analytics/reports/coupons": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "coupon_id",
"enum": [
"coupon_id",
"code",
"amount",
"orders_count"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"coupons": {
"description": "Limit result set to coupons assigned specific coupon IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"extended_info": {
"description": "Add additional piece of info about each coupon to the report.",
"type": "boolean",
"default": false,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons"
}
]
}
},
"/wc-analytics/reports/coupons/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"amount",
"coupons_count",
"orders_count"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"coupons": {
"description": "Limit result set to coupons assigned specific coupon IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"segmentby": {
"description": "Segment the response by additional constraint.",
"type": "string",
"enum": [
"product",
"variation",
"category",
"coupon"
],
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons/stats"
}
]
}
},
"/wc-analytics/reports/stock": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "stock_status",
"enum": [
"stock_status",
"stock_quantity",
"date",
"id",
"include",
"title",
"sku"
],
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"type": {
"description": "Limit result set to items assigned a stock report type.",
"type": "string",
"default": "all",
"enum": [
"all",
"lowstock",
"instock",
"outofstock",
"onbackorder"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock"
}
]
}
},
"/wc-analytics/reports/stock/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock/stats"
}
]
}
},
"/wc-analytics/reports/downloads": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"product"
],
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"product_includes": {
"description": "Limit result set to items that have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"product_excludes": {
"description": "Limit result set to items that don't have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order_includes": {
"description": "Limit result set to items that have the specified order IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"order_excludes": {
"description": "Limit result set to items that don't have the specified order IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"customer_includes": {
"description": "Limit response to objects that have the specified user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"customer_excludes": {
"description": "Limit response to objects that don't have the specified user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"ip_address_includes": {
"description": "Limit response to objects that have a specified IP address.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"ip_address_excludes": {
"description": "Limit response to objects that don't have a specified IP address.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads"
}
]
}
},
"/wc-analytics/reports/downloads/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"download_count"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"interval": {
"description": "Time interval to use for buckets in the returned data.",
"type": "string",
"default": "week",
"enum": [
"hour",
"day",
"week",
"month",
"quarter",
"year"
],
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"product_includes": {
"description": "Limit result set to items that have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"product_excludes": {
"description": "Limit result set to items that don't have the specified product(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order_includes": {
"description": "Limit result set to items that have the specified order IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"order_excludes": {
"description": "Limit result set to items that don't have the specified order IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"customer_includes": {
"description": "Limit response to objects that have the specified customer IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"customer_excludes": {
"description": "Limit response to objects that don't have the specified customer IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"ip_address_includes": {
"description": "Limit response to objects that have a specified IP address.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"ip_address_excludes": {
"description": "Limit response to objects that don't have a specified IP address.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads/stats"
}
]
}
},
"/wc-analytics/reports/customers": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date_registered",
"enum": [
"username",
"name",
"country",
"city",
"state",
"postcode",
"date_registered",
"date_last_active",
"orders_count",
"total_spend",
"avg_order_value"
],
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
},
"registered_before": {
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"registered_after": {
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"search": {
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
"type": "string",
"required": false
},
"searchby": {
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
"type": "string",
"default": "name",
"enum": [
"name",
"username",
"email",
"all"
],
"required": false
},
"name_includes": {
"description": "Limit response to objects with specific names.",
"type": "string",
"required": false
},
"name_excludes": {
"description": "Limit response to objects excluding specific names.",
"type": "string",
"required": false
},
"username_includes": {
"description": "Limit response to objects with specific usernames.",
"type": "string",
"required": false
},
"username_excludes": {
"description": "Limit response to objects excluding specific usernames.",
"type": "string",
"required": false
},
"email_includes": {
"description": "Limit response to objects including emails.",
"type": "string",
"required": false
},
"email_excludes": {
"description": "Limit response to objects excluding emails.",
"type": "string",
"required": false
},
"country_includes": {
"description": "Limit response to objects with specific countries.",
"type": "string",
"required": false
},
"country_excludes": {
"description": "Limit response to objects excluding specific countries.",
"type": "string",
"required": false
},
"last_active_before": {
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_after": {
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"registered_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"orders_count_min": {
"description": "Limit response to objects with an order count greater than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_max": {
"description": "Limit response to objects with an order count less than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_between": {
"description": "Limit response to objects with an order count between two given integers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"total_spend_min": {
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_max": {
"description": "Limit response to objects with a total order spend less than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_between": {
"description": "Limit response to objects with a total order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"avg_order_value_min": {
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"avg_order_value_max": {
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
"type": "number",
"required": false
},
"avg_order_value_between": {
"description": "Limit response to objects with an average order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"last_order_before": {
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_order_after": {
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"customers": {
"description": "Limit result to items with specified customer IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"users": {
"description": "Limit result to items with specified user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"filter_empty": {
"description": "Filter out results where any of the passed fields are empty",
"type": "array",
"items": {
"type": "string",
"enum": [
"email",
"name",
"country",
"city",
"state",
"postcode"
]
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers"
}
]
}
},
"/wc-analytics/reports/customers/stats": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"registered_before": {
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"registered_after": {
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"match": {
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
"type": "string",
"default": "all",
"enum": [
"all",
"any"
],
"required": false
},
"search": {
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
"type": "string",
"required": false
},
"searchby": {
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
"type": "string",
"default": "name",
"enum": [
"name",
"username",
"email",
"all"
],
"required": false
},
"name_includes": {
"description": "Limit response to objects with specific names.",
"type": "string",
"required": false
},
"name_excludes": {
"description": "Limit response to objects excluding specific names.",
"type": "string",
"required": false
},
"username_includes": {
"description": "Limit response to objects with specific usernames.",
"type": "string",
"required": false
},
"username_excludes": {
"description": "Limit response to objects excluding specific usernames.",
"type": "string",
"required": false
},
"email_includes": {
"description": "Limit response to objects including emails.",
"type": "string",
"required": false
},
"email_excludes": {
"description": "Limit response to objects excluding emails.",
"type": "string",
"required": false
},
"country_includes": {
"description": "Limit response to objects with specific countries.",
"type": "string",
"required": false
},
"country_excludes": {
"description": "Limit response to objects excluding specific countries.",
"type": "string",
"required": false
},
"last_active_before": {
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_after": {
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_active_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"registered_between": {
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"orders_count_min": {
"description": "Limit response to objects with an order count greater than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_max": {
"description": "Limit response to objects with an order count less than or equal to given integer.",
"type": "integer",
"required": false
},
"orders_count_between": {
"description": "Limit response to objects with an order count between two given integers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"total_spend_min": {
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_max": {
"description": "Limit response to objects with a total order spend less than or equal to given number.",
"type": "number",
"required": false
},
"total_spend_between": {
"description": "Limit response to objects with a total order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"avg_order_value_min": {
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
"type": "number",
"required": false
},
"avg_order_value_max": {
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
"type": "number",
"required": false
},
"avg_order_value_between": {
"description": "Limit response to objects with an average order spend between two given numbers.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"last_order_before": {
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"last_order_after": {
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
"type": "string",
"format": "date-time",
"required": false
},
"customers": {
"description": "Limit result to items with specified customer IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"fields": {
"description": "Limit stats fields to the specified items.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"force_cache_refresh": {
"description": "Force retrieval of fresh data instead of from the cache.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers/stats"
}
]
}
},
"/wc-analytics/reports/performance-indicators": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"stats": {
"description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.",
"type": "array",
"items": {
"type": "string",
"enum": [
"revenue/total_sales",
"revenue/net_revenue",
"revenue/shipping",
"revenue/refunds",
"revenue/gross_sales",
"orders/orders_count",
"orders/avg_order_value",
"products/items_sold",
"variations/items_sold",
"coupons/amount",
"coupons/orders_count",
"taxes/total_tax",
"taxes/order_tax",
"taxes/shipping_tax",
"downloads/download_count"
]
},
"default": [
"revenue/total_sales",
"revenue/net_revenue",
"revenue/shipping",
"revenue/refunds",
"revenue/gross_sales",
"orders/orders_count",
"orders/avg_order_value",
"products/items_sold",
"variations/items_sold",
"coupons/amount",
"coupons/orders_count",
"taxes/total_tax",
"taxes/order_tax",
"taxes/shipping_tax",
"downloads/download_count"
],
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators"
}
]
}
},
"/wc-analytics/reports/performance-indicators/allowed": {
"namespace": "wc-analytics",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"stats": {
"description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.",
"type": "array",
"items": {
"type": "string",
"enum": [
"revenue/total_sales",
"revenue/net_revenue",
"revenue/shipping",
"revenue/refunds",
"revenue/gross_sales",
"orders/orders_count",
"orders/avg_order_value",
"products/items_sold",
"variations/items_sold",
"coupons/amount",
"coupons/orders_count",
"taxes/total_tax",
"taxes/order_tax",
"taxes/shipping_tax",
"downloads/download_count"
]
},
"default": [
"revenue/total_sales",
"revenue/net_revenue",
"revenue/shipping",
"revenue/refunds",
"revenue/gross_sales",
"orders/orders_count",
"orders/avg_order_value",
"products/items_sold",
"variations/items_sold",
"coupons/amount",
"coupons/orders_count",
"taxes/total_tax",
"taxes/order_tax",
"taxes/shipping_tax",
"downloads/download_count"
],
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators/allowed"
}
]
}
},
"/wc-analytics/admin/notes": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"note_id",
"date",
"type",
"title",
"status"
],
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"type": {
"description": "Type of note.",
"type": "array",
"items": {
"enum": [
"error",
"warning",
"update",
"info",
"marketing",
"survey",
"email"
],
"type": "string"
},
"required": false
},
"status": {
"description": "Status of note.",
"type": "array",
"items": {
"enum": [
"pending",
"actioned",
"unactioned",
"snoozed",
"sent"
],
"type": "string"
},
"required": false
},
"source": {
"description": "Source of note.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"note_id",
"date",
"type",
"title",
"status"
],
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"type": {
"description": "Type of note.",
"type": "array",
"items": {
"enum": [
"error",
"warning",
"update",
"info",
"marketing",
"survey",
"email"
],
"type": "string"
},
"required": false
},
"status": {
"description": "Status of note.",
"type": "array",
"items": {
"enum": [
"pending",
"actioned",
"unactioned",
"snoozed",
"sent"
],
"type": "string"
},
"required": false
},
"source": {
"description": "Source of note.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes"
}
]
}
},
"/wc-analytics/admin/notes/(?P\u003Cid\u003E[\\d-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/admin/notes/delete/(?P\u003Cid\u003E[\\d-]+)": {
"namespace": "wc-analytics",
"methods": [
"DELETE",
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": []
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"/wc-analytics/admin/notes/delete/all": {
"namespace": "wc-analytics",
"methods": [
"DELETE",
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": {
"status": {
"description": "Status of note.",
"type": "array",
"items": {
"enum": [
"pending",
"actioned",
"unactioned",
"snoozed",
"sent"
],
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"status": {
"description": "Status of note.",
"type": "array",
"items": {
"enum": [
"pending",
"actioned",
"unactioned",
"snoozed",
"sent"
],
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/delete/all"
}
]
}
},
"/wc-analytics/admin/notes/tracker/(?P\u003Cnote_id\u003E[\\d-]+)/user/(?P\u003Cuser_id\u003E[\\d-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"GET"
],
"args": []
}
]
},
"/wc-analytics/admin/notes/update": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/update"
}
]
}
},
"/wc-analytics/admin/notes/experimental-activate-promo/(?P\u003Cpromo_note_name\u003E[\\w-]+)": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
]
},
"/wc-analytics/admin/notes/(?P\u003Cnote_id\u003E[\\d-]+)/action/(?P\u003Caction_id\u003E[\\d-]+)": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"note_id": {
"description": "Unique ID for the Note.",
"type": "integer",
"required": false
},
"action_id": {
"description": "Unique ID for the Note Action.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"note_id": {
"description": "Unique ID for the Note.",
"type": "integer",
"required": false
},
"action_id": {
"description": "Unique ID for the Note Action.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/coupons": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to coupons with codes matching a given string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"code": {
"description": "Limit result set to resources with a specific code.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": true
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"default": "fixed_cart",
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"default": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"default": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"default": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to coupons with codes matching a given string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"code": {
"description": "Limit result set to resources with a specific code.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": true
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"default": "fixed_cart",
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"default": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"default": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"default": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons"
}
]
}
},
"/wc-analytics/coupons/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc-analytics/coupons/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons/batch"
}
]
}
},
"/wc-analytics/data": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data"
}
]
}
},
"/wc-analytics/data/countries/locales": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries/locales"
}
]
}
},
"/wc-analytics/data/countries": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries"
}
]
}
},
"/wc-analytics/data/countries/(?P\u003Clocation\u003E[\\w-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"description": "ISO3166 alpha-2 country code.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"location": {
"description": "ISO3166 alpha-2 country code.",
"type": "string",
"required": false
}
}
}
]
},
"/wc-analytics/data/download-ips": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/download-ips"
}
]
}
},
"/wc-analytics/orders": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"status": {
"default": [
"any"
],
"description": "Limit result set to orders which have specific statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
]
},
"required": false
},
"customer": {
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to orders assigned a specific product.",
"type": "integer",
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"number": {
"description": "Limit result set to orders matching part of an order number.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"default": "pending",
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"default": "EUR",
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"default": 0,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"default": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"default": false,
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"status": {
"default": [
"any"
],
"description": "Limit result set to orders which have specific statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
]
},
"required": false
},
"customer": {
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to orders assigned a specific product.",
"type": "integer",
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"number": {
"description": "Limit result set to orders matching part of an order number.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"default": "pending",
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"default": "EUR",
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"default": 0,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"default": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"default": false,
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders"
}
]
}
},
"/wc-analytics/orders/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc-analytics/orders/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders/batch"
}
]
}
},
"/wc-analytics/products": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name or SKU.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order",
"price",
"popularity",
"rating"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"search_sku": {
"description": "Limit results to those with a SKU that partially matches a string.",
"type": "string",
"required": false
},
"low_in_stock": {
"description": "Limit result set to products that are low or out of stock. (Deprecated)",
"type": "boolean",
"default": false,
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"default": "simple",
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"default": "publish",
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"default": false,
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"default": "visible",
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"default": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"default": true,
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name or SKU.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order",
"price",
"popularity",
"rating"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"search_sku": {
"description": "Limit results to those with a SKU that partially matches a string.",
"type": "string",
"required": false
},
"low_in_stock": {
"description": "Limit result set to products that are low or out of stock. (Deprecated)",
"type": "boolean",
"default": false,
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"default": "simple",
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"default": "publish",
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"default": false,
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"default": "visible",
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"default": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"default": true,
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products"
}
]
}
},
"/wc-analytics/products/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc-analytics/products/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/batch"
}
]
}
},
"/wc-analytics/products/suggested-products": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"in_stock": {
"description": "Limit result set to products in stock or out of stock.",
"type": "boolean",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"categories": {
"description": "Limit result set to specific product categorie ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tags": {
"description": "Limit result set to specific product tag ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"limit": {
"description": "Limit result set to specific amount of suggested products.",
"type": "integer",
"default": 5,
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"in_stock": {
"description": "Limit result set to products in stock or out of stock.",
"type": "boolean",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"categories": {
"description": "Limit result set to specific product categorie ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tags": {
"description": "Limit result set to specific product tag ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"limit": {
"description": "Limit result set to specific amount of suggested products.",
"type": "integer",
"default": 5,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/suggested-products"
}
]
}
},
"/wc-analytics/products/(?P\u003Cid\u003E[\\d]+)/duplicate": {
"namespace": "wc-analytics",
"methods": [
"POST",
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc-analytics/products/attributes": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"search": {
"description": "Search by similar attribute name.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Name for the resource.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"default": "select",
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"default": "menu_order",
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"default": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"search": {
"description": "Search by similar attribute name.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Name for the resource.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"default": "select",
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"default": "menu_order",
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"default": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes"
}
]
}
},
"/wc-analytics/products/attributes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc-analytics/products/attributes/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes/batch"
}
]
}
},
"/wc-analytics/products/attributes/(?P\u003Cslug\u003E[a-z0-9_\\-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Slug identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Slug identifier for the resource.",
"type": "string",
"required": false
}
}
}
]
},
"/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/products/attributes/(?P\u003Cslug\u003E[a-z0-9_\\-]+)/terms": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
}
}
}
]
},
"/wc-analytics/products/categories": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"default": "default",
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"default": "default",
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories"
}
]
}
},
"/wc-analytics/products/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc-analytics/products/categories/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories/batch"
}
]
}
},
"/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST",
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/generate": {
"namespace": "wc-analytics",
"methods": [
"POST",
"POST",
"POST",
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"delete": {
"description": "Deletes unused variations.",
"type": "boolean",
"required": false
},
"default_values": {
"description": "Default values for generated variations.",
"type": "object",
"properties": {
"type": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
]
},
"description": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation description.",
"type": "string"
},
"sku": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock Keeping Unit.",
"type": "string"
},
"global_unique_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string"
},
"regular_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_from_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
]
},
"date_on_sale_to": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_to_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
]
},
"virtual": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
]
},
"tax_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
]
},
"backorders": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
]
},
"low_stock_amount": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
]
},
"weight": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation weight (kg).",
"type": "string"
},
"dimensions": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
},
"name": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent name.",
"type": "string"
},
"parent_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent ID.",
"type": "integer"
}
},
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"delete": {
"description": "Deletes unused variations.",
"type": "boolean",
"required": false
},
"default_values": {
"description": "Default values for generated variations.",
"type": "object",
"properties": {
"type": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
]
},
"description": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation description.",
"type": "string"
},
"sku": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock Keeping Unit.",
"type": "string"
},
"global_unique_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string"
},
"regular_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_from_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
]
},
"date_on_sale_to": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_to_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
]
},
"virtual": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
]
},
"tax_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
]
},
"backorders": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
]
},
"low_stock_amount": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
]
},
"weight": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation weight (kg).",
"type": "string"
},
"dimensions": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
},
"name": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent name.",
"type": "string"
},
"parent_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent ID.",
"type": "integer"
}
},
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"delete": {
"description": "Deletes unused variations.",
"type": "boolean",
"required": false
},
"default_values": {
"description": "Default values for generated variations.",
"type": "object",
"properties": {
"type": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
]
},
"description": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation description.",
"type": "string"
},
"sku": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock Keeping Unit.",
"type": "string"
},
"global_unique_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string"
},
"regular_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_from_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
]
},
"date_on_sale_to": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_to_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
]
},
"virtual": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
]
},
"tax_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
]
},
"backorders": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
]
},
"low_stock_amount": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
]
},
"weight": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation weight (kg).",
"type": "string"
},
"dimensions": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
},
"name": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent name.",
"type": "string"
},
"parent_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent ID.",
"type": "integer"
}
},
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"delete": {
"description": "Deletes unused variations.",
"type": "boolean",
"required": false
},
"default_values": {
"description": "Default values for generated variations.",
"type": "object",
"properties": {
"type": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
]
},
"description": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation description.",
"type": "string"
},
"sku": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock Keeping Unit.",
"type": "string"
},
"global_unique_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string"
},
"regular_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_from_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
]
},
"date_on_sale_to": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_to_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
]
},
"virtual": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
]
},
"tax_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
]
},
"backorders": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
]
},
"low_stock_amount": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
]
},
"weight": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation weight (kg).",
"type": "string"
},
"dimensions": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
},
"name": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent name.",
"type": "string"
},
"parent_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Product parent ID.",
"type": "integer"
}
},
"required": false
},
"type": {
"default": "variation",
"description": "Product type.",
"type": "string",
"enum": [
"variation"
],
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"name": {
"description": "Product parent name.",
"type": "string",
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-analytics/variations": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET",
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Search by similar product name, SKU, or attribute value.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/variations"
}
]
}
},
"/wc-analytics/products/reviews": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to reviews published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date_gmt",
"enum": [
"date",
"date_gmt",
"id",
"include",
"product"
],
"required": false
},
"reviewer": {
"description": "Limit result set to reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"reviewer_exclude": {
"description": "Ensure result set excludes reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"reviewer_email": {
"default": null,
"description": "Limit result set to that from a specific author email.",
"format": "email",
"type": "string",
"required": false
},
"product": {
"default": [],
"description": "Limit result set to reviews assigned to specific product IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"status": {
"default": "approved",
"description": "Limit result set to reviews assigned a specific status.",
"type": "string",
"enum": [
"all",
"hold",
"approved",
"spam",
"trash"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the product.",
"type": "integer",
"required": true
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"default": "approved",
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"type": "string",
"description": "Name of the reviewer.",
"required": true
},
"reviewer_email": {
"type": "string",
"description": "Email of the reviewer.",
"required": true
},
"review": {
"type": "string",
"description": "Review content.",
"required": true
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to reviews published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date_gmt",
"enum": [
"date",
"date_gmt",
"id",
"include",
"product"
],
"required": false
},
"reviewer": {
"description": "Limit result set to reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"reviewer_exclude": {
"description": "Ensure result set excludes reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"reviewer_email": {
"default": null,
"description": "Limit result set to that from a specific author email.",
"format": "email",
"type": "string",
"required": false
},
"product": {
"default": [],
"description": "Limit result set to reviews assigned to specific product IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"status": {
"default": "approved",
"description": "Limit result set to reviews assigned a specific status.",
"type": "string",
"enum": [
"all",
"hold",
"approved",
"spam",
"trash"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the product.",
"type": "integer",
"required": true
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"default": "approved",
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"type": "string",
"description": "Name of the reviewer.",
"required": true
},
"reviewer_email": {
"type": "string",
"description": "Email of the reviewer.",
"required": true
},
"review": {
"type": "string",
"description": "Review content.",
"required": true
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews"
}
]
}
},
"/wc-analytics/products/reviews/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"product_id": {
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer",
"required": false
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"reviewer_email": {
"description": "Reviewer email.",
"type": "string",
"format": "email",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"product_id": {
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer",
"required": false
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"reviewer_email": {
"description": "Reviewer email.",
"type": "string",
"format": "email",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc-analytics/products/reviews/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer",
"required": false
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"reviewer_email": {
"description": "Reviewer email.",
"type": "string",
"format": "email",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer",
"required": false
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"reviewer_email": {
"description": "Reviewer email.",
"type": "string",
"format": "email",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews/batch"
}
]
}
},
"/wc-analytics/products/low-in-stock": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/low-in-stock"
}
]
}
},
"/wc-analytics/products/count-low-in-stock": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/count-low-in-stock"
}
]
}
},
"/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
}
}
}
]
},
"/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
}
]
},
"/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
}
]
},
"/wc-analytics/taxes": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "order",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"order",
"priority"
],
"type": "string",
"required": false
},
"class": {
"description": "Sort by tax class.",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"type": "string",
"required": false
},
"search": {
"description": "Search by similar tax code.",
"type": "string",
"required": false
},
"include": {
"description": "Limit result set to items that have the specified rate ID(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"default": 1,
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"default": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"default": true,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"default": "standard",
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "order",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"order",
"priority"
],
"type": "string",
"required": false
},
"class": {
"description": "Sort by tax class.",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"type": "string",
"required": false
},
"search": {
"description": "Search by similar tax code.",
"type": "string",
"required": false
},
"include": {
"description": "Limit result set to items that have the specified rate ID(s) assigned.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"default": 1,
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"default": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"default": true,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"default": "standard",
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes"
}
]
}
},
"/wc-analytics/taxes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc-analytics",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc-analytics/taxes/batch": {
"namespace": "wc-analytics",
"methods": [
"POST",
"PUT",
"PATCH",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes/batch"
}
]
}
},
"/wc/store": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc/store",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store"
}
]
}
},
"/wc/store/batch": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"validation": {
"type": "string",
"enum": [
"require-all-validate",
"normal"
],
"default": "normal",
"required": false
},
"requests": {
"type": "array",
"maxItems": 25,
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": [
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "POST"
},
"path": {
"type": "string",
"required": true
},
"body": {
"type": "object",
"properties": [],
"additionalProperties": true
},
"headers": {
"type": "object",
"properties": [],
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/batch"
}
]
}
},
"/wc/store/cart": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart"
}
]
}
},
"/wc/store/cart/add-item": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "The basket item product or variation ID.",
"type": "integer",
"required": false
},
"quantity": {
"description": "Quantity of this item to add to the basket.",
"type": "integer",
"required": false
},
"variation": {
"description": "Chosen attributes (for variations).",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"description": "Variation attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Variation attribute value.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/add-item"
}
]
}
},
"/wc/store/cart/apply-coupon": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/apply-coupon"
}
]
}
},
"/wc/store/cart/coupons": {
"namespace": "wc/store",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "The coupon's unique code.",
"type": "string",
"required": false
},
"discount_type": {
"description": "The discount type for the coupon (eg percentage or fixed amount)",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/coupons"
}
]
}
},
"/wc/store/cart/coupons/(?P\u003Ccode\u003E[\\w-]+)": {
"namespace": "wc/store",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/store/cart/extensions": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"namespace": {
"description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.",
"type": "string",
"required": false
},
"data": {
"description": "Additional data to pass to the extension",
"type": "object",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/extensions"
}
]
}
},
"/wc/store/cart/items": {
"namespace": "wc/store",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"extensions": {
"type": "object",
"properties": [],
"default": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/items"
}
]
}
},
"/wc/store/cart/items/(?P\u003Ckey\u003E[\\w-]{32})": {
"namespace": "wc/store",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier for the item within the basket.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier for the item within the basket.",
"type": "string",
"required": false
},
"extensions": {
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier for the item within the basket.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/store/cart/remove-coupon": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-coupon"
}
]
}
},
"/wc/store/cart/remove-item": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier (key) for the basket item.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-item"
}
]
}
},
"/wc/store/cart/select-shipping-rate": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"package_id": {
"description": "The ID of the package being shipped. Leave blank to apply to all packages.",
"type": [
"integer",
"string",
"null"
],
"required": false
},
"rate_id": {
"description": "The chosen rate ID for the package.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/select-shipping-rate"
}
]
}
},
"/wc/store/cart/update-item": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier (key) for the basket item to update.",
"type": "string",
"required": false
},
"quantity": {
"description": "New quantity of the item in the basket.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-item"
}
]
}
},
"/wc/store/cart/update-customer": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"billing_address": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"email": {
"description": "Email",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
},
"shipping_address": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-customer"
}
]
}
},
"/wc/store/checkout": {
"namespace": "wc/store",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"payment_data": {
"description": "Data to pass through to the payment method when processing payment.",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": [
"string",
"boolean"
]
}
}
},
"required": false
},
"customer_password": {
"description": "Customer password for new accounts, if applicable.",
"type": "string",
"required": false
},
"customer_note": {
"description": "Note added to the order by the customer during checkout.",
"type": "string",
"required": false
},
"billing_address": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"email": {
"description": "Email",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": true
},
"shipping_address": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
},
"payment_method": {
"description": "The ID of the payment method being used to process the payment.",
"type": "string",
"enum": [
"bacs",
"cheque",
"cod"
],
"required": false
},
"create_account": {
"description": "Whether to create a new user account as part of order processing.",
"type": "boolean",
"required": false
},
"additional_fields": {
"description": "Additional fields to be persisted on the order.",
"type": "object",
"properties": [],
"required": false
},
"extensions": {
"type": "object",
"properties": {
"woocommerce/order-attribution": {
"description": "Extension data registered by woocommerce/order-attribution",
"type": [
"object",
"null"
],
"context": [
"view",
"edit"
],
"properties": {
"source_type": {
"description": "Order attribution field: source_type",
"type": [
"string",
"null"
],
"context": []
},
"referrer": {
"description": "Order attribution field: referrer",
"type": [
"string",
"null"
],
"context": []
},
"utm_campaign": {
"description": "Order attribution field: utm_campaign",
"type": [
"string",
"null"
],
"context": []
},
"utm_source": {
"description": "Order attribution field: utm_source",
"type": [
"string",
"null"
],
"context": []
},
"utm_medium": {
"description": "Order attribution field: utm_medium",
"type": [
"string",
"null"
],
"context": []
},
"utm_content": {
"description": "Order attribution field: utm_content",
"type": [
"string",
"null"
],
"context": []
},
"utm_id": {
"description": "Order attribution field: utm_id",
"type": [
"string",
"null"
],
"context": []
},
"utm_term": {
"description": "Order attribution field: utm_term",
"type": [
"string",
"null"
],
"context": []
},
"utm_source_platform": {
"description": "Order attribution field: utm_source_platform",
"type": [
"string",
"null"
],
"context": []
},
"utm_creative_format": {
"description": "Order attribution field: utm_creative_format",
"type": [
"string",
"null"
],
"context": []
},
"utm_marketing_tactic": {
"description": "Order attribution field: utm_marketing_tactic",
"type": [
"string",
"null"
],
"context": []
},
"session_entry": {
"description": "Order attribution field: session_entry",
"type": [
"string",
"null"
],
"context": []
},
"session_start_time": {
"description": "Order attribution field: session_start_time",
"type": [
"string",
"null"
],
"context": []
},
"session_pages": {
"description": "Order attribution field: session_pages",
"type": [
"string",
"null"
],
"context": []
},
"session_count": {
"description": "Order attribution field: session_count",
"type": [
"string",
"null"
],
"context": []
},
"user_agent": {
"description": "Order attribution field: user_agent",
"type": [
"string",
"null"
],
"context": []
}
}
}
},
"default": {
"woocommerce/order-attribution": []
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/checkout"
}
]
}
},
"/wc/store/checkout/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"payment_data": {
"description": "Data to pass through to the payment method when processing payment.",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": [
"string",
"boolean"
]
}
}
},
"required": false
},
"customer_note": {
"description": "Note added to the order by the customer during checkout.",
"type": "string",
"required": false
},
"billing_address": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"email": {
"description": "Email",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": true
},
"shipping_address": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
},
"payment_method": {
"description": "The ID of the payment method being used to process the payment.",
"type": "string",
"enum": [
"bacs",
"cheque",
"cod"
],
"required": false
},
"additional_fields": {
"description": "Additional fields to be persisted on the order.",
"type": "object",
"properties": [],
"required": false
},
"extensions": {
"type": "object",
"properties": {
"woocommerce/order-attribution": {
"description": "Extension data registered by woocommerce/order-attribution",
"type": [
"object",
"null"
],
"context": [
"view",
"edit"
],
"properties": {
"source_type": {
"description": "Order attribution field: source_type",
"type": [
"string",
"null"
],
"context": []
},
"referrer": {
"description": "Order attribution field: referrer",
"type": [
"string",
"null"
],
"context": []
},
"utm_campaign": {
"description": "Order attribution field: utm_campaign",
"type": [
"string",
"null"
],
"context": []
},
"utm_source": {
"description": "Order attribution field: utm_source",
"type": [
"string",
"null"
],
"context": []
},
"utm_medium": {
"description": "Order attribution field: utm_medium",
"type": [
"string",
"null"
],
"context": []
},
"utm_content": {
"description": "Order attribution field: utm_content",
"type": [
"string",
"null"
],
"context": []
},
"utm_id": {
"description": "Order attribution field: utm_id",
"type": [
"string",
"null"
],
"context": []
},
"utm_term": {
"description": "Order attribution field: utm_term",
"type": [
"string",
"null"
],
"context": []
},
"utm_source_platform": {
"description": "Order attribution field: utm_source_platform",
"type": [
"string",
"null"
],
"context": []
},
"utm_creative_format": {
"description": "Order attribution field: utm_creative_format",
"type": [
"string",
"null"
],
"context": []
},
"utm_marketing_tactic": {
"description": "Order attribution field: utm_marketing_tactic",
"type": [
"string",
"null"
],
"context": []
},
"session_entry": {
"description": "Order attribution field: session_entry",
"type": [
"string",
"null"
],
"context": []
},
"session_start_time": {
"description": "Order attribution field: session_start_time",
"type": [
"string",
"null"
],
"context": []
},
"session_pages": {
"description": "Order attribution field: session_pages",
"type": [
"string",
"null"
],
"context": []
},
"session_count": {
"description": "Order attribution field: session_count",
"type": [
"string",
"null"
],
"context": []
},
"user_agent": {
"description": "Order attribution field: user_agent",
"type": [
"string",
"null"
],
"context": []
}
}
}
},
"default": {
"woocommerce/order-attribution": []
},
"required": false
}
}
}
]
},
"/wc/store/order/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/products/attributes": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/attributes"
}
]
}
},
"/wc/store/products/attributes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Sort ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort by term property.",
"type": "string",
"default": "name",
"enum": [
"name",
"slug",
"count",
"menu_order",
"name_num",
"id"
],
"required": false
},
"hide_empty": {
"description": "If true, empty terms will not be returned.",
"type": "boolean",
"default": true,
"required": false
}
}
}
]
},
"/wc/store/products/categories": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Sort ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort by term property.",
"type": "string",
"default": "name",
"enum": [
"name",
"slug",
"count"
],
"required": false
},
"hide_empty": {
"description": "If true, empty terms will not be returned.",
"type": "boolean",
"default": true,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/categories"
}
]
}
},
"/wc/store/products/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/products/collection-data": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"slug": {
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources created after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources created before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"date_column": {
"description": "When limiting response using after/before, which date column to compare against.",
"type": "string",
"default": "date",
"enum": [
"date",
"date_gmt",
"modified",
"modified_gmt"
],
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"modified",
"id",
"include",
"title",
"slug",
"price",
"popularity",
"rating",
"menu_order",
"comment_count"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable",
"variation"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"category_operator": {
"description": "Operator to compare product category terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"tag_operator": {
"description": "Operator to compare product tags.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"sanitize_callback": "sanitize_text_field",
"validate_callback": "rest_validate_request_arg"
},
"default": [],
"required": false
},
"attributes": {
"description": "Limit result set to products with selected global attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"description": "Attribute taxonomy name.",
"type": "string",
"sanitize_callback": "wc_sanitize_taxonomy_name"
},
"term_id": {
"description": "List of attribute term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"sanitize_callback": "wp_parse_id_list"
},
"slug": {
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
"type": "array",
"items": {
"type": "string"
},
"sanitize_callback": "wp_parse_slug_list"
},
"operator": {
"description": "Operator to compare product attribute terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
]
}
}
},
"default": [],
"required": false
},
"attribute_relation": {
"description": "The logical relationship between attributes when filtering across several at once.",
"type": "string",
"enum": [
"in",
"and"
],
"default": "and",
"required": false
},
"catalog_visibility": {
"description": "Determines if hidden or visible catalogue products are shown.",
"type": "string",
"enum": [
"any",
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"rating": {
"description": "Limit result set to products with a certain average rating.",
"type": "array",
"items": {
"type": "integer",
"enum": [1, 2, 3, 4, 5]
},
"default": [],
"required": false
},
"calculate_price_range": {
"description": "If true, calculates the minimum and maximum product prices for the collection.",
"type": "boolean",
"default": false,
"required": false
},
"calculate_stock_status_counts": {
"description": "If true, calculates stock counts for products in the collection.",
"type": "boolean",
"default": false,
"required": false
},
"calculate_attribute_counts": {
"description": "If requested, calculates attribute term counts for products in the collection.",
"type": "array",
"items": {
"type": "object",
"properties": {
"taxonomy": {
"description": "Taxonomy name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"query_type": {
"description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".",
"type": "string",
"enum": [
"and",
"or"
],
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"default": [],
"required": false
},
"calculate_rating_counts": {
"description": "If true, calculates rating counts for products in the collection.",
"type": "boolean",
"default": false,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/collection-data"
}
]
}
},
"/wc/store/products/reviews": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"date_gmt",
"id",
"rating",
"product"
],
"required": false
},
"category_id": {
"description": "Limit result set to reviews from specific category IDs.",
"type": "string",
"required": false
},
"product_id": {
"description": "Limit result set to reviews from specific product IDs.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/reviews"
}
]
}
},
"/wc/store/products/tags": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Sort ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort by term property.",
"type": "string",
"default": "name",
"enum": [
"name",
"slug",
"count"
],
"required": false
},
"hide_empty": {
"description": "If true, empty terms will not be returned.",
"type": "boolean",
"default": true,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/tags"
}
]
}
},
"/wc/store/products": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"slug": {
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources created after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources created before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"date_column": {
"description": "When limiting response using after/before, which date column to compare against.",
"type": "string",
"default": "date",
"enum": [
"date",
"date_gmt",
"modified",
"modified_gmt"
],
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"modified",
"id",
"include",
"title",
"slug",
"price",
"popularity",
"rating",
"menu_order",
"comment_count"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable",
"variation"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"category_operator": {
"description": "Operator to compare product category terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"tag_operator": {
"description": "Operator to compare product tags.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"sanitize_callback": "sanitize_text_field",
"validate_callback": "rest_validate_request_arg"
},
"default": [],
"required": false
},
"attributes": {
"description": "Limit result set to products with selected global attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"description": "Attribute taxonomy name.",
"type": "string",
"sanitize_callback": "wc_sanitize_taxonomy_name"
},
"term_id": {
"description": "List of attribute term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"sanitize_callback": "wp_parse_id_list"
},
"slug": {
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
"type": "array",
"items": {
"type": "string"
},
"sanitize_callback": "wp_parse_slug_list"
},
"operator": {
"description": "Operator to compare product attribute terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
]
}
}
},
"default": [],
"required": false
},
"attribute_relation": {
"description": "The logical relationship between attributes when filtering across several at once.",
"type": "string",
"enum": [
"in",
"and"
],
"default": "and",
"required": false
},
"catalog_visibility": {
"description": "Determines if hidden or visible catalogue products are shown.",
"type": "string",
"enum": [
"any",
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"rating": {
"description": "Limit result set to products with a certain average rating.",
"type": "array",
"items": {
"type": "integer",
"enum": [1, 2, 3, 4, 5]
},
"default": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products"
}
]
}
},
"/wc/store/products/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/products/(?P\u003Cslug\u003E[\\S]+)": {
"namespace": "wc/store",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Slug of the resource.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/v1": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc/store/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1"
}
]
}
},
"/wc/store/v1/batch": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"validation": {
"type": "string",
"enum": [
"require-all-validate",
"normal"
],
"default": "normal",
"required": false
},
"requests": {
"type": "array",
"maxItems": 25,
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": [
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "POST"
},
"path": {
"type": "string",
"required": true
},
"body": {
"type": "object",
"properties": [],
"additionalProperties": true
},
"headers": {
"type": "object",
"properties": [],
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
}
}
},
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/batch"
}
]
}
},
"/wc/store/v1/cart": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart"
}
]
}
},
"/wc/store/v1/cart/add-item": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "The basket item product or variation ID.",
"type": "integer",
"required": false
},
"quantity": {
"description": "Quantity of this item to add to the basket.",
"type": "integer",
"required": false
},
"variation": {
"description": "Chosen attributes (for variations).",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"description": "Variation attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Variation attribute value.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/add-item"
}
]
}
},
"/wc/store/v1/cart/apply-coupon": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/apply-coupon"
}
]
}
},
"/wc/store/v1/cart/coupons": {
"namespace": "wc/store/v1",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "The coupon's unique code.",
"type": "string",
"required": false
},
"discount_type": {
"description": "The discount type for the coupon (eg percentage or fixed amount)",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/coupons"
}
]
}
},
"/wc/store/v1/cart/coupons/(?P\u003Ccode\u003E[\\w-]+)": {
"namespace": "wc/store/v1",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/store/v1/cart/extensions": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"namespace": {
"description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.",
"type": "string",
"required": false
},
"data": {
"description": "Additional data to pass to the extension",
"type": "object",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/extensions"
}
]
}
},
"/wc/store/v1/cart/items": {
"namespace": "wc/store/v1",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"extensions": {
"type": "object",
"properties": [],
"default": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/items"
}
]
}
},
"/wc/store/v1/cart/items/(?P\u003Ckey\u003E[\\w-]{32})": {
"namespace": "wc/store/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier for the item within the basket.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier for the item within the basket.",
"type": "string",
"required": false
},
"extensions": {
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier for the item within the basket.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/store/v1/cart/remove-coupon": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"code": {
"description": "Unique identifier for the coupon within the basket.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-coupon"
}
]
}
},
"/wc/store/v1/cart/remove-item": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier (key) for the basket item.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-item"
}
]
}
},
"/wc/store/v1/cart/select-shipping-rate": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"package_id": {
"description": "The ID of the package being shipped. Leave blank to apply to all packages.",
"type": [
"integer",
"string",
"null"
],
"required": false
},
"rate_id": {
"description": "The chosen rate ID for the package.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/select-shipping-rate"
}
]
}
},
"/wc/store/v1/cart/update-item": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"key": {
"description": "Unique identifier (key) for the basket item to update.",
"type": "string",
"required": false
},
"quantity": {
"description": "New quantity of the item in the basket.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-item"
}
]
}
},
"/wc/store/v1/cart/update-customer": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"billing_address": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"email": {
"description": "Email",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
},
"shipping_address": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-customer"
}
]
}
},
"/wc/store/v1/checkout": {
"namespace": "wc/store/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"payment_data": {
"description": "Data to pass through to the payment method when processing payment.",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": [
"string",
"boolean"
]
}
}
},
"required": false
},
"customer_password": {
"description": "Customer password for new accounts, if applicable.",
"type": "string",
"required": false
},
"customer_note": {
"description": "Note added to the order by the customer during checkout.",
"type": "string",
"required": false
},
"billing_address": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"email": {
"description": "Email",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": true
},
"shipping_address": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
},
"payment_method": {
"description": "The ID of the payment method being used to process the payment.",
"type": "string",
"enum": [
"bacs",
"cheque",
"cod"
],
"required": false
},
"create_account": {
"description": "Whether to create a new user account as part of order processing.",
"type": "boolean",
"required": false
},
"additional_fields": {
"description": "Additional fields to be persisted on the order.",
"type": "object",
"properties": [],
"required": false
},
"extensions": {
"type": "object",
"properties": {
"woocommerce/order-attribution": {
"description": "Extension data registered by woocommerce/order-attribution",
"type": [
"object",
"null"
],
"context": [
"view",
"edit"
],
"properties": {
"source_type": {
"description": "Order attribution field: source_type",
"type": [
"string",
"null"
],
"context": []
},
"referrer": {
"description": "Order attribution field: referrer",
"type": [
"string",
"null"
],
"context": []
},
"utm_campaign": {
"description": "Order attribution field: utm_campaign",
"type": [
"string",
"null"
],
"context": []
},
"utm_source": {
"description": "Order attribution field: utm_source",
"type": [
"string",
"null"
],
"context": []
},
"utm_medium": {
"description": "Order attribution field: utm_medium",
"type": [
"string",
"null"
],
"context": []
},
"utm_content": {
"description": "Order attribution field: utm_content",
"type": [
"string",
"null"
],
"context": []
},
"utm_id": {
"description": "Order attribution field: utm_id",
"type": [
"string",
"null"
],
"context": []
},
"utm_term": {
"description": "Order attribution field: utm_term",
"type": [
"string",
"null"
],
"context": []
},
"utm_source_platform": {
"description": "Order attribution field: utm_source_platform",
"type": [
"string",
"null"
],
"context": []
},
"utm_creative_format": {
"description": "Order attribution field: utm_creative_format",
"type": [
"string",
"null"
],
"context": []
},
"utm_marketing_tactic": {
"description": "Order attribution field: utm_marketing_tactic",
"type": [
"string",
"null"
],
"context": []
},
"session_entry": {
"description": "Order attribution field: session_entry",
"type": [
"string",
"null"
],
"context": []
},
"session_start_time": {
"description": "Order attribution field: session_start_time",
"type": [
"string",
"null"
],
"context": []
},
"session_pages": {
"description": "Order attribution field: session_pages",
"type": [
"string",
"null"
],
"context": []
},
"session_count": {
"description": "Order attribution field: session_count",
"type": [
"string",
"null"
],
"context": []
},
"user_agent": {
"description": "Order attribution field: user_agent",
"type": [
"string",
"null"
],
"context": []
}
}
}
},
"default": {
"woocommerce/order-attribution": []
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/checkout"
}
]
}
},
"/wc/store/v1/checkout/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"payment_data": {
"description": "Data to pass through to the payment method when processing payment.",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": [
"string",
"boolean"
]
}
}
},
"required": false
},
"customer_note": {
"description": "Note added to the order by the customer during checkout.",
"type": "string",
"required": false
},
"billing_address": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"email": {
"description": "Email",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": true
},
"shipping_address": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"last_name": {
"description": "Last name",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"company": {
"description": "Company",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_1": {
"description": "Address",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"address_2": {
"description": "Flat, suite, etc.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"city": {
"description": "City",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"state": {
"description": "State/County code, or name of the state, county, province, or district.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"postcode": {
"description": "Postcode",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"country": {
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
},
"phone": {
"description": "Phone",
"type": "string",
"context": [
"view",
"edit"
],
"required": true
}
},
"required": false
},
"payment_method": {
"description": "The ID of the payment method being used to process the payment.",
"type": "string",
"enum": [
"bacs",
"cheque",
"cod"
],
"required": false
},
"additional_fields": {
"description": "Additional fields to be persisted on the order.",
"type": "object",
"properties": [],
"required": false
},
"extensions": {
"type": "object",
"properties": {
"woocommerce/order-attribution": {
"description": "Extension data registered by woocommerce/order-attribution",
"type": [
"object",
"null"
],
"context": [
"view",
"edit"
],
"properties": {
"source_type": {
"description": "Order attribution field: source_type",
"type": [
"string",
"null"
],
"context": []
},
"referrer": {
"description": "Order attribution field: referrer",
"type": [
"string",
"null"
],
"context": []
},
"utm_campaign": {
"description": "Order attribution field: utm_campaign",
"type": [
"string",
"null"
],
"context": []
},
"utm_source": {
"description": "Order attribution field: utm_source",
"type": [
"string",
"null"
],
"context": []
},
"utm_medium": {
"description": "Order attribution field: utm_medium",
"type": [
"string",
"null"
],
"context": []
},
"utm_content": {
"description": "Order attribution field: utm_content",
"type": [
"string",
"null"
],
"context": []
},
"utm_id": {
"description": "Order attribution field: utm_id",
"type": [
"string",
"null"
],
"context": []
},
"utm_term": {
"description": "Order attribution field: utm_term",
"type": [
"string",
"null"
],
"context": []
},
"utm_source_platform": {
"description": "Order attribution field: utm_source_platform",
"type": [
"string",
"null"
],
"context": []
},
"utm_creative_format": {
"description": "Order attribution field: utm_creative_format",
"type": [
"string",
"null"
],
"context": []
},
"utm_marketing_tactic": {
"description": "Order attribution field: utm_marketing_tactic",
"type": [
"string",
"null"
],
"context": []
},
"session_entry": {
"description": "Order attribution field: session_entry",
"type": [
"string",
"null"
],
"context": []
},
"session_start_time": {
"description": "Order attribution field: session_start_time",
"type": [
"string",
"null"
],
"context": []
},
"session_pages": {
"description": "Order attribution field: session_pages",
"type": [
"string",
"null"
],
"context": []
},
"session_count": {
"description": "Order attribution field: session_count",
"type": [
"string",
"null"
],
"context": []
},
"user_agent": {
"description": "Order attribution field: user_agent",
"type": [
"string",
"null"
],
"context": []
}
}
}
},
"default": {
"woocommerce/order-attribution": []
},
"required": false
}
}
}
]
},
"/wc/store/v1/order/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/v1/products/attributes": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/attributes"
}
]
}
},
"/wc/store/v1/products/attributes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Sort ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort by term property.",
"type": "string",
"default": "name",
"enum": [
"name",
"slug",
"count",
"menu_order",
"name_num",
"id"
],
"required": false
},
"hide_empty": {
"description": "If true, empty terms will not be returned.",
"type": "boolean",
"default": true,
"required": false
}
}
}
]
},
"/wc/store/v1/products/categories": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Sort ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort by term property.",
"type": "string",
"default": "name",
"enum": [
"name",
"slug",
"count"
],
"required": false
},
"hide_empty": {
"description": "If true, empty terms will not be returned.",
"type": "boolean",
"default": true,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/categories"
}
]
}
},
"/wc/store/v1/products/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/v1/products/collection-data": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"slug": {
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources created after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources created before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"date_column": {
"description": "When limiting response using after/before, which date column to compare against.",
"type": "string",
"default": "date",
"enum": [
"date",
"date_gmt",
"modified",
"modified_gmt"
],
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"modified",
"id",
"include",
"title",
"slug",
"price",
"popularity",
"rating",
"menu_order",
"comment_count"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable",
"variation"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"category_operator": {
"description": "Operator to compare product category terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"tag_operator": {
"description": "Operator to compare product tags.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"sanitize_callback": "sanitize_text_field",
"validate_callback": "rest_validate_request_arg"
},
"default": [],
"required": false
},
"attributes": {
"description": "Limit result set to products with selected global attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"description": "Attribute taxonomy name.",
"type": "string",
"sanitize_callback": "wc_sanitize_taxonomy_name"
},
"term_id": {
"description": "List of attribute term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"sanitize_callback": "wp_parse_id_list"
},
"slug": {
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
"type": "array",
"items": {
"type": "string"
},
"sanitize_callback": "wp_parse_slug_list"
},
"operator": {
"description": "Operator to compare product attribute terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
]
}
}
},
"default": [],
"required": false
},
"attribute_relation": {
"description": "The logical relationship between attributes when filtering across several at once.",
"type": "string",
"enum": [
"in",
"and"
],
"default": "and",
"required": false
},
"catalog_visibility": {
"description": "Determines if hidden or visible catalogue products are shown.",
"type": "string",
"enum": [
"any",
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"rating": {
"description": "Limit result set to products with a certain average rating.",
"type": "array",
"items": {
"type": "integer",
"enum": [1, 2, 3, 4, 5]
},
"default": [],
"required": false
},
"calculate_price_range": {
"description": "If true, calculates the minimum and maximum product prices for the collection.",
"type": "boolean",
"default": false,
"required": false
},
"calculate_stock_status_counts": {
"description": "If true, calculates stock counts for products in the collection.",
"type": "boolean",
"default": false,
"required": false
},
"calculate_attribute_counts": {
"description": "If requested, calculates attribute term counts for products in the collection.",
"type": "array",
"items": {
"type": "object",
"properties": {
"taxonomy": {
"description": "Taxonomy name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"query_type": {
"description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".",
"type": "string",
"enum": [
"and",
"or"
],
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"default": [],
"required": false
},
"calculate_rating_counts": {
"description": "If true, calculates rating counts for products in the collection.",
"type": "boolean",
"default": false,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/collection-data"
}
]
}
},
"/wc/store/v1/products/reviews": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"date_gmt",
"id",
"rating",
"product"
],
"required": false
},
"category_id": {
"description": "Limit result set to reviews from specific category IDs.",
"type": "string",
"required": false
},
"product_id": {
"description": "Limit result set to reviews from specific product IDs.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/reviews"
}
]
}
},
"/wc/store/v1/products/tags": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Sort ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort by term property.",
"type": "string",
"default": "name",
"enum": [
"name",
"slug",
"count"
],
"required": false
},
"hide_empty": {
"description": "If true, empty terms will not be returned.",
"type": "boolean",
"default": true,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/tags"
}
]
}
},
"/wc/store/v1/products": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
"type": "integer",
"default": 10,
"minimum": 0,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"slug": {
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources created after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources created before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"date_column": {
"description": "When limiting response using after/before, which date column to compare against.",
"type": "string",
"default": "date",
"enum": [
"date",
"date_gmt",
"modified",
"modified_gmt"
],
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"modified",
"id",
"include",
"title",
"slug",
"price",
"popularity",
"rating",
"menu_order",
"comment_count"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable",
"variation"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"category_operator": {
"description": "Operator to compare product category terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"tag_operator": {
"description": "Operator to compare product tags.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
],
"default": "in",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
"type": "string",
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"sanitize_callback": "sanitize_text_field",
"validate_callback": "rest_validate_request_arg"
},
"default": [],
"required": false
},
"attributes": {
"description": "Limit result set to products with selected global attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"description": "Attribute taxonomy name.",
"type": "string",
"sanitize_callback": "wc_sanitize_taxonomy_name"
},
"term_id": {
"description": "List of attribute term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"sanitize_callback": "wp_parse_id_list"
},
"slug": {
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
"type": "array",
"items": {
"type": "string"
},
"sanitize_callback": "wp_parse_slug_list"
},
"operator": {
"description": "Operator to compare product attribute terms.",
"type": "string",
"enum": [
"in",
"not_in",
"and"
]
}
}
},
"default": [],
"required": false
},
"attribute_relation": {
"description": "The logical relationship between attributes when filtering across several at once.",
"type": "string",
"enum": [
"in",
"and"
],
"default": "and",
"required": false
},
"catalog_visibility": {
"description": "Determines if hidden or visible catalogue products are shown.",
"type": "string",
"enum": [
"any",
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"rating": {
"description": "Limit result set to products with a certain average rating.",
"type": "array",
"items": {
"type": "integer",
"enum": [1, 2, 3, 4, 5]
},
"default": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products"
}
]
}
},
"/wc/store/v1/products/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/store/v1/products/(?P\u003Cslug\u003E[\\S]+)": {
"namespace": "wc/store/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Slug of the resource.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/private": {
"namespace": "wc/private",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc/private",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private"
}
]
}
},
"/wc/private/ai/store-title": {
"namespace": "wc/private",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"business_description": {
"description": "The business description for a given store.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-title"
}
]
}
},
"/wc/private/ai/images": {
"namespace": "wc/private",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"business_description": {
"description": "The business description for a given store.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/images"
}
]
}
},
"/wc/private/ai/patterns": {
"namespace": "wc/private",
"methods": [
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"business_description": {
"description": "The business description for a given store.",
"type": "string",
"required": false
},
"images": {
"description": "The images for a given store.",
"type": "object",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/patterns"
}
]
}
},
"/wc/private/ai/product": {
"namespace": "wc/private",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"products_information": {
"description": "Data generated by AI for updating dummy products.",
"type": "object",
"required": false
},
"last_product": {
"description": "Whether the product being updated is the last one in the loop",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/product"
}
]
}
},
"/wc/private/ai/products": {
"namespace": "wc/private",
"methods": [
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"business_description": {
"description": "The business description for a given store.",
"type": "string",
"required": false
},
"images": {
"description": "The images for a given store.",
"type": "object",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/products"
}
]
}
},
"/wc/private/ai/business-description": {
"namespace": "wc/private",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"business_description": {
"description": "The business description for a given store.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/business-description"
}
]
}
},
"/wc/private/ai/store-info": {
"namespace": "wc/private",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-info"
}
]
}
},
"/wc/private/patterns": {
"namespace": "wc/private",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/patterns"
}
]
}
},
"/wc/v1": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1"
}
]
}
},
"/wc/v1/coupons": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"filter": {
"type": "object",
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
"required": false
},
"code": {
"description": "Limit result set to resources with a specific code.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": true
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"discount_type": {
"default": "fixed_cart",
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"expiry_date": {
"description": "UTC DateTime when the coupon expires.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"default": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"default": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"default": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons"
}
]
}
},
"/wc/v1/coupons/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"expiry_date": {
"description": "UTC DateTime when the coupon expires.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v1/coupons/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"expiry_date": {
"description": "UTC DateTime when the coupon expires.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons/batch"
}
]
}
},
"/wc/v1/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"customer_id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v1/customers": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "name",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"include",
"name",
"registered_date"
],
"type": "string",
"required": false
},
"email": {
"description": "Limit result set to resources with a specific email.",
"type": "string",
"format": "email",
"required": false
},
"role": {
"description": "Limit result set to resources with a specific role.",
"type": "string",
"default": "customer",
"enum": [
"all",
"administrator",
"editor",
"author",
"contributor",
"subscriber",
"customer",
"shop_manager"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"email": {
"type": "string",
"description": "New user email address.",
"required": true
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "New user username.",
"type": "string",
"required": false
},
"password": {
"description": "New user password.",
"type": "string",
"required": true
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers"
}
]
}
},
"/wc/v1/customers/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"email": {
"description": "The email address for the customer.",
"type": "string",
"format": "email",
"required": false
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "Customer login name.",
"type": "string",
"required": false
},
"password": {
"description": "Customer password.",
"type": "string",
"required": false
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
},
"reassign": {
"default": 0,
"type": "integer",
"description": "ID to reassign posts to.",
"required": false
}
}
}
]
},
"/wc/v1/customers/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"email": {
"description": "The email address for the customer.",
"type": "string",
"format": "email",
"required": false
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "Customer login name.",
"type": "string",
"required": false
},
"password": {
"description": "Customer password.",
"type": "string",
"required": false
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers/batch"
}
]
}
},
"/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"note": {
"type": "string",
"description": "Order note content.",
"required": true
},
"customer_note": {
"default": false,
"description": "Shows/define if the note is only for reference or for the customer (the user will be notified).",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"filter": {
"type": "object",
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to orders assigned a specific status.",
"type": "string",
"enum": [
"any",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"customer": {
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to orders assigned a specific product.",
"type": "integer",
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"amount": {
"description": "Refund amount.",
"type": "string",
"required": false
},
"reason": {
"description": "Reason for refund.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/orders": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"filter": {
"type": "object",
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to orders assigned a specific status.",
"type": "string",
"enum": [
"any",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"customer": {
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to orders assigned a specific product.",
"type": "integer",
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"default": "pending",
"description": "Order status.",
"type": "string",
"enum": [
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"default": "EUR",
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"default": 0,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"set_paid": {
"default": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta": {
"description": "Line item meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "Meta label.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders"
}
]
}
},
"/wc/v1/orders/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta": {
"description": "Line item meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "Meta label.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v1/orders/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2.",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta": {
"description": "Line item meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "Meta label.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders/batch"
}
]
}
},
"/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc/v1/products/attributes": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Name for the resource.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"default": "select",
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"default": "menu_order",
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"default": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes"
}
]
}
},
"/wc/v1/products/attributes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/products/attributes/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes/batch"
}
]
}
},
"/wc/v1/products/categories": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"default": "default",
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories"
}
]
}
},
"/wc/v1/products/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/products/categories/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories/batch"
}
]
}
},
"/wc/v1/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"review": {
"type": "string",
"description": "Review content.",
"required": true
},
"date_created": {
"description": "The date the review was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name of the reviewer.",
"required": true
},
"email": {
"type": "string",
"description": "Email of the reviewer.",
"required": true
}
}
}
]
},
"/wc/v1/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the review was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
},
"name": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"email": {
"description": "Reviewer email.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v1/products/shipping_classes": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes"
}
]
}
},
"/wc/v1/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/products/shipping_classes/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes/batch"
}
]
}
},
"/wc/v1/products/tags": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags"
}
]
}
},
"/wc/v1/products/tags/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Tag name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/products/tags/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Tag name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags/batch"
}
]
}
},
"/wc/v1/products": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"filter": {
"type": "object",
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"sku": {
"description": "Limit result set to products with a specific SKU.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"type": {
"default": "simple",
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"default": "publish",
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
},
"featured": {
"default": false,
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"default": "visible",
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price.",
"type": "string",
"required": false
},
"date_on_sale_to": {
"description": "End data of sale price.",
"type": "string",
"required": false
},
"virtual": {
"default": false,
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"download_type": {
"default": "standard",
"description": "Download type, this controls the schema on the front-end.",
"type": "string",
"enum": [
"standard"
],
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"default": true,
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
"type": "boolean",
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"sold_individually": {
"default": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"default": true,
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"variations": {
"description": "List of variations.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Variation ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created": {
"description": "The date the variation was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the variation was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"permalink": {
"description": "Variation URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
],
"readonly": true
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"context": [
"view",
"edit"
]
},
"price": {
"description": "Current variation price.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"date_on_sale_from": {
"description": "Start date of sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"date_on_sale_to": {
"description": "End data of sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"on_sale": {
"description": "Shows if the variation is on sale.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"purchasable": {
"description": "Shows if the variation can be bought.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"visible": {
"description": "If the variation is visible.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"default": null,
"context": [
"view",
"edit"
]
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"default": null,
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"default": "taxable",
"enum": [
"taxable",
"shipping",
"none"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"context": [
"view",
"edit"
]
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"in_stock": {
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
"type": "boolean",
"default": true,
"context": [
"view",
"edit"
]
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"default": "no",
"enum": [
"no",
"notify",
"yes"
],
"context": [
"view",
"edit"
]
},
"backorders_allowed": {
"description": "Shows if back-orders are allowed.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"backordered": {
"description": "Shows if the variation is on back-order.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"context": [
"view",
"edit"
]
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"context": [
"view",
"edit"
]
},
"shipping_class_id": {
"description": "Shipping class ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Variation image data.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products"
}
]
}
},
"/wc/v1/products/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price.",
"type": "string",
"required": false
},
"date_on_sale_to": {
"description": "End data of sale price.",
"type": "string",
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"download_type": {
"description": "Download type, this controls the schema on the front-end.",
"type": "string",
"enum": [
"standard"
],
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
"type": "boolean",
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"variations": {
"description": "List of variations.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Variation ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created": {
"description": "The date the variation was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the variation was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"permalink": {
"description": "Variation URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
],
"readonly": true
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"context": [
"view",
"edit"
]
},
"price": {
"description": "Current variation price.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"date_on_sale_from": {
"description": "Start date of sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"date_on_sale_to": {
"description": "End data of sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"on_sale": {
"description": "Shows if the variation is on sale.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"purchasable": {
"description": "Shows if the variation can be bought.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"visible": {
"description": "If the variation is visible.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"default": null,
"context": [
"view",
"edit"
]
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"default": null,
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"default": "taxable",
"enum": [
"taxable",
"shipping",
"none"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"context": [
"view",
"edit"
]
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"in_stock": {
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
"type": "boolean",
"default": true,
"context": [
"view",
"edit"
]
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"default": "no",
"enum": [
"no",
"notify",
"yes"
],
"context": [
"view",
"edit"
]
},
"backorders_allowed": {
"description": "Shows if back-orders are allowed.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"backordered": {
"description": "Shows if the variation is on back-order.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"context": [
"view",
"edit"
]
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"context": [
"view",
"edit"
]
},
"shipping_class_id": {
"description": "Shipping class ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Variation image data.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v1/products/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price.",
"type": "string",
"required": false
},
"date_on_sale_to": {
"description": "End data of sale price.",
"type": "string",
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"download_type": {
"description": "Download type, this controls the schema on the front-end.",
"type": "string",
"enum": [
"standard"
],
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
"type": "boolean",
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"variations": {
"description": "List of variations.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Variation ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created": {
"description": "The date the variation was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the variation was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"permalink": {
"description": "Variation URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
],
"readonly": true
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"context": [
"view",
"edit"
]
},
"price": {
"description": "Current variation price.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"date_on_sale_from": {
"description": "Start date of sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"date_on_sale_to": {
"description": "End data of sale price.",
"type": "string",
"context": [
"view",
"edit"
]
},
"on_sale": {
"description": "Shows if the variation is on sale.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"purchasable": {
"description": "Shows if the variation can be bought.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"visible": {
"description": "If the variation is visible.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"default": null,
"context": [
"view",
"edit"
]
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"default": null,
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"default": "taxable",
"enum": [
"taxable",
"shipping",
"none"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"context": [
"view",
"edit"
]
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"in_stock": {
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
"type": "boolean",
"default": true,
"context": [
"view",
"edit"
]
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"default": "no",
"enum": [
"no",
"notify",
"yes"
],
"context": [
"view",
"edit"
]
},
"backorders_allowed": {
"description": "Shows if back-orders are allowed.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"backordered": {
"description": "Shows if the variation is on back-order.",
"type": "boolean",
"context": [
"view",
"edit"
],
"readonly": true
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"context": [
"view",
"edit"
]
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"context": [
"view",
"edit"
]
},
"shipping_class_id": {
"description": "Shipping class ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Variation image data.",
"type": "object",
"context": [
"view",
"edit"
],
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/batch"
}
]
}
},
"/wc/v1/reports/sales": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"period": {
"description": "Report period.",
"type": "string",
"enum": [
"week",
"month",
"last_month",
"year"
],
"required": false
},
"date_min": {
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
},
"date_max": {
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/sales"
}
]
}
},
"/wc/v1/reports/top_sellers": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"period": {
"description": "Report period.",
"type": "string",
"enum": [
"week",
"month",
"last_month",
"year"
],
"required": false
},
"date_min": {
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
},
"date_max": {
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/top_sellers"
}
]
}
},
"/wc/v1/reports": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports"
}
]
}
},
"/wc/v1/taxes/classes": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Tax class name.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/classes"
}
]
}
},
"/wc/v1/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": {
"namespace": "wc/v1",
"methods": [
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": {
"slug": {
"description": "Unique slug for the resource.",
"type": "string",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/taxes": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "order",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"order",
"priority"
],
"type": "string",
"required": false
},
"class": {
"description": "Sort by tax class.",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode / ZIP.",
"type": "string",
"required": false
},
"city": {
"description": "City name.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"default": 1,
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"default": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"default": true,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"default": "standard",
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes"
}
]
}
},
"/wc/v1/taxes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode / ZIP.",
"type": "string",
"required": false
},
"city": {
"description": "City name.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/taxes/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode / ZIP.",
"type": "string",
"required": false
},
"city": {
"description": "City name.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/batch"
}
]
}
},
"/wc/v1/webhooks": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"title"
],
"required": false
},
"status": {
"default": "all",
"description": "Limit result set to webhooks assigned a specific status.",
"type": "string",
"enum": [
"all",
"active",
"paused",
"disabled"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"default": "active",
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"type": "string",
"description": "Webhook topic.",
"required": true
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
},
"delivery_url": {
"type": "string",
"description": "Webhook delivery URL.",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks"
}
]
}
},
"/wc/v1/webhooks/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"description": "Webhook topic.",
"type": "string",
"required": false
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v1/webhooks/batch": {
"namespace": "wc/v1",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"description": "Webhook topic.",
"type": "string",
"required": false
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks/batch"
}
]
}
},
"/wc/v1/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"webhook_id": {
"description": "Unique identifier for the webhook.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v1/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"webhook_id": {
"description": "Unique identifier for the webhook.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v2": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc/v2",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2"
}
]
}
},
"/wc/v2/coupons": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"code": {
"description": "Limit result set to resources with a specific code.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": true
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"default": "fixed_cart",
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"default": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"default": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"default": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons"
}
]
}
},
"/wc/v2/coupons/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v2/coupons/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons/batch"
}
]
}
},
"/wc/v2/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"customer_id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v2/customers": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "name",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"include",
"name",
"registered_date"
],
"type": "string",
"required": false
},
"email": {
"description": "Limit result set to resources with a specific email.",
"type": "string",
"format": "email",
"required": false
},
"role": {
"description": "Limit result set to resources with a specific role.",
"type": "string",
"default": "customer",
"enum": [
"all",
"administrator",
"editor",
"author",
"contributor",
"subscriber",
"customer",
"shop_manager"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"email": {
"type": "string",
"description": "New user email address.",
"required": true
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "New user username.",
"type": "string",
"required": false
},
"password": {
"description": "New user password.",
"type": "string",
"required": true
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers"
}
]
}
},
"/wc/v2/customers/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"email": {
"description": "The email address for the customer.",
"type": "string",
"format": "email",
"required": false
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "Customer login name.",
"type": "string",
"required": false
},
"password": {
"description": "Customer password.",
"type": "string",
"required": false
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
},
"reassign": {
"default": 0,
"type": "integer",
"description": "ID to reassign posts to.",
"required": false
}
}
}
]
},
"/wc/v2/customers/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"email": {
"description": "The email address for the customer.",
"type": "string",
"format": "email",
"required": false
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "Customer login name.",
"type": "string",
"required": false
},
"password": {
"description": "Customer password.",
"type": "string",
"required": false
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers/batch"
}
]
}
},
"/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"type": {
"default": "any",
"description": "Limit result to customers or internal notes.",
"type": "string",
"enum": [
"any",
"customer",
"internal"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"note": {
"type": "string",
"description": "Order note content.",
"required": true
},
"customer_note": {
"default": false,
"description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"amount": {
"description": "Refund amount.",
"type": "string",
"required": false
},
"reason": {
"description": "Reason for refund.",
"type": "string",
"required": false
},
"refunded_by": {
"description": "User ID of user who created the refund.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"api_refund": {
"default": true,
"description": "When true, the payment gateway API is used to generate the refund.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/orders": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to orders assigned a specific status.",
"type": "string",
"enum": [
"any",
"trash",
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"customer": {
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to orders assigned a specific product.",
"type": "integer",
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"default": "pending",
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"default": "EUR",
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"default": 0,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"default": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders"
}
]
}
},
"/wc/v2/orders/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v2/orders/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders/batch"
}
]
}
},
"/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc/v2/products/attributes": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Name for the resource.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"default": "select",
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"default": "menu_order",
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"default": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes"
}
]
}
},
"/wc/v2/products/attributes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/products/attributes/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes/batch"
}
]
}
},
"/wc/v2/products/categories": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"default": "default",
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories"
}
]
}
},
"/wc/v2/products/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/products/categories/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories/batch"
}
]
}
},
"/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"review": {
"type": "string",
"description": "Review content.",
"required": true
},
"date_created": {
"description": "The date the review was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the review was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name of the reviewer.",
"required": true
},
"email": {
"type": "string",
"description": "Email of the reviewer.",
"required": true
}
}
}
]
},
"/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the review was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the review was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
},
"name": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"email": {
"description": "Reviewer email.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the review was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the review was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
},
"name": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"email": {
"description": "Reviewer email.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v2/products/shipping_classes": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes"
}
]
}
},
"/wc/v2/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/products/shipping_classes/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes/batch"
}
]
}
},
"/wc/v2/products/tags": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags"
}
]
}
},
"/wc/v2/products/tags/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Tag name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/products/tags/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Tag name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags/batch"
}
]
}
},
"/wc/v2/products": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"in_stock": {
"description": "Limit result set to products in stock or out of stock.",
"type": "boolean",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"type": {
"default": "simple",
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"default": "publish",
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
},
"featured": {
"default": false,
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"default": "visible",
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"default": true,
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
"type": "boolean",
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"sold_individually": {
"default": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"default": true,
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "string"
}
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"grouped_products": {
"description": "List of grouped products ID.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products"
}
]
}
},
"/wc/v2/products/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
"type": "boolean",
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "string"
}
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"grouped_products": {
"description": "List of grouped products ID.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v2/products/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
"type": "boolean",
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "string"
}
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"grouped_products": {
"description": "List of grouped products ID.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/batch"
}
]
}
},
"/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"in_stock": {
"description": "Limit result set to products in stock or out of stock.",
"type": "boolean",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"visible": {
"default": true,
"description": "Define if the variation is visible on the product's page.",
"type": "boolean",
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"default": true,
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
"type": "boolean",
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"visible": {
"description": "Define if the variation is visible on the product's page.",
"type": "boolean",
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
"type": "boolean",
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Unique identifier.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"visible": {
"description": "Define if the variation is visible on the product's page.",
"type": "boolean",
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"in_stock": {
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
"type": "boolean",
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Image position. 0 means that the image is featured.",
"type": "integer",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc/v2/reports/sales": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"period": {
"description": "Report period.",
"type": "string",
"enum": [
"week",
"month",
"last_month",
"year"
],
"required": false
},
"date_min": {
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
},
"date_max": {
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/sales"
}
]
}
},
"/wc/v2/reports/top_sellers": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"period": {
"description": "Report period.",
"type": "string",
"enum": [
"week",
"month",
"last_month",
"year"
],
"required": false
},
"date_min": {
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
},
"date_max": {
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/top_sellers"
}
]
}
},
"/wc/v2/reports": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports"
}
]
}
},
"/wc/v2/settings": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/settings"
}
]
}
},
"/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
}
]
},
"/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
}
]
},
"/wc/v2/shipping/zones": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Shipping zone name.",
"required": true
},
"order": {
"description": "Shipping zone order.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping/zones"
}
]
}
},
"/wc/v2/shipping/zones/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Shipping zone name.",
"type": "string",
"required": false
},
"order": {
"description": "Shipping zone order.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v2/shipping/zones/(?P\u003Cid\u003E[\\d]+)/locations": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Shipping zone location code.",
"type": "string",
"required": false
},
"type": {
"description": "Shipping zone location type.",
"type": "string",
"enum": [
"postcode",
"state",
"country",
"continent"
],
"required": false
}
}
}
]
},
"/wc/v2/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"order": {
"description": "Shipping method sort order.",
"type": "integer",
"required": false
},
"enabled": {
"description": "Shipping method enabled status.",
"type": "boolean",
"required": false
},
"settings": {
"description": "Shipping method settings.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "A human readable label for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"description": {
"description": "A human readable description for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"type": {
"description": "Type of setting.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"text",
"email",
"number",
"color",
"password",
"textarea",
"select",
"multiselect",
"radio",
"image_width",
"checkbox"
],
"readonly": true
},
"value": {
"description": "Setting value.",
"type": "string",
"context": [
"view",
"edit"
]
},
"default": {
"description": "Default value for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"tip": {
"description": "Additional help text shown to the user about the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"placeholder": {
"description": "Placeholder text to be displayed in text inputs.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
},
"method_id": {
"description": "Shipping method ID.",
"required": true
}
}
}
]
},
"/wc/v2/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods/(?P\u003Cinstance_id\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"instance_id": {
"description": "Unique ID for the instance.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"instance_id": {
"description": "Unique ID for the instance.",
"type": "integer",
"required": false
},
"order": {
"description": "Shipping method sort order.",
"type": "integer",
"required": false
},
"enabled": {
"description": "Shipping method enabled status.",
"type": "boolean",
"required": false
},
"settings": {
"description": "Shipping method settings.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "A human readable label for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"description": {
"description": "A human readable description for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"type": {
"description": "Type of setting.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"text",
"email",
"number",
"color",
"password",
"textarea",
"select",
"multiselect",
"radio",
"image_width",
"checkbox"
],
"readonly": true
},
"value": {
"description": "Setting value.",
"type": "string",
"context": [
"view",
"edit"
]
},
"default": {
"description": "Default value for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"tip": {
"description": "Additional help text shown to the user about the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"placeholder": {
"description": "Placeholder text to be displayed in text inputs.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"instance_id": {
"description": "Unique ID for the instance.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v2/taxes/classes": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Tax class name.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/classes"
}
]
}
},
"/wc/v2/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": {
"namespace": "wc/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Unique slug for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"slug": {
"description": "Unique slug for the resource.",
"type": "string",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/taxes": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "order",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"order",
"priority"
],
"type": "string",
"required": false
},
"class": {
"description": "Sort by tax class.",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode / ZIP.",
"type": "string",
"required": false
},
"city": {
"description": "City name.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"default": 1,
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"default": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"default": true,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"default": "standard",
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes"
}
]
}
},
"/wc/v2/taxes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode / ZIP.",
"type": "string",
"required": false
},
"city": {
"description": "City name.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/taxes/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode / ZIP.",
"type": "string",
"required": false
},
"city": {
"description": "City name.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/batch"
}
]
}
},
"/wc/v2/webhooks": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"title"
],
"required": false
},
"status": {
"default": "all",
"description": "Limit result set to webhooks assigned a specific status.",
"type": "string",
"enum": [
"all",
"active",
"paused",
"disabled"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"default": "active",
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"type": "string",
"description": "Webhook topic.",
"required": true
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
},
"delivery_url": {
"type": "string",
"description": "Webhook delivery URL.",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks"
}
]
}
},
"/wc/v2/webhooks/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"description": "Webhook topic.",
"type": "string",
"required": false
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v2/webhooks/batch": {
"namespace": "wc/v2",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"description": "Webhook topic.",
"type": "string",
"required": false
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks/batch"
}
]
}
},
"/wc/v2/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"webhook_id": {
"description": "Unique identifier for the webhook.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v2/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"webhook_id": {
"description": "Unique identifier for the webhook.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v2/system_status": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status"
}
]
}
},
"/wc/v2/system_status/tools": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status/tools"
}
]
}
},
"/wc/v2/system_status/tools/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "A unique identifier for the tool.",
"type": "string",
"required": false
},
"name": {
"description": "Tool name.",
"type": "string",
"required": false
},
"action": {
"description": "What running the tool will do.",
"type": "string",
"required": false
},
"description": {
"description": "Tool description.",
"type": "string",
"required": false
},
"success": {
"description": "Did the tool run successfully?",
"type": "boolean",
"required": false
},
"message": {
"description": "Tool return message.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v2/shipping_methods": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping_methods"
}
]
}
},
"/wc/v2/shipping_methods/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v2/payment_gateways": {
"namespace": "wc/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/payment_gateways"
}
]
}
},
"/wc/v2/payment_gateways/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"title": {
"description": "Payment gateway title on checkout.",
"type": "string",
"required": false
},
"description": {
"description": "Payment gateway description on checkout.",
"type": "string",
"required": false
},
"order": {
"description": "Payment gateway sort order.",
"type": "integer",
"required": false
},
"enabled": {
"description": "Payment gateway enabled status.",
"type": "boolean",
"required": false
},
"settings": {
"description": "Payment gateway settings.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "A human readable label for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"description": {
"description": "A human readable description for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"type": {
"description": "Type of setting.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"text",
"email",
"number",
"color",
"password",
"textarea",
"select",
"multiselect",
"radio",
"image_width",
"checkbox"
],
"readonly": true
},
"value": {
"description": "Setting value.",
"type": "string",
"context": [
"view",
"edit"
]
},
"default": {
"description": "Default value for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"tip": {
"description": "Additional help text shown to the user about the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"placeholder": {
"description": "Placeholder text to be displayed in text inputs.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
}
}
}
]
},
"/wc/v3/coupons": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"code": {
"description": "Limit result set to resources with a specific code.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": true
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"default": "fixed_cart",
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"default": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"default": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"default": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons"
}
]
}
},
"/wc/v3/coupons/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v3/coupons/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"code": {
"description": "Coupon code.",
"type": "string",
"required": false
},
"amount": {
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string",
"required": false
},
"status": {
"description": "The status of the coupon. Should always be draft, published, or pending review",
"type": "string",
"required": false
},
"discount_type": {
"description": "Determines the type of discount that will be applied.",
"type": "string",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"required": false
},
"description": {
"description": "Coupon description.",
"type": "string",
"required": false
},
"date_expires": {
"description": "The date the coupon expires, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_expires_gmt": {
"description": "The date the coupon expires, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"individual_use": {
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean",
"required": false
},
"product_ids": {
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_ids": {
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"usage_limit": {
"description": "How many times the coupon can be used in total.",
"type": "integer",
"required": false
},
"usage_limit_per_user": {
"description": "How many times the coupon can be used per customer.",
"type": "integer",
"required": false
},
"limit_usage_to_x_items": {
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer",
"required": false
},
"free_shipping": {
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean",
"required": false
},
"product_categories": {
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"excluded_product_categories": {
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"exclude_sale_items": {
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean",
"required": false
},
"minimum_amount": {
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string",
"required": false
},
"maximum_amount": {
"description": "Maximum order amount allowed when using the coupon.",
"type": "string",
"required": false
},
"email_restrictions": {
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons/batch"
}
]
}
},
"/wc/v3/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"customer_id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v3/customers": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "name",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"include",
"name",
"registered_date"
],
"type": "string",
"required": false
},
"email": {
"description": "Limit result set to resources with a specific email.",
"type": "string",
"format": "email",
"required": false
},
"role": {
"description": "Limit result set to resources with a specific role.",
"type": "string",
"default": "customer",
"enum": [
"all",
"administrator",
"editor",
"author",
"contributor",
"subscriber",
"customer",
"shop_manager"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"email": {
"type": "string",
"description": "New user email address.",
"required": true
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "New user username.",
"type": "string",
"required": false
},
"password": {
"description": "New user password.",
"type": "string",
"required": true
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers"
}
]
}
},
"/wc/v3/customers/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"email": {
"description": "The email address for the customer.",
"type": "string",
"format": "email",
"required": false
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "Customer login name.",
"type": "string",
"required": false
},
"password": {
"description": "Customer password.",
"type": "string",
"required": false
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
},
"reassign": {
"default": 0,
"type": "integer",
"description": "ID to reassign posts to.",
"required": false
}
}
}
]
},
"/wc/v3/customers/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"email": {
"description": "The email address for the customer.",
"type": "string",
"format": "email",
"required": false
},
"first_name": {
"description": "Customer first name.",
"type": "string",
"required": false
},
"last_name": {
"description": "Customer last name.",
"type": "string",
"required": false
},
"username": {
"description": "Customer login name.",
"type": "string",
"required": false
},
"password": {
"description": "Customer password.",
"type": "string",
"required": false
},
"billing": {
"description": "List of billing address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": "string",
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "List of shipping address data.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "ISO code of the country.",
"type": "string",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers/batch"
}
]
}
},
"/wc/v3/layout-templates": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"area": {
"description": "Area to get templates for.",
"type": "string",
"default": "",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/layout-templates"
}
]
}
},
"/wc/v3/layout-templates/(?P\u003Cid\u003E\\w[\\w\\s\\-]*)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"type": {
"default": "any",
"description": "Limit result to customers or internal notes.",
"type": "string",
"enum": [
"any",
"customer",
"internal"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"note": {
"type": "string",
"description": "Order note content.",
"required": true
},
"customer_note": {
"default": false,
"description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.",
"type": "boolean",
"required": false
},
"added_by_user": {
"default": false,
"description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"amount": {
"description": "Refund amount.",
"type": "string",
"required": false
},
"reason": {
"description": "Reason for refund.",
"type": "string",
"required": false
},
"refunded_by": {
"description": "User ID of user who created the refund.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"api_refund": {
"default": true,
"description": "When true, the payment gateway API is used to generate the refund.",
"type": "boolean",
"required": false
},
"api_restock": {
"default": true,
"description": "When true, refunded items are restocked.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"order_id": {
"description": "The order ID.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/orders": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to orders which have specific statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"any",
"trash",
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
]
},
"required": false
},
"customer": {
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to orders assigned a specific product.",
"type": "integer",
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"default": "pending",
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"default": "EUR",
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"default": 0,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"default": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"default": false,
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders"
}
]
}
},
"/wc/v3/orders/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v3/orders/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"parent_id": {
"description": "Parent order ID.",
"type": "integer",
"required": false
},
"status": {
"description": "Order status.",
"type": "string",
"enum": [
"auto-draft",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed",
"checkout-draft"
],
"required": false
},
"currency": {
"description": "Currency the order was created with, in ISO format.",
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"required": false
},
"customer_id": {
"description": "User ID who owns the order. 0 for guests.",
"type": "integer",
"required": false
},
"customer_note": {
"description": "Note left by customer during checkout.",
"type": "string",
"required": false
},
"billing": {
"description": "Billing address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
},
"email": {
"description": "Email address.",
"type": [
"string",
"null"
],
"format": "email",
"context": [
"view",
"edit"
]
},
"phone": {
"description": "Phone number.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"description": "First name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"last_name": {
"description": "Last name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"company": {
"description": "Company name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_1": {
"description": "Address line 1",
"type": "string",
"context": [
"view",
"edit"
]
},
"address_2": {
"description": "Address line 2",
"type": "string",
"context": [
"view",
"edit"
]
},
"city": {
"description": "City name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"state": {
"description": "ISO code or name of the county, state, province or district.",
"type": "string",
"context": [
"view",
"edit"
]
},
"postcode": {
"description": "Postal code.",
"type": "string",
"context": [
"view",
"edit"
]
},
"country": {
"description": "Country code in ISO 3166-1 alpha-2 format.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"payment_method": {
"description": "Payment method ID.",
"type": "string",
"required": false
},
"payment_method_title": {
"description": "Payment method title.",
"type": "string",
"required": false
},
"transaction_id": {
"description": "Unique transaction ID.",
"type": "string",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"line_items": {
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"parent_name": {
"description": "Parent product name if the product is a variation.",
"type": "string",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"display_key": {
"description": "Meta key for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
},
"display_value": {
"description": "Meta value for UI display.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
},
"image": {
"description": "Properties of the main product image.",
"type": "object",
"context": [
"view",
"edit"
],
"readonly": true,
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"shipping_lines": {
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"fee_lines": {
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"coupon_lines": {
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_type": {
"description": "Discount type.",
"type": "string",
"context": [
"view"
],
"readonly": true
},
"nominal_amount": {
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
"type": "number",
"context": [
"view"
],
"readonly": true
},
"free_shipping": {
"description": "Whether the coupon grants free shipping or not.",
"type": "boolean",
"context": [
"view"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
}
},
"required": false
},
"set_paid": {
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean",
"required": false
},
"manual_update": {
"description": "Set the action as manual so that the order note registers as \"added by user\".",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders/batch"
}
]
}
},
"/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"attribute_id": {
"description": "Unique identifier for the attribute of the terms.",
"type": "integer",
"required": false
},
"name": {
"description": "Term name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc/v3/products/attributes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Name for the resource.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"default": "select",
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"default": "menu_order",
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"default": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes"
}
]
}
},
"/wc/v3/products/attributes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": true,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/products/attributes/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Attribute name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"type": {
"description": "Type of attribute.",
"type": "string",
"enum": [
"select"
],
"required": false
},
"order_by": {
"description": "Default sort order.",
"type": "string",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"required": false
},
"has_archives": {
"description": "Enable/Disable attribute archives.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes/batch"
}
]
}
},
"/wc/v3/products/categories": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"default": "default",
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories"
}
]
}
},
"/wc/v3/products/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/products/categories/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Category name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the resource.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
},
"display": {
"description": "Category archive display type.",
"type": "string",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"required": false
},
"image": {
"description": "Image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort the resource.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories/batch"
}
]
}
},
"/wc/v3/products/custom-fields/names": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"order": {
"description": "Order sort items ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/custom-fields/names"
}
]
}
},
"/wc/v3/products/reviews": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to reviews published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date_gmt",
"enum": [
"date",
"date_gmt",
"id",
"include",
"product"
],
"required": false
},
"reviewer": {
"description": "Limit result set to reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"reviewer_exclude": {
"description": "Ensure result set excludes reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"reviewer_email": {
"default": null,
"description": "Limit result set to that from a specific author email.",
"format": "email",
"type": "string",
"required": false
},
"product": {
"default": [],
"description": "Limit result set to reviews assigned to specific product IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"status": {
"default": "approved",
"description": "Limit result set to reviews assigned a specific status.",
"type": "string",
"enum": [
"all",
"hold",
"approved",
"spam",
"trash"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the product.",
"type": "integer",
"required": true
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"default": "approved",
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"type": "string",
"description": "Name of the reviewer.",
"required": true
},
"reviewer_email": {
"type": "string",
"description": "Email of the reviewer.",
"required": true
},
"review": {
"type": "string",
"description": "Review content.",
"required": true
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews"
}
]
}
},
"/wc/v3/products/reviews/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"product_id": {
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer",
"required": false
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"reviewer_email": {
"description": "Reviewer email.",
"type": "string",
"format": "email",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v3/products/reviews/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer",
"required": false
},
"product_name": {
"description": "Product name.",
"type": "string",
"required": false
},
"status": {
"description": "Status of the review.",
"type": "string",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"required": false
},
"reviewer": {
"description": "Reviewer name.",
"type": "string",
"required": false
},
"reviewer_email": {
"description": "Reviewer email.",
"type": "string",
"format": "email",
"required": false
},
"review": {
"description": "The content of the review.",
"type": "string",
"required": false
},
"rating": {
"description": "Review rating (0 to 5).",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews/batch"
}
]
}
},
"/wc/v3/products/shipping_classes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes"
}
]
}
},
"/wc/v3/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/products/shipping_classes/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/batch"
}
]
}
},
"/wc/v3/products/shipping_classes/slug-suggestion": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"name": {
"description": "Shipping class name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/slug-suggestion"
}
]
}
},
"/wc/v3/products/tags": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by resource attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
"type": "integer",
"required": false
},
"product": {
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to resources with a specific slug.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Name for the resource.",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags"
}
]
}
},
"/wc/v3/products/tags/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Tag name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/products/tags/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Tag name.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string",
"required": false
},
"description": {
"description": "HTML description of the resource.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags/batch"
}
]
}
},
"/wc/v3/products": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order",
"price",
"popularity",
"rating"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"search_sku": {
"description": "Limit results to those with a SKU that partially matches a string.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"default": "simple",
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"default": "publish",
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"default": false,
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"default": "visible",
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"default": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"default": true,
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products"
}
]
}
},
"/wc/v3/products/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wc/v3/products/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/batch"
}
]
}
},
"/wc/v3/products/suggested-products": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"popularity",
"rating",
"popularity",
"rating",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"type": {
"description": "Limit result set to products assigned a specific type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"featured": {
"description": "Limit result set to featured products.",
"type": "boolean",
"required": false
},
"category": {
"description": "Limit result set to products assigned a specific category ID.",
"type": "string",
"required": false
},
"tag": {
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string",
"required": false
},
"shipping_class": {
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string",
"required": false
},
"attribute": {
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string",
"required": false
},
"attribute_term": {
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string",
"required": false
},
"in_stock": {
"description": "Limit result set to products in stock or out of stock.",
"type": "boolean",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"categories": {
"description": "Limit result set to specific product categorie ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"tags": {
"description": "Limit result set to specific product tag ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"limit": {
"description": "Limit result set to specific amount of suggested products.",
"type": "integer",
"default": 5,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/suggested-products"
}
]
}
},
"/wc/v3/products/(?P\u003Cid\u003E[\\d]+)/duplicate": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Product name.",
"type": "string",
"required": false
},
"slug": {
"description": "Product slug.",
"type": "string",
"required": false
},
"date_created": {
"description": "The date the product was created, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_created_gmt": {
"description": "The date the product was created, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"type": {
"description": "Product type.",
"type": "string",
"enum": [
"simple",
"grouped",
"external",
"variable"
],
"required": false
},
"status": {
"description": "Product status (post status).",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish",
"future",
"auto-draft",
"trash"
],
"required": false
},
"featured": {
"description": "Featured product.",
"type": "boolean",
"required": false
},
"catalog_visibility": {
"description": "Catalogue visibility.",
"type": "string",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"required": false
},
"description": {
"description": "Product description.",
"type": "string",
"required": false
},
"short_description": {
"description": "Product short description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Product regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Product sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"virtual": {
"description": "If the product is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the product is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"external_url": {
"description": "Product external URL. Only for external products.",
"type": "string",
"format": "uri",
"required": false
},
"button_text": {
"description": "Product external button text. Only for external products.",
"type": "string",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at product level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the product.",
"type": [
"integer",
"null"
],
"required": false
},
"sold_individually": {
"description": "Allow one item to be bought in a single order.",
"type": "boolean",
"required": false
},
"weight": {
"description": "Product weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Product dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Product length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Product width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Product height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"reviews_allowed": {
"description": "Allow reviews.",
"type": "boolean",
"required": false
},
"post_password": {
"description": "Post password.",
"type": "string",
"required": false
},
"upsell_ids": {
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"cross_sell_ids": {
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_id": {
"description": "Product parent ID.",
"type": "integer",
"required": false
},
"purchase_note": {
"description": "Optional note to send the customer after purchase.",
"type": "string",
"required": false
},
"categories": {
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"tags": {
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
},
"required": false
},
"images": {
"description": "List of images.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"default_attributes": {
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"slug": {
"description": "Limit result set to products with a specific slug.",
"type": "string",
"required": false
},
"status": {
"default": "any",
"description": "Limit result set to products assigned a specific status.",
"type": "string",
"enum": [
"any",
"future",
"trash",
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"sku": {
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string",
"required": false
},
"on_sale": {
"description": "Limit result set to products on sale.",
"type": "boolean",
"required": false
},
"min_price": {
"description": "Limit result set to products based on a minimum price.",
"type": "string",
"required": false
},
"max_price": {
"description": "Limit result set to products based on a maximum price.",
"type": "string",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"stock_status": {
"description": "Limit result set to products with specified stock status.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"has_price": {
"description": "Limit result set to products with or without price.",
"type": "boolean",
"required": false
},
"attributes": {
"description": "Limit result set to products with specified attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"description": "Attribute slug."
},
"term": {
"type": "string",
"description": "Attribute term."
},
"terms": {
"type": "array",
"description": "Attribute terms."
}
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the variation.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/generate": {
"namespace": "wc/v3",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"product_id": {
"description": "Unique identifier for the variable product.",
"type": "integer",
"required": false
},
"delete": {
"description": "Deletes unused variations.",
"type": "boolean",
"required": false
},
"default_values": {
"description": "Default values for generated variations.",
"type": "object",
"properties": {
"description": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation description.",
"type": "string"
},
"sku": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock Keeping Unit.",
"type": "string"
},
"global_unique_id": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string"
},
"regular_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_from_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
]
},
"date_on_sale_to": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"date_on_sale_to_gmt": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
]
},
"status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
]
},
"virtual": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
]
},
"tax_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
]
},
"backorders": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
]
},
"low_stock_amount": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
]
},
"weight": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation weight (kg).",
"type": "string"
},
"dimensions": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"shipping_class": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"attributes": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"validate_callback": "rest_validate_request_arg",
"sanitize_callback": "rest_sanitize_request_arg",
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
}
}
},
"required": false
},
"description": {
"description": "Variation description.",
"type": "string",
"required": false
},
"sku": {
"description": "Stock Keeping Unit.",
"type": "string",
"required": false
},
"global_unique_id": {
"description": "GTIN, UPC, EAN or ISBN.",
"type": "string",
"required": false
},
"regular_price": {
"description": "Variation regular price.",
"type": "string",
"required": false
},
"sale_price": {
"description": "Variation sale price.",
"type": "string",
"required": false
},
"date_on_sale_from": {
"description": "Start date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_from_gmt": {
"description": "Start date of sale price, as GMT.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"date_on_sale_to_gmt": {
"description": "End date of sale price, in the site's timezone.",
"type": [
"null",
"string"
],
"required": false
},
"status": {
"default": "publish",
"description": "Variation status.",
"type": "string",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"required": false
},
"virtual": {
"default": false,
"description": "If the variation is virtual.",
"type": "boolean",
"required": false
},
"downloadable": {
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean",
"required": false
},
"downloads": {
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"download_limit": {
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer",
"required": false
},
"download_expiry": {
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer",
"required": false
},
"tax_status": {
"default": "taxable",
"description": "Tax status.",
"type": "string",
"enum": [
"taxable",
"shipping",
"none"
],
"required": false
},
"tax_class": {
"description": "Tax class.",
"type": "string",
"required": false
},
"manage_stock": {
"default": false,
"description": "Stock management at variation level.",
"type": "boolean",
"required": false
},
"stock_quantity": {
"description": "Stock quantity.",
"type": "integer",
"required": false
},
"stock_status": {
"default": "instock",
"description": "Controls the stock status of the product.",
"type": "string",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"required": false
},
"backorders": {
"default": "no",
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string",
"enum": [
"no",
"notify",
"yes"
],
"required": false
},
"low_stock_amount": {
"description": "Low Stock amount for the variation.",
"type": [
"integer",
"null"
],
"required": false
},
"weight": {
"description": "Variation weight (kg).",
"type": "string",
"required": false
},
"dimensions": {
"description": "Variation dimensions.",
"type": "object",
"properties": {
"length": {
"description": "Variation length (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"width": {
"description": "Variation width (cm).",
"type": "string",
"context": [
"view",
"edit"
]
},
"height": {
"description": "Variation height (cm).",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"shipping_class": {
"description": "Shipping class slug.",
"type": "string",
"required": false
},
"image": {
"description": "Variation image data.",
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": [
"null",
"string"
],
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"attributes": {
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
},
"required": false
},
"menu_order": {
"description": "Menu order, used to custom sort products.",
"type": "integer",
"required": false
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"context": [
"view",
"edit"
]
}
}
},
"required": false
}
}
}
]
},
"/wc/v3/refunds": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"dates_are_gmt": {
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
"type": "boolean",
"default": false,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"modified"
],
"required": false
},
"parent": {
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"dp": {
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer",
"required": false
},
"order_item_display_meta": {
"default": false,
"description": "Only show meta which is meant to be displayed for an order.",
"type": "boolean",
"required": false
},
"include_meta": {
"default": [],
"description": "Limit meta_data to specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"exclude_meta": {
"default": [],
"description": "Ensure meta_data excludes specific keys.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/refunds"
}
]
}
},
"/wc/v3/reports/sales": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"period": {
"description": "Report period.",
"type": "string",
"enum": [
"week",
"month",
"last_month",
"year"
],
"required": false
},
"date_min": {
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
},
"date_max": {
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/sales"
}
]
}
},
"/wc/v3/reports/top_sellers": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"period": {
"description": "Report period.",
"type": "string",
"enum": [
"week",
"month",
"last_month",
"year"
],
"required": false
},
"date_min": {
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
},
"date_max": {
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string",
"format": "date",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/top_sellers"
}
]
}
},
"/wc/v3/reports/orders/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/orders/totals"
}
]
}
},
"/wc/v3/reports/products/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/products/totals"
}
]
}
},
"/wc/v3/reports/customers/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/customers/totals"
}
]
}
},
"/wc/v3/reports/coupons/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/coupons/totals"
}
]
}
},
"/wc/v3/reports/reviews/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/reviews/totals"
}
]
}
},
"/wc/v3/reports": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports"
}
]
}
},
"/wc/v3/settings": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings"
}
]
}
},
"/wc/v3/settings/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings/batch"
}
]
}
},
"/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
}
]
},
"/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"description": "Settings group ID.",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"value": {
"description": "Setting value.",
"type": [
"null",
"object",
"string",
"number",
"boolean",
"integer",
"array"
],
"required": false
}
}
}
]
},
"/wc/v3/shipping/zones": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "Shipping zone name.",
"required": true
},
"order": {
"description": "Shipping zone order.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping/zones"
}
]
}
},
"/wc/v3/shipping/zones/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "Shipping zone name.",
"type": "string",
"required": false
},
"order": {
"description": "Shipping zone order.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v3/shipping/zones/(?P\u003Cid\u003E[\\d]+)/locations": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique ID for the resource.",
"type": "integer",
"required": false
},
"code": {
"description": "Shipping zone location code.",
"type": "string",
"required": false
},
"type": {
"description": "Shipping zone location type.",
"type": "string",
"enum": [
"postcode",
"state",
"country",
"continent"
],
"required": false
}
}
}
]
},
"/wc/v3/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"order": {
"description": "Shipping method sort order.",
"type": "integer",
"required": false
},
"enabled": {
"description": "Shipping method enabled status.",
"type": "boolean",
"required": false
},
"settings": {
"description": "Shipping method settings.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "A human readable label for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"description": {
"description": "A human readable description for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"type": {
"description": "Type of setting.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"text",
"email",
"number",
"color",
"password",
"textarea",
"select",
"multiselect",
"radio",
"image_width",
"checkbox",
"class",
"order"
],
"readonly": true
},
"value": {
"description": "Setting value.",
"type": "string",
"context": [
"view",
"edit"
]
},
"default": {
"description": "Default value for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"tip": {
"description": "Additional help text shown to the user about the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"placeholder": {
"description": "Placeholder text to be displayed in text inputs.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
},
"method_id": {
"description": "Shipping method ID.",
"required": true
}
}
}
]
},
"/wc/v3/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods/(?P\u003Cinstance_id\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"instance_id": {
"description": "Unique ID for the instance.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"instance_id": {
"description": "Unique ID for the instance.",
"type": "integer",
"required": false
},
"order": {
"description": "Shipping method sort order.",
"type": "integer",
"required": false
},
"enabled": {
"description": "Shipping method enabled status.",
"type": "boolean",
"required": false
},
"settings": {
"description": "Shipping method settings.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "A human readable label for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"description": {
"description": "A human readable description for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"type": {
"description": "Type of setting.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"text",
"email",
"number",
"color",
"password",
"textarea",
"select",
"multiselect",
"radio",
"image_width",
"checkbox",
"class",
"order"
],
"readonly": true
},
"value": {
"description": "Setting value.",
"type": "string",
"context": [
"view",
"edit"
]
},
"default": {
"description": "Default value for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"tip": {
"description": "Additional help text shown to the user about the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"placeholder": {
"description": "Placeholder text to be displayed in text inputs.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"zone_id": {
"description": "Unique ID for the zone.",
"type": "integer",
"required": false
},
"instance_id": {
"description": "Unique ID for the instance.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Whether to bypass bin and force deletion.",
"required": false
}
}
}
]
},
"/wc/v3/taxes/classes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "Tax class name.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/classes"
}
]
}
},
"/wc/v3/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "Unique slug for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"slug": {
"description": "Unique slug for the resource.",
"type": "string",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/taxes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "order",
"description": "Sort collection by object attribute.",
"enum": [
"id",
"order",
"priority"
],
"type": "string",
"required": false
},
"class": {
"description": "Sort by tax class.",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"default": 1,
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"default": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"default": true,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"default": "standard",
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes"
}
]
}
},
"/wc/v3/taxes/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/taxes/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"country": {
"description": "Country ISO 3166 code.",
"type": "string",
"required": false
},
"state": {
"description": "State code.",
"type": "string",
"required": false
},
"postcode": {
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
"type": "string",
"required": false
},
"city": {
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
"type": "string",
"required": false
},
"rate": {
"description": "Tax rate.",
"type": "string",
"required": false
},
"name": {
"description": "Tax rate name.",
"type": "string",
"required": false
},
"priority": {
"description": "Tax priority.",
"type": "integer",
"required": false
},
"compound": {
"description": "Whether or not this is a compound rate.",
"type": "boolean",
"required": false
},
"shipping": {
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean",
"required": false
},
"order": {
"description": "Indicates the order that will appear in queries.",
"type": "integer",
"required": false
},
"class": {
"description": "Tax class.",
"type": "string",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"required": false
},
"postcodes": {
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"cities": {
"description": "List of city names. Introduced in WooCommerce 5.3.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/batch"
}
]
}
},
"/wc/v3/webhooks": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"title"
],
"required": false
},
"status": {
"default": "all",
"description": "Limit result set to webhooks assigned a specific status.",
"type": "string",
"enum": [
"all",
"active",
"paused",
"disabled"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"default": "active",
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"type": "string",
"description": "Webhook topic.",
"required": true
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
},
"delivery_url": {
"type": "string",
"description": "Webhook delivery URL.",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks"
}
]
}
},
"/wc/v3/webhooks/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"description": "Webhook topic.",
"type": "string",
"required": false
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "integer",
"required": false
},
"force": {
"default": false,
"type": "boolean",
"description": "Required to be true, as resource does not support binning.",
"required": false
}
}
}
]
},
"/wc/v3/webhooks/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"description": "A friendly name for the webhook.",
"type": "string",
"required": false
},
"status": {
"description": "Webhook status.",
"type": "string",
"enum": [
"active",
"paused",
"disabled"
],
"required": false
},
"topic": {
"description": "Webhook topic.",
"type": "string",
"required": false
},
"secret": {
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks/batch"
}
]
}
},
"/wc/v3/system_status": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status"
}
]
}
},
"/wc/v3/system_status/tools": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status/tools"
}
]
}
},
"/wc/v3/system_status/tools/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "A unique identifier for the tool.",
"type": "string",
"required": false
},
"name": {
"description": "Tool name.",
"type": "string",
"required": false
},
"action": {
"description": "What running the tool will do.",
"type": "string",
"required": false
},
"description": {
"description": "Tool description.",
"type": "string",
"required": false
},
"success": {
"description": "Did the tool run successfully?",
"type": "boolean",
"required": false
},
"message": {
"description": "Tool return message.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v3/shipping_methods": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping_methods"
}
]
}
},
"/wc/v3/shipping_methods/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
}
}
}
]
},
"/wc/v3/payment_gateways": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/payment_gateways"
}
]
}
},
"/wc/v3/payment_gateways/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the resource.",
"type": "string",
"required": false
},
"title": {
"description": "Payment gateway title on checkout.",
"type": "string",
"required": false
},
"description": {
"description": "Payment gateway description on checkout.",
"type": "string",
"required": false
},
"order": {
"description": "Payment gateway sort order.",
"type": "integer",
"required": false
},
"enabled": {
"description": "Payment gateway enabled status.",
"type": "boolean",
"required": false
},
"settings": {
"description": "Payment gateway settings.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"label": {
"description": "A human readable label for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"description": {
"description": "A human readable description for the setting used in interfaces.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"type": {
"description": "Type of setting.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"text",
"email",
"number",
"color",
"password",
"textarea",
"select",
"multiselect",
"radio",
"image_width",
"checkbox"
],
"readonly": true
},
"value": {
"description": "Setting value.",
"type": "string",
"context": [
"view",
"edit"
]
},
"default": {
"description": "Default value for the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"tip": {
"description": "Additional help text shown to the user about the setting.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"placeholder": {
"description": "Placeholder text to be displayed in text inputs.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
}
}
}
]
},
"/wc/v3/data": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data"
}
]
}
},
"/wc/v3/data/continents": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/continents"
}
]
}
},
"/wc/v3/data/continents/(?P\u003Clocation\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"continent": {
"description": "2 character continent code.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v3/data/countries": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/countries"
}
]
}
},
"/wc/v3/data/countries/(?P\u003Clocation\u003E[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"description": "ISO3166 alpha-2 country code.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v3/data/currencies": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies"
}
]
}
},
"/wc/v3/data/currencies/current": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies/current"
}
]
}
},
"/wc/v3/data/currencies/(?P\u003Ccurrency\u003E[\\w-]{3})": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"description": "ISO4217 currency code.",
"type": "string",
"required": false
}
}
}
]
},
"/wc/v3/orders/(?P\u003Cid\u003E[\\d]+)/receipt": {
"namespace": "wc/v3",
"methods": [
"POST",
"GET"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier of the order.",
"type": "integer",
"required": false
},
"expiration_date": {
"description": "Expiration date formatted as dd-mm-yyyy.",
"type": "string",
"default": null,
"required": false
},
"expiration_days": {
"description": "Number of days to be added to the current date to get the expiration date.",
"type": "integer",
"default": 1,
"required": false
},
"force_new": {
"description": "True to force the creation of a new receipt even if one already exists and has not expired yet.",
"type": "boolean",
"default": false,
"required": false
}
}
},
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier of the order.",
"type": "integer",
"required": false
}
}
}
]
},
"/wc-telemetry": {
"namespace": "wc-telemetry",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wc-telemetry",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry"
}
]
}
},
"/wc-telemetry/tracker": {
"namespace": "wc-telemetry",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"platform": {
"description": "Platform to track.",
"type": "string",
"required": true
},
"version": {
"description": "Platform version to track.",
"type": "string",
"required": true
},
"installation_date": {
"description": "Installation date of the WooCommerce mobile app.",
"type": "string",
"format": "date-time",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry/tracker"
}
]
}
},
"/wccom-site/v3": {
"namespace": "wccom-site/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wccom-site/v3",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3"
}
]
}
},
"/wccom-site/v3/installer": {
"namespace": "wccom-site/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product-id": {
"type": "integer",
"required": true
},
"run-until-step": {
"type": "string",
"enum": [
"get_product_info",
"download_product",
"unpack_product",
"move_product",
"activate_product"
],
"required": true
},
"idempotency-key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer"
}
]
}
},
"/wccom-site/v3/installer/reset": {
"namespace": "wccom-site/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product-id": {
"type": "integer",
"required": true
},
"idempotency-key": {
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer/reset"
}
]
}
},
"/wccom-site/v3/ssr": {
"namespace": "wccom-site/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/ssr"
}
]
}
},
"/wccom-site/v3/status": {
"namespace": "wccom-site/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/status"
}
]
}
},
"/carbon-fields/v1": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "carbon-fields/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1"
}
]
}
},
"/carbon-fields/v1/posts/(?P\u003Cid\u003E\\d+)": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/carbon-fields/v1/terms/(?P\u003Cid\u003E\\d+)": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/carbon-fields/v1/users/(?P\u003Cid\u003E\\d+)": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/carbon-fields/v1/comments/(?P\u003Cid\u003E\\d+)": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
]
},
"/carbon-fields/v1/options": {
"namespace": "carbon-fields/v1",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET",
"POST"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/options"
}
]
}
},
"/carbon-fields/v1/association": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/association"
}
]
}
},
"/carbon-fields/v1/association/options": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/association/options"
}
]
}
},
"/carbon-fields/v1/attachment": {
"namespace": "carbon-fields/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"type": {
"type": "string",
"description": "The requested type: ID or URL.",
"required": true
},
"value": {
"type": "string",
"description": "The ID / URL of the attachment",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/attachment"
}
]
}
},
"/carbon-fields/v1/block-renderer": {
"namespace": "carbon-fields/v1",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"name": {
"type": "string",
"description": "The name of the block.",
"required": true
},
"content": {
"type": "string",
"description": "The content of the block.",
"required": true
},
"post_id": {
"type": "integer",
"description": "ID of the post context.",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/block-renderer"
}
]
}
},
"/wp/v2": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wp/v2",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2"
}
]
}
},
"/wp/v2/posts": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"author": {
"description": "Limit result set to posts assigned to specific authors.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"author_exclude": {
"description": "Ensure result set excludes posts assigned to specific authors.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"trash",
"auto-draft",
"inherit",
"request-pending",
"request-confirmed",
"request-failed",
"request-completed",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft",
"any"
],
"type": "string"
},
"required": false
},
"tax_relation": {
"description": "Limit result set based on relationship between multiple taxonomies.",
"type": "string",
"enum": [
"AND",
"OR"
],
"required": false
},
"categories": {
"description": "Limit result set to items with specific terms assigned in the categories taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"include_children": {
"description": "Whether to include child terms in the terms limiting the result set.",
"type": "boolean",
"default": false
},
"operator": {
"description": "Whether items must be assigned all or any of the specified terms.",
"type": "string",
"enum": [
"AND",
"OR"
],
"default": "OR"
}
},
"additionalProperties": false
}
],
"required": false
},
"categories_exclude": {
"description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"include_children": {
"description": "Whether to include child terms in the terms limiting the result set.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
],
"required": false
},
"tags": {
"description": "Limit result set to items with specific terms assigned in the tags taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"operator": {
"description": "Whether items must be assigned all or any of the specified terms.",
"type": "string",
"enum": [
"AND",
"OR"
],
"default": "OR"
}
},
"additionalProperties": false
}
],
"required": false
},
"tags_exclude": {
"description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
}
},
"additionalProperties": false
}
],
"required": false
},
"sticky": {
"description": "Limit result set to items that are sticky.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"format": {
"description": "The format for the post.",
"type": "string",
"enum": [
"standard",
"aside",
"chat",
"gallery",
"link",
"image",
"quote",
"status",
"video",
"audio"
],
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"sticky": {
"description": "Whether or not the post should be treated as sticky.",
"type": "boolean",
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"categories": {
"description": "The terms assigned to the object in the category taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"tags": {
"description": "The terms assigned to the object in the post_tag taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/posts"
}
]
}
},
"/wp/v2/posts/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"excerpt_length": {
"description": "Override the default excerpt length.",
"type": "integer",
"required": false
},
"password": {
"description": "The password for the post if it is password protected.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"format": {
"description": "The format for the post.",
"type": "string",
"enum": [
"standard",
"aside",
"chat",
"gallery",
"link",
"image",
"quote",
"status",
"video",
"audio"
],
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"sticky": {
"description": "Whether or not the post should be treated as sticky.",
"type": "boolean",
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"categories": {
"description": "The terms assigned to the object in the category taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"tags": {
"description": "The terms assigned to the object in the post_tag taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
}
}
}
]
},
"/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as revisions do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/posts/(?P\u003Cid\u003E[\\d]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"format": {
"description": "The format for the post.",
"type": "string",
"enum": [
"standard",
"aside",
"chat",
"gallery",
"link",
"image",
"quote",
"status",
"video",
"audio"
],
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"sticky": {
"description": "Whether or not the post should be treated as sticky.",
"type": "boolean",
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"categories": {
"description": "The terms assigned to the object in the category taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"tags": {
"description": "The terms assigned to the object in the post_tag taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
]
},
"/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/pages": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"author": {
"description": "Limit result set to posts assigned to specific authors.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"author_exclude": {
"description": "Ensure result set excludes posts assigned to specific authors.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"menu_order": {
"description": "Limit result set to posts with a specific menu_order value.",
"type": "integer",
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title",
"menu_order"
],
"required": false
},
"parent": {
"description": "Limit result set to items with particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"trash",
"auto-draft",
"inherit",
"request-pending",
"request-confirmed",
"request-failed",
"request-completed",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft",
"any"
],
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the object.",
"type": "integer",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"menu_order": {
"description": "The order of the post in relation to other posts.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pages"
}
]
}
},
"/wp/v2/pages/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"excerpt_length": {
"description": "Override the default excerpt length.",
"type": "integer",
"required": false
},
"password": {
"description": "The password for the post if it is password protected.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"parent": {
"description": "The ID for the parent of the object.",
"type": "integer",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"menu_order": {
"description": "The order of the post in relation to other posts.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
}
}
}
]
},
"/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as revisions do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/pages/(?P\u003Cid\u003E[\\d]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent": {
"description": "The ID for the parent of the object.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"menu_order": {
"description": "The order of the post in relation to other posts.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/media": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"author": {
"description": "Limit result set to posts assigned to specific authors.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"author_exclude": {
"description": "Ensure result set excludes posts assigned to specific authors.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
},
"parent": {
"description": "Limit result set to items with particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"parent_exclude": {
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "inherit",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"inherit",
"private",
"trash"
],
"type": "string"
},
"required": false
},
"media_type": {
"default": null,
"description": "Limit result set to attachments of a particular media type.",
"type": "string",
"enum": [
"image",
"video",
"application"
],
"required": false
},
"mime_type": {
"default": null,
"description": "Limit result set to attachments of a particular MIME type.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"alt_text": {
"description": "Alternative text to display when attachment is not displayed.",
"type": "string",
"required": false
},
"caption": {
"description": "The attachment caption.",
"type": "object",
"properties": {
"raw": {
"description": "Caption for the attachment, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML caption for the attachment, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"description": "The attachment description.",
"type": "object",
"properties": {
"raw": {
"description": "Description for the attachment, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML description for the attachment, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
},
"post": {
"description": "The ID for the associated post of the attachment.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/media"
}
]
}
},
"/wp/v2/media/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"author": {
"description": "The ID for the author of the post.",
"type": "integer",
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"comment_status": {
"description": "Whether or not comments are open on the post.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"ping_status": {
"description": "Whether or not the post can be pinged.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"alt_text": {
"description": "Alternative text to display when attachment is not displayed.",
"type": "string",
"required": false
},
"caption": {
"description": "The attachment caption.",
"type": "object",
"properties": {
"raw": {
"description": "Caption for the attachment, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML caption for the attachment, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"description": "The attachment description.",
"type": "object",
"properties": {
"raw": {
"description": "Description for the attachment, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML description for the attachment, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
},
"required": false
},
"post": {
"description": "The ID for the associated post of the attachment.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/media/(?P\u003Cid\u003E[\\d]+)/post-process": {
"namespace": "wp/v2",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "Unique identifier for the attachment.",
"type": "integer",
"required": false
},
"action": {
"type": "string",
"enum": [
"create-image-subsizes"
],
"required": true
}
}
}
]
},
"/wp/v2/media/(?P\u003Cid\u003E[\\d]+)/edit": {
"namespace": "wp/v2",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"src": {
"description": "URL to the edited image file.",
"type": "string",
"format": "uri",
"required": true
},
"modifiers": {
"description": "Array of image edits.",
"type": "array",
"minItems": 1,
"items": {
"description": "Image edit.",
"type": "object",
"required": [
"type",
"args"
],
"oneOf": [
{
"title": "Rotation",
"properties": {
"type": {
"description": "Rotation type.",
"type": "string",
"enum": [
"rotate"
]
},
"args": {
"description": "Rotation arguments.",
"type": "object",
"required": [
"angle"
],
"properties": {
"angle": {
"description": "Angle to rotate clockwise in degrees.",
"type": "number"
}
}
}
}
},
{
"title": "Crop",
"properties": {
"type": {
"description": "Crop type.",
"type": "string",
"enum": [
"crop"
]
},
"args": {
"description": "Crop arguments.",
"type": "object",
"required": [
"left",
"top",
"width",
"height"
],
"properties": {
"left": {
"description": "Horizontal position from the left to begin the crop as a percentage of the image width.",
"type": "number"
},
"top": {
"description": "Vertical position from the top to begin the crop as a percentage of the image height.",
"type": "number"
},
"width": {
"description": "Width of the crop as a percentage of the image width.",
"type": "number"
},
"height": {
"description": "Height of the crop as a percentage of the image height.",
"type": "number"
}
}
}
}
}
]
},
"required": false
},
"rotation": {
"description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.",
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 360,
"exclusiveMaximum": true,
"required": false
},
"x": {
"description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.",
"type": "number",
"minimum": 0,
"maximum": 100,
"required": false
},
"y": {
"description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.",
"type": "number",
"minimum": 0,
"maximum": 100,
"required": false
},
"width": {
"description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.",
"type": "number",
"minimum": 0,
"maximum": 100,
"required": false
},
"height": {
"description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.",
"type": "number",
"minimum": 0,
"maximum": 100,
"required": false
}
}
}
]
},
"/wp/v2/menu-items": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 100,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "menu_order",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title",
"menu_order"
],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"trash",
"auto-draft",
"inherit",
"request-pending",
"request-confirmed",
"request-failed",
"request-completed",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft",
"any"
],
"type": "string"
},
"required": false
},
"tax_relation": {
"description": "Limit result set based on relationship between multiple taxonomies.",
"type": "string",
"enum": [
"AND",
"OR"
],
"required": false
},
"menus": {
"description": "Limit result set to items with specific terms assigned in the menus taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"operator": {
"description": "Whether items must be assigned all or any of the specified terms.",
"type": "string",
"enum": [
"AND",
"OR"
],
"default": "OR"
}
},
"additionalProperties": false
}
],
"required": false
},
"menus_exclude": {
"description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
}
},
"additionalProperties": false
}
],
"required": false
},
"menu_order": {
"description": "Limit result set to posts with a specific menu_order value.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"title": {
"description": "The title for the object.",
"type": [
"string",
"object"
],
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"type": {
"default": "custom",
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
"type": "string",
"enum": [
"taxonomy",
"post_type",
"post_type_archive",
"custom"
],
"required": false
},
"status": {
"default": "publish",
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"parent": {
"default": 0,
"description": "The ID for the parent of the object.",
"type": "integer",
"minimum": 0,
"required": false
},
"attr_title": {
"description": "Text for the title attribute of the link element for this menu item.",
"type": "string",
"required": false
},
"classes": {
"description": "Class names for the link element of this menu item.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"description": {
"description": "The description of this menu item.",
"type": "string",
"required": false
},
"menu_order": {
"default": 1,
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
"type": "integer",
"minimum": 1,
"required": false
},
"object": {
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
"type": "string",
"required": false
},
"object_id": {
"default": 0,
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
"type": "integer",
"minimum": 0,
"required": false
},
"target": {
"description": "The target attribute of the link element for this menu item.",
"type": "string",
"enum": [
"_blank",
""
],
"required": false
},
"url": {
"description": "The URL to which this menu item points.",
"type": "string",
"format": "uri",
"required": false
},
"xfn": {
"description": "The XFN relationship expressed in the link of this menu item.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"menus": {
"description": "The terms assigned to the object in the nav_menu taxonomy.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items"
}
]
}
},
"/wp/v2/menu-items/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"title": {
"description": "The title for the object.",
"type": [
"string",
"object"
],
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"type": {
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
"type": "string",
"enum": [
"taxonomy",
"post_type",
"post_type_archive",
"custom"
],
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"parent": {
"description": "The ID for the parent of the object.",
"type": "integer",
"minimum": 0,
"required": false
},
"attr_title": {
"description": "Text for the title attribute of the link element for this menu item.",
"type": "string",
"required": false
},
"classes": {
"description": "Class names for the link element of this menu item.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"description": {
"description": "The description of this menu item.",
"type": "string",
"required": false
},
"menu_order": {
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
"type": "integer",
"minimum": 1,
"required": false
},
"object": {
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
"type": "string",
"required": false
},
"object_id": {
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
"type": "integer",
"minimum": 0,
"required": false
},
"target": {
"description": "The target attribute of the link element for this menu item.",
"type": "string",
"enum": [
"_blank",
""
],
"required": false
},
"url": {
"description": "The URL to which this menu item points.",
"type": "string",
"format": "uri",
"required": false
},
"xfn": {
"description": "The XFN relationship expressed in the link of this menu item.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"menus": {
"description": "The terms assigned to the object in the nav_menu taxonomy.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/menu-items/(?P\u003Cid\u003E[\\d]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent": {
"description": "The ID for the parent of the object.",
"type": "integer",
"minimum": 0,
"required": false
},
"title": {
"description": "The title for the object.",
"type": [
"string",
"object"
],
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"type": {
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
"type": "string",
"enum": [
"taxonomy",
"post_type",
"post_type_archive",
"custom"
],
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"attr_title": {
"description": "Text for the title attribute of the link element for this menu item.",
"type": "string",
"required": false
},
"classes": {
"description": "Class names for the link element of this menu item.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"description": {
"description": "The description of this menu item.",
"type": "string",
"required": false
},
"menu_order": {
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
"type": "integer",
"minimum": 1,
"required": false
},
"object": {
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
"type": "string",
"required": false
},
"object_id": {
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
"type": "integer",
"minimum": 0,
"required": false
},
"target": {
"description": "The target attribute of the link element for this menu item.",
"type": "string",
"enum": [
"_blank",
""
],
"required": false
},
"url": {
"description": "The URL to which this menu item points.",
"type": "string",
"format": "uri",
"required": false
},
"xfn": {
"description": "The XFN relationship expressed in the link of this menu item.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"menus": {
"description": "The terms assigned to the object in the nav_menu taxonomy.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
]
},
"/wp/v2/menu-items/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/blocks": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"trash",
"auto-draft",
"inherit",
"request-pending",
"request-confirmed",
"request-failed",
"request-completed",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft",
"any"
],
"type": "string"
},
"required": false
},
"tax_relation": {
"description": "Limit result set based on relationship between multiple taxonomies.",
"type": "string",
"enum": [
"AND",
"OR"
],
"required": false
},
"wp_pattern_category": {
"description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"operator": {
"description": "Whether items must be assigned all or any of the specified terms.",
"type": "string",
"enum": [
"AND",
"OR"
],
"default": "OR"
}
},
"additionalProperties": false
}
],
"required": false
},
"wp_pattern_category_exclude": {
"description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
}
},
"additionalProperties": false
}
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"wp_pattern_sync_status": {
"type": "string",
"description": "",
"default": "",
"enum": [
"partial",
"unsynced"
]
},
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"wp_pattern_category": {
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks"
}
]
}
},
"/wp/v2/blocks/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"excerpt_length": {
"description": "Override the default excerpt length.",
"type": "integer",
"required": false
},
"password": {
"description": "The password for the post if it is password protected.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"wp_pattern_sync_status": {
"type": "string",
"description": "",
"default": "",
"enum": [
"partial",
"unsynced"
]
},
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"wp_pattern_category": {
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
}
}
}
]
},
"/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as revisions do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/blocks/(?P\u003Cid\u003E[\\d]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"wp_pattern_sync_status": {
"type": "string",
"description": "",
"default": "",
"enum": [
"partial",
"unsynced"
]
},
"footnotes": {
"type": "string",
"description": "",
"default": ""
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"wp_pattern_category": {
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
]
},
"/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
}
}
}
]
},
"/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as revisions do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/templates/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"slug": {
"description": "Unique slug identifying the template.",
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_\\%-]+",
"required": false
},
"theme": {
"description": "Theme identifier for the template.",
"type": "string",
"required": false
},
"type": {
"description": "Type of template.",
"type": "string",
"required": false
},
"content": {
"description": "Content of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Content for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the template.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
}
},
"required": false
},
"title": {
"description": "Title of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the template, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"description": "Description of template.",
"type": "string",
"required": false
},
"status": {
"description": "Status of template.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
}
}
}
]
},
"/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/templates": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"wp_id": {
"description": "Limit to the specified post ID.",
"type": "integer",
"required": false
},
"area": {
"description": "Limit to the specified template part area.",
"type": "string",
"required": false
},
"post_type": {
"description": "Post type for which to get the templates.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"slug": {
"description": "Unique slug identifying the template.",
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_\\%-]+",
"required": true
},
"theme": {
"description": "Theme identifier for the template.",
"type": "string",
"required": false
},
"type": {
"description": "Type of template.",
"type": "string",
"required": false
},
"content": {
"default": "",
"description": "Content of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Content for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the template.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
}
},
"required": false
},
"title": {
"default": "",
"description": "Title of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the template, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"default": "",
"description": "Description of template.",
"type": "string",
"required": false
},
"status": {
"default": "publish",
"description": "Status of template.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates"
}
]
}
},
"/wp/v2/templates/lookup": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "The slug of the template to get the fallback for",
"type": "string",
"required": true
},
"is_custom": {
"description": "Indicates if a template is custom or part of the template hierarchy",
"type": "boolean",
"required": false
},
"template_prefix": {
"description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates/lookup"
}
]
}
},
"/wp/v2/templates/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"slug": {
"description": "Unique slug identifying the template.",
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_\\%-]+",
"required": false
},
"theme": {
"description": "Theme identifier for the template.",
"type": "string",
"required": false
},
"type": {
"description": "Type of template.",
"type": "string",
"required": false
},
"content": {
"description": "Content of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Content for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the template.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
}
},
"required": false
},
"title": {
"description": "Title of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the template, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"description": "Description of template.",
"type": "string",
"required": false
},
"status": {
"description": "Status of template.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
}
}
}
]
},
"/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as revisions do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/template-parts/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"slug": {
"description": "Unique slug identifying the template.",
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_\\%-]+",
"required": false
},
"theme": {
"description": "Theme identifier for the template.",
"type": "string",
"required": false
},
"type": {
"description": "Type of template.",
"type": "string",
"required": false
},
"content": {
"description": "Content of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Content for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the template.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
}
},
"required": false
},
"title": {
"description": "Title of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the template, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"description": "Description of template.",
"type": "string",
"required": false
},
"status": {
"description": "Status of template.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
},
"area": {
"description": "Where the template part is intended for use (header, footer, etc)",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/template-parts": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"wp_id": {
"description": "Limit to the specified post ID.",
"type": "integer",
"required": false
},
"area": {
"description": "Limit to the specified template part area.",
"type": "string",
"required": false
},
"post_type": {
"description": "Post type for which to get the templates.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"slug": {
"description": "Unique slug identifying the template.",
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_\\%-]+",
"required": true
},
"theme": {
"description": "Theme identifier for the template.",
"type": "string",
"required": false
},
"type": {
"description": "Type of template.",
"type": "string",
"required": false
},
"content": {
"default": "",
"description": "Content of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Content for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the template.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
}
},
"required": false
},
"title": {
"default": "",
"description": "Title of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the template, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"default": "",
"description": "Description of template.",
"type": "string",
"required": false
},
"status": {
"default": "publish",
"description": "Status of template.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
},
"area": {
"description": "Where the template part is intended for use (header, footer, etc)",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts"
}
]
}
},
"/wp/v2/template-parts/lookup": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"slug": {
"description": "The slug of the template to get the fallback for",
"type": "string",
"required": true
},
"is_custom": {
"description": "Indicates if a template is custom or part of the template hierarchy",
"type": "boolean",
"required": false
},
"template_prefix": {
"description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts/lookup"
}
]
}
},
"/wp/v2/template-parts/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"slug": {
"description": "Unique slug identifying the template.",
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_\\%-]+",
"required": false
},
"theme": {
"description": "Theme identifier for the template.",
"type": "string",
"required": false
},
"type": {
"description": "Type of template.",
"type": "string",
"required": false
},
"content": {
"description": "Content of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Content for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit"
]
},
"block_version": {
"description": "Version of the content block format used by the template.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
}
},
"required": false
},
"title": {
"description": "Title of template.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the template, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the template, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"description": {
"description": "Description of template.",
"type": "string",
"required": false
},
"status": {
"description": "Status of template.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"author": {
"description": "The ID for the author of the template.",
"type": "integer",
"required": false
},
"area": {
"description": "Where the template part is intended for use (header, footer, etc)",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/global-styles/(?P\u003Cparent\u003E[\\d]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
}
}
}
]
},
"/wp/v2/global-styles/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the global styles revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the global styles revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/global-styles/themes/(?P\u003Cstylesheet\u003E[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": false
},
"args": {
"stylesheet": {
"description": "The theme identifier",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/global-styles/themes/(?P\u003Cstylesheet\u003E[^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": false
},
"args": {
"stylesheet": {
"description": "The theme identifier",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/global-styles/(?P\u003Cid\u003E[\\/\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": false
},
"args": {
"id": {
"description": "The ID of a template",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": false
},
"args": {
"styles": {
"description": "Global styles.",
"type": [
"object"
],
"required": false
},
"settings": {
"description": "Global settings.",
"type": [
"object"
],
"required": false
},
"title": {
"description": "Title of the global styles variation.",
"type": [
"object",
"string"
],
"properties": {
"raw": {
"description": "Title for the global styles variation, as it exists in the database.",
"type": "string",
"context": [
"view",
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
}
}
}
]
},
"/wp/v2/navigation": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"trash",
"auto-draft",
"inherit",
"request-pending",
"request-confirmed",
"request-failed",
"request-completed",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft",
"any"
],
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit",
"embed"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation"
}
]
}
},
"/wp/v2/navigation/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"password": {
"description": "The password for the post if it is password protected.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit",
"embed"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/revisions": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by object attribute.",
"type": "string",
"default": "date",
"enum": [
"date",
"id",
"include",
"relevance",
"slug",
"include_slugs",
"title"
],
"required": false
}
}
}
]
},
"/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"parent": {
"description": "The ID for the parent of the revision.",
"type": "integer",
"required": false
},
"id": {
"description": "Unique identifier for the revision.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as revisions do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/navigation/(?P\u003Cid\u003E[\\d]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit",
"embed"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit",
"embed"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/font-families": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "id",
"enum": [
"id",
"include"
],
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"theme_json_version": {
"description": "Version of the theme.json schema used for the typography settings.",
"type": "integer",
"default": 3,
"minimum": 2,
"maximum": 3,
"required": false
},
"font_family_settings": {
"description": "font-family declaration in theme.json format, encoded as a string.",
"type": "string",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-families"
}
]
}
},
"/wp/v2/font-families/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"theme_json_version": {
"description": "Version of the theme.json schema used for the typography settings.",
"type": "integer",
"default": 3,
"minimum": 2,
"maximum": 3,
"required": false
},
"font_family_settings": {
"description": "font-family declaration in theme.json format, encoded as a string.",
"type": "string",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/font-families/(?P\u003Cfont_family_id\u003E[\\d]+)/font-faces": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"font_family_id": {
"description": "The ID for the parent font family of the font face.",
"type": "integer",
"required": true
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "id",
"enum": [
"id",
"include"
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"font_family_id": {
"description": "The ID for the parent font family of the font face.",
"type": "integer",
"required": true
},
"theme_json_version": {
"description": "Version of the theme.json schema used for the typography settings.",
"type": "integer",
"default": 3,
"minimum": 2,
"maximum": 3,
"required": false
},
"font_face_settings": {
"description": "font-face declaration in theme.json format, encoded as a string.",
"type": "string",
"required": true
}
}
}
]
},
"/wp/v2/font-families/(?P\u003Cfont_family_id\u003E[\\d]+)/font-faces/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"font_family_id": {
"description": "The ID for the parent font family of the font face.",
"type": "integer",
"required": true
},
"id": {
"description": "Unique identifier for the font face.",
"type": "integer",
"required": true
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"font_family_id": {
"description": "The ID for the parent font family of the font face.",
"type": "integer",
"required": true
},
"id": {
"description": "Unique identifier for the font face.",
"type": "integer",
"required": true
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/product": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to posts published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_after": {
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"before": {
"description": "Limit response to posts published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"modified_before": {
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title",
"popularity",
"rating",
"popularity",
"rating"
],
"required": false
},
"search_columns": {
"default": [],
"description": "Array of column names to be searched.",
"type": "array",
"items": {
"enum": [
"post_title",
"post_content",
"post_excerpt"
],
"type": "string"
},
"required": false
},
"slug": {
"description": "Limit result set to posts with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"status": {
"default": "publish",
"description": "Limit result set to posts assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"trash",
"auto-draft",
"inherit",
"request-pending",
"request-confirmed",
"request-failed",
"request-completed",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft",
"any"
],
"type": "string"
},
"required": false
},
"tax_relation": {
"description": "Limit result set based on relationship between multiple taxonomies.",
"type": "string",
"enum": [
"AND",
"OR"
],
"required": false
},
"product_cat": {
"description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"include_children": {
"description": "Whether to include child terms in the terms limiting the result set.",
"type": "boolean",
"default": false
},
"operator": {
"description": "Whether items must be assigned all or any of the specified terms.",
"type": "string",
"enum": [
"AND",
"OR"
],
"default": "OR"
}
},
"additionalProperties": false
}
],
"required": false
},
"product_cat_exclude": {
"description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"include_children": {
"description": "Whether to include child terms in the terms limiting the result set.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
],
"required": false
},
"product_tag": {
"description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
},
"operator": {
"description": "Whether items must be assigned all or any of the specified terms.",
"type": "string",
"enum": [
"AND",
"OR"
],
"default": "OR"
}
},
"additionalProperties": false
}
],
"required": false
},
"product_tag_exclude": {
"description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.",
"type": [
"object",
"array"
],
"oneOf": [
{
"title": "Term ID List",
"description": "Match terms with the listed IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
{
"title": "Term ID Taxonomy Query",
"description": "Perform an advanced term query.",
"type": "object",
"properties": {
"terms": {
"description": "Term IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": []
}
},
"additionalProperties": false
}
],
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"product_cat": {
"description": "The terms assigned to the object in the product_cat taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"product_tag": {
"description": "The terms assigned to the object in the product_tag taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product"
}
]
}
},
"/wp/v2/product/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"excerpt_length": {
"description": "Override the default excerpt length.",
"type": "integer",
"required": false
},
"password": {
"description": "The password for the post if it is password protected.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"product_cat": {
"description": "The terms assigned to the object in the product_cat taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"product_tag": {
"description": "The terms assigned to the object in the product_tag taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the post.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
}
}
}
]
},
"/wp/v2/product/(?P\u003Cid\u003E[\\d]+)/autosaves": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"date": {
"description": "The date the post was published, in the site's time zone.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the post was published, as GMT.",
"type": [
"string",
"null"
],
"format": "date-time",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the post unique to its type.",
"type": "string",
"required": false
},
"status": {
"description": "A named status for the object.",
"type": "string",
"enum": [
"publish",
"future",
"draft",
"pending",
"private",
"wc-pending",
"wc-processing",
"wc-on-hold",
"wc-completed",
"wc-cancelled",
"wc-refunded",
"wc-failed",
"wc-checkout-draft"
],
"required": false
},
"password": {
"description": "A password to protect access to the content and excerpt.",
"type": "string",
"required": false
},
"title": {
"description": "The title for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Title for the object, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML title for the object, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"content": {
"description": "The content for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"block_version": {
"description": "Version of the content block format used by the post.",
"type": "integer",
"context": [
"edit"
],
"readonly": true
},
"protected": {
"description": "Whether the content is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"excerpt": {
"description": "The excerpt for the post.",
"type": "object",
"properties": {
"raw": {
"description": "Excerpt for the post, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML excerpt for the post, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
},
"protected": {
"description": "Whether the excerpt is protected with a password.",
"type": "boolean",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"featured_media": {
"description": "The ID of the featured media for the post.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"template": {
"description": "The theme file to use to display the post.",
"type": "string",
"required": false
},
"product_cat": {
"description": "The terms assigned to the object in the product_cat taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"product_tag": {
"description": "The terms assigned to the object in the product_tag taxonomy.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
}
}
}
]
},
"/wp/v2/product/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"parent": {
"description": "The ID for the parent of the autosave.",
"type": "integer",
"required": false
},
"id": {
"description": "The ID for the autosave.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/types": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/types"
}
]
}
},
"/wp/v2/types/(?P\u003Ctype\u003E[\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"type": {
"description": "An alphanumeric identifier for the post type.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/statuses": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/statuses"
}
]
}
},
"/wp/v2/statuses/(?P\u003Cstatus\u003E[\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"status": {
"description": "An alphanumeric identifier for the status.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/taxonomies": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"type": {
"description": "Limit results to taxonomies associated with a specific post type.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/taxonomies"
}
]
}
},
"/wp/v2/taxonomies/(?P\u003Ctaxonomy\u003E[\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"taxonomy": {
"description": "An alphanumeric identifier for the taxonomy.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/categories": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by term attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"include_slugs",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide terms not assigned to any posts.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to terms assigned to a specific parent.",
"type": "integer",
"required": false
},
"post": {
"description": "Limit result set to terms assigned to a specific post.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to terms with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The parent term ID.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/categories"
}
]
}
},
"/wp/v2/categories/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The parent term ID.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as terms do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/tags": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by term attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"include_slugs",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide terms not assigned to any posts.",
"type": "boolean",
"default": false,
"required": false
},
"post": {
"description": "Limit result set to terms assigned to a specific post.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to terms with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/tags"
}
]
}
},
"/wp/v2/tags/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as terms do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/menus": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by term attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"include_slugs",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide terms not assigned to any posts.",
"type": "boolean",
"default": false,
"required": false
},
"post": {
"description": "Limit result set to terms assigned to a specific post.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to terms with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"locations": {
"description": "The locations assigned to the menu.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"auto_add": {
"description": "Whether to automatically add top-level pages to this menu.",
"type": "boolean",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menus"
}
]
}
},
"/wp/v2/menus/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
},
"locations": {
"description": "The locations assigned to the menu.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"auto_add": {
"description": "Whether to automatically add top-level pages to this menu.",
"type": "boolean",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as terms do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/wp_pattern_category": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by term attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"include_slugs",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide terms not assigned to any posts.",
"type": "boolean",
"default": false,
"required": false
},
"post": {
"description": "Limit result set to terms assigned to a specific post.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to terms with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/wp_pattern_category"
}
]
}
},
"/wp/v2/wp_pattern_category/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as terms do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/product_cat": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by term attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"include_slugs",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide terms not assigned to any posts.",
"type": "boolean",
"default": false,
"required": false
},
"parent": {
"description": "Limit result set to terms assigned to a specific parent.",
"type": "integer",
"required": false
},
"post": {
"description": "Limit result set to terms assigned to a specific post.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to terms with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The parent term ID.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_cat"
}
]
}
},
"/wp/v2/product_cat/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"parent": {
"description": "The parent term ID.",
"type": "integer",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as terms do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/product_tag": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by term attribute.",
"type": "string",
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"include_slugs",
"term_group",
"description",
"count"
],
"required": false
},
"hide_empty": {
"description": "Whether to hide terms not assigned to any posts.",
"type": "boolean",
"default": false,
"required": false
},
"post": {
"description": "Limit result set to terms assigned to a specific post.",
"type": "integer",
"default": null,
"required": false
},
"slug": {
"description": "Limit result set to terms with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": true
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_tag"
}
]
}
},
"/wp/v2/product_tag/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"description": {
"description": "HTML description of the term.",
"type": "string",
"required": false
},
"name": {
"description": "HTML title for the term.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the term unique to its type.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the term.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as terms do not support binning.",
"required": false
}
}
}
]
},
"/wp/v2/users": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"default": "asc",
"description": "Order sort attribute ascending or descending.",
"enum": [
"asc",
"desc"
],
"type": "string",
"required": false
},
"orderby": {
"default": "name",
"description": "Sort collection by user attribute.",
"enum": [
"id",
"include",
"name",
"registered_date",
"slug",
"include_slugs",
"email",
"url"
],
"type": "string",
"required": false
},
"slug": {
"description": "Limit result set to users with one or more specific slugs.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"roles": {
"description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"capabilities": {
"description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"who": {
"description": "Limit result set to users who are considered authors.",
"type": "string",
"enum": [
"authors"
],
"required": false
},
"has_published_posts": {
"description": "Limit result set to users who have published posts.",
"type": [
"boolean",
"array"
],
"items": {
"type": "string",
"enum": {
"post": "post",
"page": "page",
"attachment": "attachment",
"nav_menu_item": "nav_menu_item",
"wp_block": "wp_block",
"wp_template": "wp_template",
"wp_template_part": "wp_template_part",
"wp_global_styles": "wp_global_styles",
"wp_navigation": "wp_navigation",
"wp_font_family": "wp_font_family",
"wp_font_face": "wp_font_face",
"product": "product"
}
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"username": {
"description": "Login name for the user.",
"type": "string",
"required": true
},
"name": {
"description": "Display name for the user.",
"type": "string",
"required": false
},
"first_name": {
"description": "First name for the user.",
"type": "string",
"required": false
},
"last_name": {
"description": "Last name for the user.",
"type": "string",
"required": false
},
"email": {
"description": "The email address for the user.",
"type": "string",
"format": "email",
"required": true
},
"url": {
"description": "URL of the user.",
"type": "string",
"format": "uri",
"required": false
},
"description": {
"description": "Description of the user.",
"type": "string",
"required": false
},
"locale": {
"description": "Locale for the user.",
"type": "string",
"enum": [
"",
"en_US",
"en_GB",
"fr_BE",
"fr_FR"
],
"required": false
},
"nickname": {
"description": "The nickname for the user.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the user.",
"type": "string",
"required": false
},
"roles": {
"description": "Roles assigned to the user.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"password": {
"description": "Password for the user (never included).",
"type": "string",
"required": true
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"persisted_preferences": {
"type": "object",
"description": "",
"default": [],
"context": [
"edit"
],
"properties": {
"_modified": {
"description": "The date and time the preferences were updated.",
"type": "string",
"format": "date-time",
"readonly": false
}
},
"additionalProperties": true
},
"woocommerce_launch_your_store_tour_hidden": {
"type": "string",
"description": "Indicate whether the user has dismissed the site visibility tour on the home screen.",
"default": ""
},
"woocommerce_coming_soon_banner_dismissed": {
"type": "string",
"description": "Indicate whether the user has dismissed the coming soon notice or not.",
"default": ""
}
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users"
}
]
}
},
"/wp/v2/users/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the user.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the user.",
"type": "integer",
"required": false
},
"username": {
"description": "Login name for the user.",
"type": "string",
"required": false
},
"name": {
"description": "Display name for the user.",
"type": "string",
"required": false
},
"first_name": {
"description": "First name for the user.",
"type": "string",
"required": false
},
"last_name": {
"description": "Last name for the user.",
"type": "string",
"required": false
},
"email": {
"description": "The email address for the user.",
"type": "string",
"format": "email",
"required": false
},
"url": {
"description": "URL of the user.",
"type": "string",
"format": "uri",
"required": false
},
"description": {
"description": "Description of the user.",
"type": "string",
"required": false
},
"locale": {
"description": "Locale for the user.",
"type": "string",
"enum": [
"",
"en_US",
"en_GB",
"fr_BE",
"fr_FR"
],
"required": false
},
"nickname": {
"description": "The nickname for the user.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the user.",
"type": "string",
"required": false
},
"roles": {
"description": "Roles assigned to the user.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"password": {
"description": "Password for the user (never included).",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"persisted_preferences": {
"type": "object",
"description": "",
"default": [],
"context": [
"edit"
],
"properties": {
"_modified": {
"description": "The date and time the preferences were updated.",
"type": "string",
"format": "date-time",
"readonly": false
}
},
"additionalProperties": true
},
"woocommerce_launch_your_store_tour_hidden": {
"type": "string",
"description": "Indicate whether the user has dismissed the site visibility tour on the home screen.",
"default": ""
},
"woocommerce_coming_soon_banner_dismissed": {
"type": "string",
"description": "Indicate whether the user has dismissed the coming soon notice or not.",
"default": ""
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the user.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as users do not support binning.",
"required": false
},
"reassign": {
"type": "integer",
"description": "Reassign the deleted user's posts and links to this user ID.",
"required": true
}
}
}
]
},
"/wp/v2/users/me": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"username": {
"description": "Login name for the user.",
"type": "string",
"required": false
},
"name": {
"description": "Display name for the user.",
"type": "string",
"required": false
},
"first_name": {
"description": "First name for the user.",
"type": "string",
"required": false
},
"last_name": {
"description": "Last name for the user.",
"type": "string",
"required": false
},
"email": {
"description": "The email address for the user.",
"type": "string",
"format": "email",
"required": false
},
"url": {
"description": "URL of the user.",
"type": "string",
"format": "uri",
"required": false
},
"description": {
"description": "Description of the user.",
"type": "string",
"required": false
},
"locale": {
"description": "Locale for the user.",
"type": "string",
"enum": [
"",
"en_US",
"en_GB",
"fr_BE",
"fr_FR"
],
"required": false
},
"nickname": {
"description": "The nickname for the user.",
"type": "string",
"required": false
},
"slug": {
"description": "An alphanumeric identifier for the user.",
"type": "string",
"required": false
},
"roles": {
"description": "Roles assigned to the user.",
"type": "array",
"items": {
"type": "string"
},
"required": false
},
"password": {
"description": "Password for the user (never included).",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": {
"persisted_preferences": {
"type": "object",
"description": "",
"default": [],
"context": [
"edit"
],
"properties": {
"_modified": {
"description": "The date and time the preferences were updated.",
"type": "string",
"format": "date-time",
"readonly": false
}
},
"additionalProperties": true
},
"woocommerce_launch_your_store_tour_hidden": {
"type": "string",
"description": "Indicate whether the user has dismissed the site visibility tour on the home screen.",
"default": ""
},
"woocommerce_coming_soon_banner_dismissed": {
"type": "string",
"description": "Indicate whether the user has dismissed the coming soon notice or not.",
"default": ""
}
},
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"force": {
"type": "boolean",
"default": false,
"description": "Required to be true, as users do not support binning.",
"required": false
},
"reassign": {
"type": "integer",
"description": "Reassign the deleted user's posts and links to this user ID.",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users/me"
}
]
}
},
"/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"app_id": {
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
"type": "string",
"format": "uuid",
"required": false
},
"name": {
"description": "The name of the application password.",
"type": "string",
"minLength": 1,
"pattern": ".*\\S.*",
"required": true
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords/introspect": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords/(?P\u003Cuuid\u003E[\\w\\-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"app_id": {
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
"type": "string",
"format": "uuid",
"required": false
},
"name": {
"description": "The name of the application password.",
"type": "string",
"minLength": 1,
"pattern": ".*\\S.*",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": []
}
]
},
"/wp/v2/comments": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"after": {
"description": "Limit response to comments published after a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"author": {
"description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"author_exclude": {
"description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"author_email": {
"default": null,
"description": "Limit result set to that from a specific author email. Requires authorisation.",
"format": "email",
"type": "string",
"required": false
},
"before": {
"description": "Limit response to comments published before a given ISO8601 compliant date.",
"type": "string",
"format": "date-time",
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by comment attribute.",
"type": "string",
"default": "date_gmt",
"enum": [
"date",
"date_gmt",
"id",
"include",
"post",
"parent",
"type"
],
"required": false
},
"parent": {
"default": [],
"description": "Limit result set to comments of specific parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"parent_exclude": {
"default": [],
"description": "Ensure result set excludes specific parent IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"post": {
"default": [],
"description": "Limit result set to comments assigned to specific post IDs.",
"type": "array",
"items": {
"type": "integer"
},
"required": false
},
"status": {
"default": "approve",
"description": "Limit result set to comments assigned a specific status. Requires authorisation.",
"type": "string",
"required": false
},
"type": {
"default": "comment",
"description": "Limit result set to comments assigned a specific type. Requires authorisation.",
"type": "string",
"required": false
},
"password": {
"description": "The password for the post if it is password protected.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"author": {
"description": "The ID of the user object, if author was a user.",
"type": "integer",
"required": false
},
"author_email": {
"description": "Email address for the comment author.",
"type": "string",
"format": "email",
"required": false
},
"author_ip": {
"description": "IP address for the comment author.",
"type": "string",
"format": "ip",
"required": false
},
"author_name": {
"description": "Display name for the comment author.",
"type": "string",
"required": false
},
"author_url": {
"description": "URL for the comment author.",
"type": "string",
"format": "uri",
"required": false
},
"author_user_agent": {
"description": "User agent for the comment author.",
"type": "string",
"required": false
},
"content": {
"description": "The content for the comment.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the comment, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the comment, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"date": {
"description": "The date the comment was published, in the site's time zone.",
"type": "string",
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the comment was published, as GMT.",
"type": "string",
"format": "date-time",
"required": false
},
"parent": {
"default": 0,
"description": "The ID for the parent of the comment.",
"type": "integer",
"required": false
},
"post": {
"default": 0,
"description": "The ID of the associated post object.",
"type": "integer",
"required": false
},
"status": {
"description": "State of the comment.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/comments"
}
]
}
},
"/wp/v2/comments/(?P\u003Cid\u003E[\\d]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "Unique identifier for the comment.",
"type": "integer",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"password": {
"description": "The password for the parent post of the comment (if the post is password protected).",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"description": "Unique identifier for the comment.",
"type": "integer",
"required": false
},
"author": {
"description": "The ID of the user object, if author was a user.",
"type": "integer",
"required": false
},
"author_email": {
"description": "Email address for the comment author.",
"type": "string",
"format": "email",
"required": false
},
"author_ip": {
"description": "IP address for the comment author.",
"type": "string",
"format": "ip",
"required": false
},
"author_name": {
"description": "Display name for the comment author.",
"type": "string",
"required": false
},
"author_url": {
"description": "URL for the comment author.",
"type": "string",
"format": "uri",
"required": false
},
"author_user_agent": {
"description": "User agent for the comment author.",
"type": "string",
"required": false
},
"content": {
"description": "The content for the comment.",
"type": "object",
"properties": {
"raw": {
"description": "Content for the comment, as it exists in the database.",
"type": "string",
"context": [
"edit"
]
},
"rendered": {
"description": "HTML content for the comment, transformed for display.",
"type": "string",
"context": [
"view",
"edit",
"embed"
],
"readonly": true
}
},
"required": false
},
"date": {
"description": "The date the comment was published, in the site's time zone.",
"type": "string",
"format": "date-time",
"required": false
},
"date_gmt": {
"description": "The date the comment was published, as GMT.",
"type": "string",
"format": "date-time",
"required": false
},
"parent": {
"description": "The ID for the parent of the comment.",
"type": "integer",
"required": false
},
"post": {
"description": "The ID of the associated post object.",
"type": "integer",
"required": false
},
"status": {
"description": "State of the comment.",
"type": "string",
"required": false
},
"meta": {
"description": "Meta fields.",
"type": "object",
"properties": [],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"description": "Unique identifier for the comment.",
"type": "integer",
"required": false
},
"force": {
"type": "boolean",
"default": false,
"description": "Whether to bypass Bin and force deletion.",
"required": false
},
"password": {
"description": "The password for the parent post of the comment (if the post is password protected).",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/search": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"type": {
"default": "post",
"description": "Limit results to items of an object type.",
"type": "string",
"enum": [
"post",
"term",
"post-format"
],
"required": false
},
"subtype": {
"default": "any",
"description": "Limit results to items of one or more object subtypes.",
"type": "array",
"items": {
"enum": [
"post",
"page",
"product",
"category",
"post_tag",
"product_cat",
"product_tag",
"any"
],
"type": "string"
},
"required": false
},
"exclude": {
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
},
"include": {
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
},
"default": [],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/search"
}
]
}
},
"/wp/v2/block-renderer/(?P\u003Cname\u003E[a-z0-9-]+/[a-z0-9-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET",
"POST"
],
"args": {
"name": {
"description": "Unique registered name for the block.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"edit"
],
"default": "view",
"required": false
},
"attributes": {
"description": "Attributes for the block.",
"type": "object",
"default": [],
"required": false
},
"post_id": {
"description": "ID of the post context.",
"type": "integer",
"required": false
}
}
}
]
},
"/wp/v2/block-types": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"namespace": {
"description": "Block namespace.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-types"
}
]
}
},
"/wp/v2/block-types/(?P\u003Cnamespace\u003E[a-zA-Z0-9_-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"namespace": {
"description": "Block namespace.",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/block-types/(?P\u003Cnamespace\u003E[a-zA-Z0-9_-]+)/(?P\u003Cname\u003E[a-zA-Z0-9_-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"name": {
"description": "Block name.",
"type": "string",
"required": false
},
"namespace": {
"description": "Block namespace.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/settings": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"title": {
"title": "Title",
"description": "Site title.",
"type": "string",
"required": false
},
"description": {
"title": "Tagline",
"description": "Site tagline.",
"type": "string",
"required": false
},
"url": {
"title": "",
"description": "Site URL.",
"type": "string",
"format": "uri",
"required": false
},
"email": {
"title": "",
"description": "This address is used for admin purposes, like new user notification.",
"type": "string",
"format": "email",
"required": false
},
"timezone": {
"title": "",
"description": "A city in the same timezone as you.",
"type": "string",
"required": false
},
"date_format": {
"title": "",
"description": "A date format for all date strings.",
"type": "string",
"required": false
},
"time_format": {
"title": "",
"description": "A time format for all time strings.",
"type": "string",
"required": false
},
"start_of_week": {
"title": "",
"description": "A day number of the week that the week should start on.",
"type": "integer",
"required": false
},
"language": {
"title": "",
"description": "WordPress locale code.",
"type": "string",
"required": false
},
"use_smilies": {
"title": "",
"description": "Convert emoticons like :-) and :-P to graphics on display.",
"type": "boolean",
"required": false
},
"default_category": {
"title": "",
"description": "Default post category.",
"type": "integer",
"required": false
},
"default_post_format": {
"title": "",
"description": "Default post format.",
"type": "string",
"required": false
},
"posts_per_page": {
"title": "Maximum posts per page",
"description": "Blog pages show at most.",
"type": "integer",
"required": false
},
"show_on_front": {
"title": "Show on front",
"description": "What to show on the front page",
"type": "string",
"required": false
},
"page_on_front": {
"title": "Page on front",
"description": "The ID of the page that should be displayed on the front page",
"type": "integer",
"required": false
},
"page_for_posts": {
"title": "",
"description": "The ID of the page that should display the latest posts",
"type": "integer",
"required": false
},
"default_ping_status": {
"title": "",
"description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"default_comment_status": {
"title": "Allow comments on new posts",
"description": "Allow people to submit comments on new posts.",
"type": "string",
"enum": [
"open",
"closed"
],
"required": false
},
"site_logo": {
"title": "Logo",
"description": "Site logo.",
"type": "integer",
"required": false
},
"site_icon": {
"title": "Icon",
"description": "Site icon.",
"type": "integer",
"required": false
},
"pickup_location_settings": {
"title": "",
"description": "WooCommerce Local Pickup Method Settings",
"type": "object",
"properties": {
"enabled": {
"description": "If enabled, this method will appear on the block based checkout.",
"type": "string",
"enum": [
"yes",
"no"
]
},
"title": {
"description": "This controls the title which the user sees during checkout.",
"type": "string"
},
"tax_status": {
"description": "If a cost is defined, this controls if taxes are applied to that cost.",
"type": "string",
"enum": [
"taxable",
"none"
]
},
"cost": {
"description": "Optional cost to charge for local pickup.",
"type": "string"
}
},
"additionalProperties": false,
"required": false
},
"pickup_locations": {
"title": "",
"description": "WooCommerce Local Pickup Locations",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"address_1": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postcode": {
"type": "string"
},
"country": {
"type": "string"
}
},
"additionalProperties": false
},
"details": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/settings"
}
]
}
},
"/wp/v2/themes": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"status": {
"description": "Limit result set to themes assigned one or more statuses.",
"type": "array",
"items": {
"enum": [
"active",
"inactive"
],
"type": "string"
},
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/themes"
}
]
}
},
"/wp/v2/themes/(?P\u003Cstylesheet\u003E[^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"stylesheet": {
"description": "The theme's style sheet. This uniquely identifies the theme.",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/plugins": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"required": false
},
"status": {
"description": "Limits results to plugins with the given status.",
"type": "array",
"items": {
"type": "string",
"enum": [
"inactive",
"active"
]
},
"required": false
}
}
},
{
"methods": [
"POST"
],
"args": {
"slug": {
"type": "string",
"description": "WordPress.org plugin directory slug.",
"pattern": "[\\w\\-]+",
"required": true
},
"status": {
"description": "The plugin activation status.",
"type": "string",
"enum": [
"inactive",
"active"
],
"default": "inactive",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/plugins"
}
]
}
},
"/wp/v2/plugins/(?P\u003Cplugin\u003E[^.\\/]+(?:\\/[^.\\/]+)?)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"plugin": {
"type": "string",
"pattern": "[^.\\/]+(?:\\/[^.\\/]+)?",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"plugin": {
"type": "string",
"pattern": "[^.\\/]+(?:\\/[^.\\/]+)?",
"required": false
},
"status": {
"description": "The plugin activation status.",
"type": "string",
"enum": [
"inactive",
"active"
],
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"plugin": {
"type": "string",
"pattern": "[^.\\/]+(?:\\/[^.\\/]+)?",
"required": false
}
}
}
]
},
"/wp/v2/sidebars": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/sidebars"
}
]
}
},
"/wp/v2/sidebars/(?P\u003Cid\u003E[\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "The ID of a registered sidebar",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"widgets": {
"description": "Nested widgets.",
"type": "array",
"items": {
"type": [
"object",
"string"
]
},
"required": false
}
}
}
]
},
"/wp/v2/widget-types": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/widget-types"
}
]
}
},
"/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"description": "The widget type ID.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)/encode": {
"namespace": "wp/v2",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "The widget type ID.",
"type": "string",
"required": true
},
"instance": {
"description": "Current instance settings of the widget.",
"type": "object",
"required": false
},
"form_data": {
"description": "Serialised widget form data to encode into instance settings.",
"type": "string",
"required": false
}
}
}
]
},
"/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)/render": {
"namespace": "wp/v2",
"methods": [
"POST"
],
"endpoints": [
{
"methods": [
"POST"
],
"args": {
"id": {
"description": "The widget type ID.",
"type": "string",
"required": true
},
"instance": {
"description": "Current instance settings of the widget.",
"type": "object",
"required": false
}
}
}
]
},
"/wp/v2/widgets": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"sidebar": {
"description": "The sidebar for which to return widgets.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"POST"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the widget.",
"type": "string",
"required": false
},
"id_base": {
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
"type": "string",
"required": false
},
"sidebar": {
"default": "wp_inactive_widgets",
"description": "The sidebar to which the widget belongs.",
"type": "string",
"required": true
},
"instance": {
"description": "Instance settings of the widget, if supported.",
"type": "object",
"properties": {
"encoded": {
"description": "Base64 encoded representation of the instance settings.",
"type": "string",
"context": [
"edit"
]
},
"hash": {
"description": "Cryptographic hash of the instance settings.",
"type": "string",
"context": [
"edit"
]
},
"raw": {
"description": "Unencoded instance settings, if supported.",
"type": "object",
"context": [
"edit"
]
}
},
"required": false
},
"form_data": {
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
"type": "string",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/widgets"
}
]
}
},
"/wp/v2/widgets/(?P\u003Cid\u003E[\\w\\-]+)": {
"namespace": "wp/v2",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"allow_batch": {
"v1": true
},
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"allow_batch": {
"v1": true
},
"args": {
"id": {
"description": "Unique identifier for the widget.",
"type": "string",
"required": false
},
"id_base": {
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
"type": "string",
"required": false
},
"sidebar": {
"description": "The sidebar to which the widget belongs.",
"type": "string",
"required": false
},
"instance": {
"description": "Instance settings of the widget, if supported.",
"type": "object",
"properties": {
"encoded": {
"description": "Base64 encoded representation of the instance settings.",
"type": "string",
"context": [
"edit"
]
},
"hash": {
"description": "Cryptographic hash of the instance settings.",
"type": "string",
"context": [
"edit"
]
},
"raw": {
"description": "Unencoded instance settings, if supported.",
"type": "object",
"context": [
"edit"
]
}
},
"required": false
},
"form_data": {
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
"type": "string",
"required": false
}
}
},
{
"methods": [
"DELETE"
],
"allow_batch": {
"v1": true
},
"args": {
"force": {
"description": "Whether to force removal of the widget, or move it to the inactive sidebar.",
"type": "boolean",
"required": false
}
}
}
]
},
"/wp/v2/block-directory/search": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
},
"term": {
"description": "Limit result set to blocks matching the search term.",
"type": "string",
"minLength": 1,
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-directory/search"
}
]
}
},
"/wp/v2/pattern-directory/patterns": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 100,
"minimum": 1,
"maximum": 100,
"required": false
},
"search": {
"description": "Limit results to those matching a string.",
"type": "string",
"minLength": 1,
"required": false
},
"category": {
"description": "Limit results to those matching a category ID.",
"type": "integer",
"minimum": 1,
"required": false
},
"keyword": {
"description": "Limit results to those matching a keyword ID.",
"type": "integer",
"minimum": 1,
"required": false
},
"slug": {
"description": "Limit results to those matching a pattern (slug).",
"type": "array",
"required": false
},
"offset": {
"description": "Offset the result set by a specific number of items.",
"type": "integer",
"required": false
},
"order": {
"description": "Order sort attribute ascending or descending.",
"type": "string",
"default": "desc",
"enum": [
"asc",
"desc"
],
"required": false
},
"orderby": {
"description": "Sort collection by post attribute.",
"type": "string",
"default": "date",
"enum": [
"author",
"date",
"id",
"include",
"modified",
"parent",
"relevance",
"slug",
"include_slugs",
"title",
"favorite_count"
],
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pattern-directory/patterns"
}
]
}
},
"/wp/v2/block-patterns/patterns": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/patterns"
}
]
}
},
"/wp/v2/block-patterns/categories": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/categories"
}
]
}
},
"/wp-site-health/v1": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wp-site-health/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1"
}
]
}
},
"/wp-site-health/v1/tests/background-updates": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/background-updates"
}
]
}
},
"/wp-site-health/v1/tests/loopback-requests": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/loopback-requests"
}
]
}
},
"/wp-site-health/v1/tests/https-status": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/https-status"
}
]
}
},
"/wp-site-health/v1/tests/dotorg-communication": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/dotorg-communication"
}
]
}
},
"/wp-site-health/v1/tests/authorization-header": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/authorization-header"
}
]
}
},
"/wp-site-health/v1/directory-sizes": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/directory-sizes"
}
]
}
},
"/wp-site-health/v1/tests/page-cache": {
"namespace": "wp-site-health/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/page-cache"
}
]
}
},
"/wp-block-editor/v1": {
"namespace": "wp-block-editor/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"default": "wp-block-editor/v1",
"required": false
},
"context": {
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1"
}
]
}
},
"/wp-block-editor/v1/url-details": {
"namespace": "wp-block-editor/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"url": {
"description": "The URL to process.",
"type": "string",
"format": "uri",
"required": true
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/url-details"
}
]
}
},
"/wp/v2/menu-locations": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-locations"
}
]
}
},
"/wp/v2/menu-locations/(?P\u003Clocation\u003E[\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"description": "An alphanumeric identifier for the menu location.",
"type": "string",
"required": false
},
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
},
"/wp-block-editor/v1/export": {
"namespace": "wp-block-editor/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/export"
}
]
}
},
"/wp-block-editor/v1/navigation-fallback": {
"namespace": "wp-block-editor/v1",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/navigation-fallback"
}
]
}
},
"/wp/v2/font-collections": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
},
"page": {
"description": "Current page of the collection.",
"type": "integer",
"default": 1,
"minimum": 1,
"required": false
},
"per_page": {
"description": "Maximum number of items to be returned in result set.",
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"required": false
}
}
}
],
"_links": {
"self": [
{
"href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-collections"
}
]
}
},
"/wp/v2/font-collections/(?P\u003Cslug\u003E[\\/\\w-]+)": {
"namespace": "wp/v2",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string",
"enum": [
"view",
"embed",
"edit"
],
"default": "view",
"required": false
}
}
}
]
}
},
"site_logo": 0,
"site_icon": 0,
"site_icon_url": "",
"_links": {
"help": [
{
"href": "https://developer.wordpress.org/rest-api/"
}
]
}
}
Reference in a new issue View git blame Copy permalink