105456 lines
3.1 MiB
Executable file
105456 lines
3.1 MiB
Executable file
{
|
|
"components": {
|
|
"schemas": {
|
|
"Count Low in Stock Items": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"properties": {
|
|
"total": "integer"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "Count Low in Stock Items",
|
|
"type": "object"
|
|
},
|
|
"Install Async Schema": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"properties": {
|
|
"job_id": "integer",
|
|
"status": {
|
|
"enum": [
|
|
"complete",
|
|
"failed",
|
|
"pending"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "Install Async Schema",
|
|
"type": "object"
|
|
},
|
|
"Install and Activate Schema": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"properties": {
|
|
"activate": {
|
|
"properties": {
|
|
"activated": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"active": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"errors": {
|
|
"properties": {
|
|
"error_data": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"patternProperties": {
|
|
"^.*$": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"errors": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"patternProperties": {
|
|
"^.*$": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"install": {
|
|
"properties": {
|
|
"errors": {
|
|
"properties": {
|
|
"error_data": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"patternProperties": {
|
|
"^.*$": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"errors": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"patternProperties": {
|
|
"^.*$": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"installed": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"results": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "Install and Activate Schema",
|
|
"type": "object"
|
|
},
|
|
"ai/business-description": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/business-description",
|
|
"type": "object"
|
|
},
|
|
"ai/images": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/images",
|
|
"type": "object"
|
|
},
|
|
"ai/patterns": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/patterns",
|
|
"type": "object"
|
|
},
|
|
"ai/product": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/product",
|
|
"type": "object"
|
|
},
|
|
"ai/products": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/products",
|
|
"type": "object"
|
|
},
|
|
"ai/store-info": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/store-info",
|
|
"type": "object"
|
|
},
|
|
"ai/store-title": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "ai/store-title",
|
|
"type": "object"
|
|
},
|
|
"application-password": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"app_id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The GMT date the application password was created.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"last_ip": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The IP address the application password was last used by.",
|
|
"format": "ip",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"last_used": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The GMT date the application password was last used.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The name of the application password.",
|
|
"minLength": 1,
|
|
"pattern": ".*\\S.*",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "The generated password. Only available after adding an application.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"uuid": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The unique identifier for the application password.",
|
|
"format": "uuid",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "application-password",
|
|
"type": "object"
|
|
},
|
|
"attachment": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}",
|
|
"rel": "https:/api.w.org/action-assign-author",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"author": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can change the author on this post."
|
|
}
|
|
],
|
|
"properties": {
|
|
"alt_text": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Alternative text to display when attachment is not displayed.",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"caption": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The attachment caption.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Caption for the attachment, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML caption for the attachment, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"class_list": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An array of the class names for the post container element.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not comments are open on the post.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The attachment description.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Description for the attachment, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description for the attachment, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"generated_slug": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Slug automatically generated from the post title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"media_details": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Details about the media file, specific to its type.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"media_type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Attachment type.",
|
|
"enum": [
|
|
"file",
|
|
"image"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"mime_type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The attachment MIME type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"missing_image_sizes": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "List of the missing image sizes of the attachment.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"permalink_template": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Permalink template for the post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not the post can be pinged.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"post": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The ID for the associated post of the attachment.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"source_url": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the original attachment file.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "attachment",
|
|
"type": "object"
|
|
},
|
|
"batch": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"create": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of created resources.",
|
|
"items": {
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"delete": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of deleted resources.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"update": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of updated resources.",
|
|
"items": {
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "batch",
|
|
"type": "object"
|
|
},
|
|
"block-directory-item": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"active_installs": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The number of sites that have activated this block.",
|
|
"type": "integer"
|
|
},
|
|
"author": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The WordPress.org username of the block author.",
|
|
"type": "string"
|
|
},
|
|
"author_block_count": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The number of blocks published by the same author.",
|
|
"type": "integer"
|
|
},
|
|
"author_block_rating": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The average rating of blocks published by the same author.",
|
|
"type": "number"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "A short description of the block, in human readable format.",
|
|
"type": "string"
|
|
},
|
|
"humanized_updated": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The date when the block was last updated, in fuzzy human readable format.",
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The block icon.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The block slug.",
|
|
"type": "string"
|
|
},
|
|
"last_updated": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The date when the block was last updated.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The block name, in namespace/block-name format.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The star rating of the block.",
|
|
"type": "number"
|
|
},
|
|
"rating_count": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The number of ratings.",
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The block title, in human readable format.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "block-directory-item",
|
|
"type": "object"
|
|
},
|
|
"block-pattern": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"block_types": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Block types that the pattern is intended to be used with.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"categories": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern's category slugs.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern content.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern detailed description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"inserter": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Determines whether the pattern is visible in inserter.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"keywords": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern keywords.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"post_types": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An array of post types that the pattern is restricted to be used with.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"source": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Where the pattern comes from e.g. core",
|
|
"enum": [
|
|
"core",
|
|
"pattern-directory/core",
|
|
"pattern-directory/featured",
|
|
"pattern-directory/theme",
|
|
"plugin",
|
|
"theme"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"template_types": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An array of template types where the pattern fits.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern title, in human readable format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"viewport_width": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern viewport width for inserter preview.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"title": "block-pattern",
|
|
"type": "object"
|
|
},
|
|
"block-pattern-category": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The category description in a human-readable format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The category label, in human readable format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The category name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "block-pattern-category",
|
|
"type": "object"
|
|
},
|
|
"block-type": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"allowed_blocks": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Allowed child block types.",
|
|
"items": {
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
},
|
|
"ancestor": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Ancestor blocks.",
|
|
"items": {
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
},
|
|
"api_version": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "Version of block API.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"attributes": {
|
|
"additionalProperties": {
|
|
"type": "object"
|
|
},
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Block attributes.",
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"block_hooks": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "This block is automatically inserted near any occurrence of the block types used as keys of this map, into a relative position given by the corresponding value.",
|
|
"patternProperties": {
|
|
"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": {
|
|
"enum": [
|
|
"after",
|
|
"before",
|
|
"first_child",
|
|
"last_child"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"category": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Block category.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Description of block type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"editor_script": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"editor_script_handles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Editor script handles.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"editor_style": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"editor_style_handles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Editor style handles.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"example": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Block example.",
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "The attributes used in the example.",
|
|
"type": "object"
|
|
},
|
|
"innerBlocks": {
|
|
"description": "The list of inner blocks used in the example.",
|
|
"items": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "The attributes of the inner block.",
|
|
"type": "object"
|
|
},
|
|
"innerBlocks": {
|
|
"description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "The name of the inner block.",
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"icon": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Icon of block type.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"is_dynamic": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "Is the block dynamically rendered.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"keywords": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Block keywords.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique name identifying the block type.",
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Parent blocks.",
|
|
"items": {
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
},
|
|
"provides_context": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Context provided by blocks of this type.",
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"script": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"script_handles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Public facing and editor script handles.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"selectors": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Custom CSS selectors.",
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"style": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"style_handles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Public facing and editor style handles.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"styles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Block style variations.",
|
|
"items": {
|
|
"properties": {
|
|
"inline_style": {
|
|
"description": "Inline CSS code that registers the CSS class required for the style.",
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"description": "The human-readable label for the style.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Unique name identifying the style.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"style_handle": {
|
|
"description": "Contains the handle that defines the block style.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"supports": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Block supports.",
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"textdomain": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Public text domain.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Title of block type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"uses_context": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Context values inherited by blocks of this type.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Block variations.",
|
|
"items": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "The initial values for attributes.",
|
|
"type": "object"
|
|
},
|
|
"category": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Block category.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "A detailed variation description.",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
"example": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Block example.",
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "The attributes used in the example.",
|
|
"type": "object"
|
|
},
|
|
"innerBlocks": {
|
|
"description": "The list of inner blocks used in the example.",
|
|
"items": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "The attributes of the inner block.",
|
|
"type": "object"
|
|
},
|
|
"innerBlocks": {
|
|
"description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "The name of the inner block.",
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"icon": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Icon of block type.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"innerBlocks": {
|
|
"description": "The list of inner blocks used in the example.",
|
|
"items": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "The attributes of the inner block.",
|
|
"type": "object"
|
|
},
|
|
"innerBlocks": {
|
|
"description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "The name of the inner block.",
|
|
"pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isDefault": {
|
|
"default": false,
|
|
"description": "Indicates whether the current variation is the default one.",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
"keywords": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Block keywords.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "The unique and machine-readable name.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"default": null,
|
|
"description": "The list of scopes where the variation is applicable. When not provided, it assumes all available scopes.",
|
|
"items": {
|
|
"enum": [
|
|
"block",
|
|
"inserter",
|
|
"transform"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
},
|
|
"title": {
|
|
"description": "A human-readable variation title.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"view_script": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": null,
|
|
"description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"view_script_handles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Public facing script handles.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"view_script_module_ids": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Public-facing script module IDs.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"view_style_handles": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Public-facing style handles.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
}
|
|
},
|
|
"title": "block-type",
|
|
"type": "object"
|
|
},
|
|
"cart": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"billing_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current set billing address for the customer.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Email",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of applied basket coupons.",
|
|
"items": {
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The coupon's unique code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The discount type for the coupon (eg percentage or fixed amount)",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount applied by this coupon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax removed due to discount applied by this coupon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"cross_sells": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of cross-sells items related to basket items.",
|
|
"items": {
|
|
"properties": {
|
|
"add_to_cart": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Add to basket button parameters.",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Button description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"maximum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The maximum quantity that can be added to the basket.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"minimum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The minimum quantity that can be added to the basket.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"multiple_of": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "The amount that quantities increment by. Quantity must be an multiple of this value.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"text": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Button text.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Add to basket URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"attributes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of attributes (taxonomy terms) assigned to the product. For variable products, these are mapped to variations (see the `variations` field).",
|
|
"items": {
|
|
"properties": {
|
|
"has_variations": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if this attribute is used by product variations.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The attribute ID, or 0 if the attribute is not taxonomy based.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The attribute name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The attribute taxonomy, or null if the attribute is not taxonomy based.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of assigned attribute terms.",
|
|
"items": {
|
|
"properties": {
|
|
"default": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If this is a default attribute",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The term ID, or 0 if the attribute is not a global attribute.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The term name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The term slug.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"average_rating": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reviews average rating.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of categories, if applicable.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Category ID",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Category link",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Category name",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Category slug",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product full description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"has_options": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Does the product have additional options before it can be added to the basket?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"images": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of images.",
|
|
"items": {
|
|
"properties": {
|
|
"alt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image alternative text.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sizes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail sizes for responsive images.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Full size image URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"srcset": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail srcset for responsive images.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"thumbnail": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"is_in_stock": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Is the product in stock?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_on_backorder": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Is the product stock backordered? This will also return false if backorder notifications are turned off.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_purchasable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Is the product purchasable?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"low_stock_remaining": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity left in stock if stock is low, or null if not applicable.",
|
|
"readonly": true,
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"on_sale": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Is the product on sale?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ID of the parent product, if applicable.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price_html": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price string formatted as HTML.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price data provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price_range": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price range, if applicable.",
|
|
"properties": {
|
|
"max_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"min_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"review_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of reviews that the product has.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"short_description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product short description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product slug.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If true, only one item of this product is allowed for purchase in a single order.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of tags, if applicable.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tag ID",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tag link",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tag name",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tag slug",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variation": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product variation attributes, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variations": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of variation IDs, if applicable.",
|
|
"items": {
|
|
"properties": {
|
|
"attributes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of variation attributes.",
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The attribute name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The assigned attribute.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The attribute ID, or 0 if the attribute is not taxonomy based.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"errors": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of basket item errors, for example, items in the basket which are out of stock.",
|
|
"items": {
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Error code",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Error message",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"fees": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of basket fees.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the fee within the basket.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Fee name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Fee total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total amount for this fee.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax amount for this fee.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"has_calculated_shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the basket meets the criteria for showing shipping costs, and rates have been calculated and included in the totals.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of basket items.",
|
|
"items": {
|
|
"properties": {
|
|
"backorders_allowed": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if backorders are allowed past stock availability.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean"
|
|
]
|
|
},
|
|
"catalog_visibility": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether the product is visible in the catalogue",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product full description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The item product or variation ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"images": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of images.",
|
|
"items": {
|
|
"properties": {
|
|
"alt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image alternative text.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sizes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail sizes for responsive images.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Full size image URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"srcset": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail srcset for responsive images.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"thumbnail": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"item_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Metadata related to the item",
|
|
"items": {
|
|
"properties": {
|
|
"display": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Optionally, how the metadata value should be displayed to the user.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the metadata.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Value of the metadata.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the item.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"low_stock_remaining": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity left in stock if stock is low, or null if not applicable.",
|
|
"readonly": true,
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price_range": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price range, if applicable.",
|
|
"properties": {
|
|
"max_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"min_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"raw_prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.",
|
|
"properties": {
|
|
"precision": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal precision of the returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity of this item.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"quantity_limits": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "How the quantity of this item should be controlled, for example, any limits in place.",
|
|
"properties": {
|
|
"editable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": true,
|
|
"description": "If the quantity is editable or fixed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"maximum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The maximum quantity allowed for this line item.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"minimum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The minimum quantity allowed for this line item.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"multiple_of": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "The amount that quantities increment by. Quantity must be an multiple of this value.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"short_description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product short description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"show_backorder_badge": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the product is on backorder.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean"
|
|
]
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Stock keeping unit, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If true, only one item of this product is allowed for purchase in a single order.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal (the price of the product before coupon discounts have been applied).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_subtotal_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (the price of the product after coupon discounts have been applied).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The item type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variation": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Chosen attributes (for variations).",
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation attribute name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation attribute value.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"items_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of items in the basket.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"items_weight": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total weight (in grams) of all products in the basket.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"needs_payment": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"needs_shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"payment_methods": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of available payment method IDs that can be used to process the order.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"payment_requirements": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of required payment gateway features to process the order.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"shipping_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current set shipping address for the customer.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"shipping_rates": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of available shipping rates for the basket.",
|
|
"items": {
|
|
"properties": {
|
|
"destination": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping destination address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First line of the address being shipped to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Second line of the address being shipped to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City of the address being shipped to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code for the country of the address being shipped to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Zip or Postcode of the address being shipped to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code, or name, for the state, province, or district of the address being shipped to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of basket items the returned shipping rates apply to.",
|
|
"items": {
|
|
"properties": {
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the item.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity of the item in the current package.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the package.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"package_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The ID of the package the shipping rates belong to.",
|
|
"readonly": true,
|
|
"type": [
|
|
"integer",
|
|
"string"
|
|
]
|
|
},
|
|
"shipping_rates": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of shipping rates.",
|
|
"items": {
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"delivery_time": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Delivery time estimate text, e.g. 3-5 business days.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"instance_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Instance ID of the shipping method that provided the rate.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data attached to the shipping rate.",
|
|
"items": {
|
|
"properties": {
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"method_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ID of the shipping method that provided the rate.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the shipping rate, e.g. Express shipping.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price of this shipping rate using the smallest unit of the currency.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rate_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ID of the shipping rate.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"selected": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if this is the rate currently selected by the customer for the basket.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Taxes applied to this shipping rate using the smallest unit of the currency.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Basket total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Lines of taxes applied to items and shipping.",
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The name of the tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The amount of tax charged.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rate": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The rate at which tax is applied.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total_discount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount from applied coupons.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax removed due to discount from applied coupons.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_fees": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price of any applied fees.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_fees_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax on fees.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price of items in the basket.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_items_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax on items in the basket.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price the customer will pay.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"total_shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax applied to items and shipping.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "cart",
|
|
"type": "object"
|
|
},
|
|
"cart-extensions": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "cart-extensions",
|
|
"type": "object"
|
|
},
|
|
"cart_coupon": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The coupon's unique code.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The discount type for the coupon (eg percentage or fixed amount)",
|
|
"type": "string"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount applied by this coupon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax removed due to discount applied by this coupon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "cart_coupon",
|
|
"type": "object"
|
|
},
|
|
"cart_item": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"backorders_allowed": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if backorders are allowed past stock availability.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean"
|
|
]
|
|
},
|
|
"catalog_visibility": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether the product is visible in the catalogue",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product full description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The item product or variation ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"images": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of images.",
|
|
"items": {
|
|
"properties": {
|
|
"alt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image alternative text.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image name.",
|
|
"type": "string"
|
|
},
|
|
"sizes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail sizes for responsive images.",
|
|
"type": "string"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Full size image URL.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"srcset": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail srcset for responsive images.",
|
|
"type": "string"
|
|
},
|
|
"thumbnail": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail URL.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"item_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Metadata related to the item",
|
|
"items": {
|
|
"properties": {
|
|
"display": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Optionally, how the metadata value should be displayed to the user.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the metadata.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Value of the metadata.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the item.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"low_stock_remaining": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity left in stock if stock is low, or null if not applicable.",
|
|
"readonly": true,
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price_range": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price range, if applicable.",
|
|
"properties": {
|
|
"max_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"min_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"raw_prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.",
|
|
"properties": {
|
|
"precision": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal precision of the returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity of this item.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"quantity_limits": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "How the quantity of this item should be controlled, for example, any limits in place.",
|
|
"properties": {
|
|
"editable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": true,
|
|
"description": "If the quantity is editable or fixed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"maximum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The maximum quantity allowed for this line item.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"minimum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The minimum quantity allowed for this line item.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"multiple_of": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "The amount that quantities increment by. Quantity must be an multiple of this value.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"short_description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product short description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"show_backorder_badge": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the product is on backorder.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean"
|
|
]
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Stock keeping unit, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If true, only one item of this product is allowed for purchase in a single order.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal (the price of the product before coupon discounts have been applied).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_subtotal_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (the price of the product after coupon discounts have been applied).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The item type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variation": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Chosen attributes (for variations).",
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation attribute name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation attribute value.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "cart_item",
|
|
"type": "object"
|
|
},
|
|
"category": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published posts for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL of the term.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type attribution for the term.",
|
|
"enum": [
|
|
"category"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "category",
|
|
"type": "object"
|
|
},
|
|
"checkout": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"additional_fields": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Additional fields to be persisted on the order.",
|
|
"properties": [],
|
|
"required": false,
|
|
"type": "object"
|
|
},
|
|
"billing_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Billing address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Email",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": true,
|
|
"type": "object"
|
|
},
|
|
"create_account": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether to create a new user account as part of order processing.",
|
|
"type": "boolean"
|
|
},
|
|
"customer_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer ID if registered. Will return 0 for guests.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Note added to the order by the customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"woocommerce/order-attribution": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Extension data registered by woocommerce/order-attribution",
|
|
"properties": {
|
|
"referrer": {
|
|
"context": [],
|
|
"description": "Order attribution field: referrer",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_count": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_count",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_entry": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_entry",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_pages": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_pages",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_start_time": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_start_time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"source_type": {
|
|
"context": [],
|
|
"description": "Order attribution field: source_type",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"user_agent": {
|
|
"context": [],
|
|
"description": "Order attribution field: user_agent",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_campaign": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_campaign",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_content": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_content",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_creative_format": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_creative_format",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_id": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_id",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_marketing_tactic": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_marketing_tactic",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_medium": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_medium",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_source": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_source",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_source_platform": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_source_platform",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_term": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_term",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"order_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The order ID to process during checkout.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order key used to check validity or protect access to certain order data.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order_number": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order number used for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"payment_method": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The ID of the payment method being used to process the payment.",
|
|
"enum": [
|
|
"bacs",
|
|
"cheque",
|
|
"cod"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"payment_result": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Result of payment processing, or false if not yet processed.",
|
|
"properties": {
|
|
"payment_details": {
|
|
"description": "An array of data being returned from the payment gateway.",
|
|
"items": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"payment_status": {
|
|
"description": "Status of the payment returned by the gateway. One of success, pending, failure, error.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"redirect_url": {
|
|
"description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"shipping_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order status. Payment providers will update this value after payment.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "checkout",
|
|
"type": "object"
|
|
},
|
|
"checkout-order": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"additional_fields": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Additional fields to be persisted on the order.",
|
|
"properties": [],
|
|
"required": false,
|
|
"type": "object"
|
|
},
|
|
"billing_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Billing address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Email",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": true,
|
|
"type": "object"
|
|
},
|
|
"customer_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer ID if registered. Will return 0 for guests.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Note added to the order by the customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"woocommerce/order-attribution": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Extension data registered by woocommerce/order-attribution",
|
|
"properties": {
|
|
"referrer": {
|
|
"context": [],
|
|
"description": "Order attribution field: referrer",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_count": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_count",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_entry": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_entry",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_pages": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_pages",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"session_start_time": {
|
|
"context": [],
|
|
"description": "Order attribution field: session_start_time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"source_type": {
|
|
"context": [],
|
|
"description": "Order attribution field: source_type",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"user_agent": {
|
|
"context": [],
|
|
"description": "Order attribution field: user_agent",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_campaign": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_campaign",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_content": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_content",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_creative_format": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_creative_format",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_id": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_id",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_marketing_tactic": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_marketing_tactic",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_medium": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_medium",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_source": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_source",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_source_platform": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_source_platform",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"utm_term": {
|
|
"context": [],
|
|
"description": "Order attribution field: utm_term",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"order_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The order ID to process during checkout.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order key used to check validity or protect access to certain order data.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order_number": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order number used for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"payment_method": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The ID of the payment method being used to process the payment.",
|
|
"enum": [
|
|
"bacs",
|
|
"cheque",
|
|
"cod"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"payment_result": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Result of payment processing, or false if not yet processed.",
|
|
"properties": {
|
|
"payment_details": {
|
|
"description": "An array of data being returned from the payment gateway.",
|
|
"items": {
|
|
"properties": {
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"payment_status": {
|
|
"description": "Status of the payment returned by the gateway. One of success, pending, failure, error.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"redirect_url": {
|
|
"description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"shipping_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order status. Payment providers will update this value after payment.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "checkout-order",
|
|
"type": "object"
|
|
},
|
|
"comment": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID of the user object, if author was a user.",
|
|
"type": "integer"
|
|
},
|
|
"author_avatar_urls": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URLs for the comment author.",
|
|
"properties": {
|
|
"24": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL with image size of 24 pixels.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"48": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL with image size of 48 pixels.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"96": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL with image size of 96 pixels.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"author_email": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Email address for the comment author.",
|
|
"format": "email",
|
|
"type": "string"
|
|
},
|
|
"author_ip": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "IP address for the comment author.",
|
|
"format": "ip",
|
|
"type": "string"
|
|
},
|
|
"author_name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Display name for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_url": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL for the comment author.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"author_user_agent": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "User agent for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The content for the comment.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the comment, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the comment, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the comment was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the comment was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the comment.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the comment.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 0,
|
|
"description": "The ID for the parent of the comment.",
|
|
"type": "integer"
|
|
},
|
|
"post": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 0,
|
|
"description": "The ID of the associated post object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State of the comment.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of the comment.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "comment",
|
|
"type": "object"
|
|
},
|
|
"customer": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"avatar_url": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"billing": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of billing address data.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 1",
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 2",
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company name.",
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code of the country.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Email address.",
|
|
"format": "email",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name.",
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone number.",
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postal code.",
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code or name of the county, state, province or district.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the customer was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the customer was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the customer was last modified, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the customer was last modified, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The email address for the customer.",
|
|
"format": "email",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"is_paying_customer": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Is the customer a paying customer?",
|
|
"readonly": true,
|
|
"type": "bool"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity of orders made by the customer.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer role.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of shipping address data.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 1",
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 2",
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company name.",
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code of the country.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name.",
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postal code.",
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code or name of the county, state, province or district.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"total_spent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total amount spent.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "customer",
|
|
"type": "object"
|
|
},
|
|
"customer_download": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"access_expires": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The date when download access expires, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"access_expires_gmt": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The date when download access expires, as GMT.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"download_id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Download ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"download_name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Downloadable file name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"download_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Download file URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"downloads_remaining": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Number of downloads remaining.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"file": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "File details.",
|
|
"properties": {
|
|
"file": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "File URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "File name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"order_id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Order ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_key": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Order key.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Downloadable product ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "customer_download",
|
|
"type": "object"
|
|
},
|
|
"data_continents": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "2 character continent code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"countries": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "List of countries on this continent.",
|
|
"items": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "ISO3166 alpha-2 country code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Default ISO4127 alpha-3 currency code for the country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_pos": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Currency symbol position for this country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"decimal_sep": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for displayed prices for this country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"dimension_unit": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The unit lengths are defined in for this country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Full name of country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"num_decimals": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Number of decimal points shown in displayed prices for this country.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"states": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "List of states in this country.",
|
|
"items": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "State code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Full name of state.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"thousand_sep": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Thousands separator for displayed prices in this country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"weight_unit": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The unit weights are defined in for this country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Full name of continent.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "data_continents",
|
|
"type": "object"
|
|
},
|
|
"data_countries": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "ISO3166 alpha-2 country code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Full name of country.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"states": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "List of states in this country.",
|
|
"items": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "State code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Full name of state.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "data_countries",
|
|
"type": "object"
|
|
},
|
|
"data_currencies": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "ISO4217 currency code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Full name of currency.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"symbol": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Currency symbol.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "data_currencies",
|
|
"type": "object"
|
|
},
|
|
"data_download_ips": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"user_ip_address": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "IP address.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "data_download_ips",
|
|
"type": "object"
|
|
},
|
|
"data_index": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Data resource description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Data resource ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "data_index",
|
|
"type": "object"
|
|
},
|
|
"font-collection": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"categories": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The categories for the font collection.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The description for the font collection.",
|
|
"type": "string"
|
|
},
|
|
"font_families": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The font families for the font collection.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The name for the font collection.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the font collection.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "font-collection",
|
|
"type": "object"
|
|
},
|
|
"leaderboard": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"headers": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Table headers.",
|
|
"items": {
|
|
"properties": {
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Table column header.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "array"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Leaderboard ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Displayed title for the leaderboard.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rows": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Table rows.",
|
|
"items": {
|
|
"properties": {
|
|
"display": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Table cell display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"format": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Table cell format.",
|
|
"enum": [
|
|
"currency",
|
|
"number"
|
|
],
|
|
"readonly": true,
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Table cell value.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "array"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "leaderboard",
|
|
"type": "object"
|
|
},
|
|
"marketing_campaign": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"channel": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The unique identifier for the marketing channel that this campaign belongs to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"cost": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Cost of the marketing campaign.",
|
|
"properties": {
|
|
"currency": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The unique identifier for the marketing campaign.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"manage_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "URL to the campaign management page.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sales": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Sales of the marketing campaign.",
|
|
"properties": {
|
|
"currency": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Title of the marketing campaign.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "marketing_campaign",
|
|
"type": "object"
|
|
},
|
|
"marketing_campaign_type": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"channel": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The marketing channel that this campaign type belongs to.",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The name of the marketing channel that this campaign type belongs to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The unique identifier of the marketing channel that this campaign type belongs to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"create_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "URL to the create campaign page for this campaign type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Description of the marketing campaign type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"icon_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "URL to an image/icon for the campaign type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The unique identifier for the marketing campaign type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Name of the marketing campaign type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "marketing_campaign_type",
|
|
"type": "object"
|
|
},
|
|
"marketing_channel": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Description of the marketing channel.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"errors_count": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Path to the channel icon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"is_setup_completed": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not the marketing channel is set up.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Name of the marketing channel.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_listings_status": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Status of the marketing channel's product listings.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"settings_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "marketing_channel",
|
|
"type": "object"
|
|
},
|
|
"marketing_recommendation": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"categories": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"direct_install": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"plugin": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subcategories": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"items": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"tags": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"items": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "marketing_recommendation",
|
|
"type": "object"
|
|
},
|
|
"menu-location": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The description of the menu location.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"menu": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID of the assigned menu.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The name of the menu location.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "menu-location",
|
|
"type": "object"
|
|
},
|
|
"nav_menu": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"auto_add": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether to automatically add top-level pages to this menu.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"locations": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The locations assigned to the menu.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "nav_menu",
|
|
"type": "object"
|
|
},
|
|
"nav_menu_item": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}",
|
|
"rel": "https:/api.w.org/action-publish",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"status": {
|
|
"enum": [
|
|
"future",
|
|
"publish"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can publish this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}",
|
|
"rel": "https:/api.w.org/action-assign-menus",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"menus": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can assign terms in the nav_menu taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}",
|
|
"rel": "https:/api.w.org/action-create-menus",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"menus": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can create terms in the nav_menu taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}",
|
|
"rel": "https:/api.w.org/menu-item-object",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"object": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "Get linked object."
|
|
}
|
|
],
|
|
"properties": {
|
|
"attr_title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Text for the title attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"classes": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Class names for the link element of this menu item.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The description of this menu item.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 0,
|
|
"description": "Unique identifier for the object.",
|
|
"minimum": 0,
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"invalid": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the menu item represents an object that no longer exists .",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
"menus": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The terms assigned to the object in the nav_menu taxonomy.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"object": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
|
|
"type": "string"
|
|
},
|
|
"object_id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 0,
|
|
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 0,
|
|
"description": "The ID for the parent of the object.",
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "publish",
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The target attribute of the link element for this menu item.",
|
|
"enum": [
|
|
"",
|
|
"_blank"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the object.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "custom",
|
|
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
|
|
"enum": [
|
|
"custom",
|
|
"post_type",
|
|
"post_type_archive",
|
|
"taxonomy"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type_label": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The singular label used to describe this type of menu item.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The URL to which this menu item points.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"xfn": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The XFN relationship expressed in the link of this menu item.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "nav_menu_item",
|
|
"type": "object"
|
|
},
|
|
"nav_menu_item-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the revision, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the revision.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"preview_link": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Preview link for the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the revision unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the object.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"title": "nav_menu_item-revision",
|
|
"type": "object"
|
|
},
|
|
"navigation-fallback": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The unique identifier for the Navigation Menu.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "navigation-fallback",
|
|
"type": "object"
|
|
},
|
|
"note": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"actions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An array of actions, if any, for the note.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Content of the note.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"content_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Content data for the note. JSON string. Available for re-localisation.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date the note was created.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date the note was created (GMT).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_reminder": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date after which the user should be reminded of the note, if any.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_reminder_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date after which the user should be reminded of the note, if any (GMT).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "ID of the note record.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The image of the note, if any.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"is_deleted": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Registers whether the note is deleted or not",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_read": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Registers whether the note is read or not",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_snoozable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not a user can request to be reminded about the note.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"layout": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The layout of the note (eg banner, thumbnail, plain).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Locale used for the note title and content.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the note.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Source of the note.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The status of the note (e.g. unactioned, actioned).",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Title of the note.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The type of the note (eg error, warning, etc).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "note",
|
|
"type": "object"
|
|
},
|
|
"onboarding_profile": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"business_extensions": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Extra business extensions to install.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"completed": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not the profile was completed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"industry": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Industry.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"is_agree_marketing": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_plugins_page_skipped": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not plugins step in core profiler was skipped.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_store_country_set": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not this store country is set via onboarding profiler.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"number_employees": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Number of employees of the store.",
|
|
"enum": [
|
|
"+250",
|
|
"<10",
|
|
"1",
|
|
"10-50",
|
|
"50-250",
|
|
"not specified"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"other_platform": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Name of other platform used to sell.",
|
|
"enum": [
|
|
"amazon",
|
|
"bigcommerce",
|
|
"ebay",
|
|
"etsy",
|
|
"magento",
|
|
"other",
|
|
"shopify",
|
|
"squarespace",
|
|
"wix"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"other_platform_name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Name of other platform used to sell (not listed).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_count": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Number of products to be added.",
|
|
"enum": [
|
|
"0",
|
|
"1-10",
|
|
"1000+",
|
|
"101-1000",
|
|
"11-100"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_types": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Types of products sold.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"revenue": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Current annual revenue of the store.",
|
|
"enum": [
|
|
"10000-50000",
|
|
"2500-10000",
|
|
"50000-250000",
|
|
"more-than-250000",
|
|
"none",
|
|
"rather-not-say",
|
|
"up-to-2500"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"selling_venues": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Other places the store is selling products.",
|
|
"enum": [
|
|
"brick-mortar",
|
|
"brick-mortar-other",
|
|
"no",
|
|
"other",
|
|
"other-woocommerce"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"setup_client": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not this store was setup for a client.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"skipped": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not the profile was skipped.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"store_email": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Store email address.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Selected store theme.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"wccom_connected": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether or not the store was connected to WooCommerce.com during the extension flow.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"title": "onboarding_profile",
|
|
"type": "object"
|
|
},
|
|
"onboarding_theme": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Theme name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Theme slug.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Theme status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "onboarding_theme",
|
|
"type": "object"
|
|
},
|
|
"options": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"options": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Array of options with associated values.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "options",
|
|
"type": "object"
|
|
},
|
|
"order": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"billing_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current set billing address for the customer.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Email",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of applied basket coupons.",
|
|
"items": {
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The coupon's unique code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The discount type for the coupon (eg percentage or fixed amount)",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount applied by this coupon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax removed due to discount applied by this coupon.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"errors": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of basket item errors, for example, items in the basket which are out of stock.",
|
|
"items": {
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Error code",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Error message",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The order ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line items data.",
|
|
"items": {
|
|
"properties": {
|
|
"backorders_allowed": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if backorders are allowed past stock availability.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean"
|
|
]
|
|
},
|
|
"catalog_visibility": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether the product is visible in the catalogue",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product full description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"properties": [],
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The item product or variation ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"images": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of images.",
|
|
"items": {
|
|
"properties": {
|
|
"alt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image alternative text.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sizes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail sizes for responsive images.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Full size image URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"srcset": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail srcset for responsive images.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"thumbnail": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"item_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Metadata related to the item",
|
|
"items": {
|
|
"properties": {
|
|
"display": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Optionally, how the metadata value should be displayed to the user.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name of the metadata.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Value of the metadata.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the item.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"low_stock_remaining": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity left in stock if stock is low, or null if not applicable.",
|
|
"readonly": true,
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price data for the product in the current line item, including or excluding taxes based on the \"display prices during basket and checkout\" setting. Provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price_range": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price range, if applicable.",
|
|
"properties": {
|
|
"max_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"min_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price amount.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"raw_prices": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.",
|
|
"properties": {
|
|
"precision": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal precision of the returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regular product price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sale product price, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity of this item.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"quantity_limits": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "How the quantity of this item should be controlled, for example, any limits in place.",
|
|
"properties": {
|
|
"editable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": true,
|
|
"description": "If the quantity is editable or fixed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"maximum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The maximum quantity allowed for this line item.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"minimum": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The minimum quantity allowed for this line item.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"multiple_of": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "The amount that quantities increment by. Quantity must be an multiple of this value.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"short_description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product short description in HTML format.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"show_backorder_badge": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the product is on backorder.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean"
|
|
]
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Stock keeping unit, if applicable.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If true, only one item of this product is allowed for purchase in a single order.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item total amounts provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal (the price of the product before coupon discounts have been applied).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_subtotal_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (the price of the product after coupon discounts have been applied).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"line_total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The item type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variation": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Chosen attributes (for variations).",
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation attribute name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation attribute value.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"needs_payment": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"needs_shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"payment_requirements": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of required payment gateway features to process the order.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"shipping_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current set shipping address for the customer.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Flat, suite, etc.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region code in ISO 3166-1 alpha-2 format.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State/County code, or name of the state, county, province, or district.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Status of the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order totals.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Subtotal of the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Lines of taxes applied to items and shipping.",
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The name of the tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The amount of tax charged.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rate": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The rate at which tax is applied.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total_discount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount from applied coupons.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax removed due to discount from applied coupons.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_fees": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price of any applied fees.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_fees_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax on fees.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price of items in the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_items_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax on items in the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price the customer will pay.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_refund": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total refund applied to the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total price of shipping.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"total_shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax applied to the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "order",
|
|
"type": "object"
|
|
},
|
|
"order_note": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"customer_note": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.",
|
|
"type": "boolean"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order note was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order note was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"note": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order note content.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "order_note",
|
|
"type": "object"
|
|
},
|
|
"page": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}",
|
|
"rel": "https:/api.w.org/action-publish",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"status": {
|
|
"enum": [
|
|
"future",
|
|
"publish"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can publish this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}",
|
|
"rel": "https:/api.w.org/action-assign-author",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"author": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can change the author on this post."
|
|
}
|
|
],
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"class_list": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An array of the class names for the post container element.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not comments are open on the post.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"generated_slug": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Slug automatically generated from the post title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The order of the post in relation to other posts.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"footnotes": {
|
|
"default": "",
|
|
"description": "",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"permalink_template": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Permalink template for the post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not the post can be pinged.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "page",
|
|
"type": "object"
|
|
},
|
|
"page-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the revision.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"footnotes": {
|
|
"default": "",
|
|
"description": "",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"preview_link": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Preview link for the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the revision unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "page-revision",
|
|
"type": "object"
|
|
},
|
|
"pattern-directory-item": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"block_types": {
|
|
"context": [
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The block types which can use this pattern.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"uniqueItems": true
|
|
},
|
|
"categories": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern's category slugs.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"uniqueItems": true
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern content.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "A description of the pattern.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern ID.",
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
"keywords": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern's keywords.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array",
|
|
"uniqueItems": true
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The pattern title, in human readable format.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"viewport_width": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The preferred width of the viewport when previewing a pattern, in pixels.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "pattern-directory-item",
|
|
"type": "object"
|
|
},
|
|
"patterns": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": [],
|
|
"title": "patterns",
|
|
"type": "object"
|
|
},
|
|
"payment-gateway-suggestions": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Suggestion description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Suggestion ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Gateway image.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"is_visible": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Suggestion visibility.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"plugins": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Array of plugin slugs.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"recommendation_priority": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Priority of recommendation.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Gateway title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"transaction_processors": {
|
|
"addtionalProperties": {
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Array of transaction processors and their images.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "payment-gateway-suggestions",
|
|
"type": "object"
|
|
},
|
|
"payment_gateway": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"method_description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway method description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"method_title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway method title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway settings.",
|
|
"properties": {
|
|
"default": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Default value for the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human readable description for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A unique identifier for the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human readable label for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"placeholder": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Placeholder text to be displayed in text inputs.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tip": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Additional help text shown to the user about the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of setting.",
|
|
"enum": [
|
|
"checkbox",
|
|
"color",
|
|
"email",
|
|
"image_width",
|
|
"multiselect",
|
|
"number",
|
|
"password",
|
|
"radio",
|
|
"select",
|
|
"text",
|
|
"textarea"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Setting value.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "payment_gateway",
|
|
"type": "object"
|
|
},
|
|
"plugin": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The plugin author.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"author_uri": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The plugin author's website address.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The plugin description.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The raw plugin description.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"description": "The plugin description formatted for display.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The plugin name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"network_only": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the plugin can only be activated network wide.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"plugin": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The plugin file.",
|
|
"pattern": "[^.\\/]+(?:\\/[^.\\/]+)?",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"plugin_uri": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The plugin's website address.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"requires_php": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Minimum required version of PHP.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"requires_wp": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Minimum required version of WordPress.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The plugin activation status.",
|
|
"enum": [
|
|
"active",
|
|
"inactive"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"textdomain": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The plugin's text domain.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The plugin version number.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "plugin",
|
|
"type": "object"
|
|
},
|
|
"plugins": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"connectAction": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Action that should be completed to connect Jetpack.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Plugin name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Plugin slug.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "plugins",
|
|
"type": "object"
|
|
},
|
|
"post": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-publish",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"status": {
|
|
"enum": [
|
|
"future",
|
|
"publish"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can publish this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-sticky",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"sticky": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can sticky this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-assign-author",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"author": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can change the author on this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-assign-categories",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"categories": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can assign terms in the category taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-create-categories",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"categories": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can create terms in the category taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-assign-tags",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"tags": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can assign terms in the post_tag taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}",
|
|
"rel": "https:/api.w.org/action-create-tags",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"tags": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can create terms in the post_tag taxonomy."
|
|
}
|
|
],
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"categories": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The terms assigned to the object in the category taxonomy.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"class_list": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An array of the class names for the post container element.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not comments are open on the post.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The format for the post.",
|
|
"enum": [
|
|
"aside",
|
|
"audio",
|
|
"chat",
|
|
"gallery",
|
|
"image",
|
|
"link",
|
|
"quote",
|
|
"standard",
|
|
"status",
|
|
"video"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"generated_slug": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Slug automatically generated from the post title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"footnotes": {
|
|
"default": "",
|
|
"description": "",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"permalink_template": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Permalink template for the post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not the post can be pinged.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"sticky": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not the post should be treated as sticky.",
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The terms assigned to the object in the post_tag taxonomy.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "post",
|
|
"type": "object"
|
|
},
|
|
"post-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the revision.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"footnotes": {
|
|
"default": "",
|
|
"description": "",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"preview_link": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Preview link for the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the revision unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "post-revision",
|
|
"type": "object"
|
|
},
|
|
"product": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}",
|
|
"rel": "https:/api.w.org/action-publish",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"status": {
|
|
"enum": [
|
|
"future",
|
|
"publish"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can publish this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}",
|
|
"rel": "https:/api.w.org/action-assign-product_cat",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"product_cat": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can assign terms in the product_cat taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}",
|
|
"rel": "https:/api.w.org/action-create-product_cat",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"product_cat": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can create terms in the product_cat taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}",
|
|
"rel": "https:/api.w.org/action-assign-product_tag",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"product_tag": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can assign terms in the product_tag taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}",
|
|
"rel": "https:/api.w.org/action-create-product_tag",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"product_tag": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can create terms in the product_tag taxonomy."
|
|
}
|
|
],
|
|
"properties": {
|
|
"class_list": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An array of the class names for the post container element.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"generated_slug": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Slug automatically generated from the post title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"permalink_template": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Permalink template for the post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_cat": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The terms assigned to the object in the product_cat taxonomy.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"product_tag": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The terms assigned to the object in the product_tag taxonomy.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product",
|
|
"type": "object"
|
|
},
|
|
"product-category": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of objects (posts of any type) assigned to the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Term description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Category image.",
|
|
"properties": {
|
|
"alt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image alternative text.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image name.",
|
|
"type": "string"
|
|
},
|
|
"sizes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail sizes for responsive images.",
|
|
"type": "string"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Full size image URL.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"srcset": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail srcset for responsive images.",
|
|
"type": "string"
|
|
},
|
|
"thumbnail": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thumbnail URL.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Term name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Parent term ID, if applicable.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Category URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"review_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of reviews for products in this category.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "String based identifier for the term.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product-category",
|
|
"type": "object"
|
|
},
|
|
"product-collection-data": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"attribute_counts": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Returns number of products within attribute terms.",
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of products.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"term": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Term ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
},
|
|
"price_range": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Min and max prices found in collection of products, provided using the smallest unit of the currency.",
|
|
"properties": {
|
|
"currency_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency code (in ISO format) for returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_decimal_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Decimal separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_minor_unit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency minor unit (number of digits after the decimal separator) for returned prices.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"currency_prefix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_suffix": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Price prefix for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Currency symbol for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_thousand_separator": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Thousand separator for the currency which can be used to format returned prices.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"max_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Maximum price found in collection of products.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"min_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Minimum price found in collection of products.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"object"
|
|
]
|
|
},
|
|
"rating_counts": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Returns number of products with each average rating.",
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of products.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"rating": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Average rating",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
},
|
|
"stock_status_counts": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Returns number of products with each stock status.",
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of products.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Status",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": [
|
|
"array",
|
|
"null"
|
|
]
|
|
}
|
|
},
|
|
"title": "product-collection-data",
|
|
"type": "object"
|
|
},
|
|
"product-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the revision.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"preview_link": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Preview link for the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the revision unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "product-revision",
|
|
"type": "object"
|
|
},
|
|
"product_attribute": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"has_archives": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "menu_order",
|
|
"description": "Default sort order.",
|
|
"enum": [
|
|
"id",
|
|
"menu_order",
|
|
"name",
|
|
"name_num"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "select",
|
|
"description": "Type of attribute.",
|
|
"enum": [
|
|
"select"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product_attribute",
|
|
"type": "object"
|
|
},
|
|
"product_attribute_term": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published products for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"menu_order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product_attribute_term",
|
|
"type": "object"
|
|
},
|
|
"product_cat": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published posts for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL of the term.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type attribution for the term.",
|
|
"enum": [
|
|
"product_cat"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product_cat",
|
|
"type": "object"
|
|
},
|
|
"product_review": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": "date-time"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"verified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shows if the reviewer bought the product or not.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"title": "product_review",
|
|
"type": "object"
|
|
},
|
|
"product_shipping_class": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published products for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product_shipping_class",
|
|
"type": "object"
|
|
},
|
|
"product_tag": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published posts for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL of the term.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type attribution for the term.",
|
|
"enum": [
|
|
"product_tag"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product_tag",
|
|
"type": "object"
|
|
},
|
|
"product_variation": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"attributes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of attributes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Attribute ID.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"option": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Selected attribute term name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"backordered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shows if the variation is on back-order.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"backorders": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "no",
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"enum": [
|
|
"no",
|
|
"notify",
|
|
"yes"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"backorders_allowed": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shows if back-orders are allowed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the variation was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the variation was last modified, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_on_sale_from": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": "date-time"
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": "date-time"
|
|
},
|
|
"date_on_sale_to": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": "date-time"
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": "date-time"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation dimensions.",
|
|
"properties": {
|
|
"height": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation height (cm).",
|
|
"type": "string"
|
|
},
|
|
"length": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation length (cm).",
|
|
"type": "string"
|
|
},
|
|
"width": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation width (cm).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": -1,
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": -1,
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of downloadable files.",
|
|
"items": {
|
|
"properties": {
|
|
"file": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "File URL.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "File ID.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "File name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation image data.",
|
|
"properties": {
|
|
"alt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image alternative text.",
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the image was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the image was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the image was last modified, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the image was last modified, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image name.",
|
|
"type": "string"
|
|
},
|
|
"position": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image position. 0 means that the image is featured.",
|
|
"type": "integer"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image URL.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": true,
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "Stock management at variation level.",
|
|
"type": "mixed"
|
|
},
|
|
"menu_order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"on_sale": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shows if the variation is on sale.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Current variation price.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"purchasable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shows if the variation can be bought.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"regular_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping class ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "taxable",
|
|
"description": "Tax status.",
|
|
"enum": [
|
|
"none",
|
|
"shipping",
|
|
"taxable"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": true,
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "product_variation",
|
|
"type": "object"
|
|
},
|
|
"rendered-block": {
|
|
"$schema": "http:/json-schema.org/schema#",
|
|
"properties": {
|
|
"rendered": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "The rendered block.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "rendered-block",
|
|
"type": "object"
|
|
},
|
|
"report": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "A human-readable description of the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report",
|
|
"type": "object"
|
|
},
|
|
"report_categories": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"category_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Category ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"extended_info": {
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Category name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total sales.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"products_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of products.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "report_categories",
|
|
"type": "object"
|
|
},
|
|
"report_coupon_total": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Coupon type name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Amount of coupons.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_coupon_total",
|
|
"type": "object"
|
|
},
|
|
"report_coupons": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net discount amount.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupon_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"extended_info": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon creation date.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon creation date in GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_expires": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon expiration date.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_expires_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon expiration date in GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"discount_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon discount type.",
|
|
"enum": [
|
|
"fixed_cart",
|
|
"fixed_product",
|
|
"percent"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "report_coupons",
|
|
"type": "object"
|
|
},
|
|
"report_coupons_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"intervals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by intervals.",
|
|
"items": {
|
|
"properties": {
|
|
"date_end": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_end_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"interval": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of interval.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net discount amount.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of coupons.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of discounted orders.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Discounted orders",
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net discount amount.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of coupons.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of discounted orders.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Discounted orders",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net discount amount.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of coupons.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of discounted orders.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Discounted orders",
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net discount amount.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of coupons.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of discounted orders.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Discounted orders",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_coupons_stats",
|
|
"type": "object"
|
|
},
|
|
"report_customer_total": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Customer type name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Amount of customers.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_customer_total",
|
|
"type": "object"
|
|
},
|
|
"report_customers": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"avg_order_value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Average order value",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_last_active": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date last active.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_last_active_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date last active GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_registered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date registered.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_registered_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date registered GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order count.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postal code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Region.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_spend": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total spend.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"user_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "User ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"username": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Username.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_customers",
|
|
"type": "object"
|
|
},
|
|
"report_customers_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"avg_avg_order_value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Average AOV per customer.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"avg_orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Average number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"avg_total_spend": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Average total spend per customer.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"customers_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of customers.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_customers_stats",
|
|
"type": "object"
|
|
},
|
|
"report_downloads": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date of the download, in the site's time zone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date of the download, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"download_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Download ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"file_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "File name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"file_path": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "File URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"ip_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "IP address for the downloader.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_number": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order Number.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"user_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "User ID for the downloader.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"username": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "User name of the downloader.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_downloads",
|
|
"type": "object"
|
|
},
|
|
"report_export": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"export_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Export ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Export status message.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Export status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_export",
|
|
"type": "object"
|
|
},
|
|
"report_export_status": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"download_url": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Export download URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"percent_complete": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Percentage complete.",
|
|
"readonly": true,
|
|
"type": "int"
|
|
}
|
|
},
|
|
"title": "report_export_status",
|
|
"type": "object"
|
|
},
|
|
"report_import": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"message": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regenerate data message.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Regeneration status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_import",
|
|
"type": "object"
|
|
},
|
|
"report_order_total": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Order status name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Amount of orders.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_order_total",
|
|
"type": "object"
|
|
},
|
|
"report_orders": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"customer_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"customer_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Returning or new customer.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date the order was created, in the site's time zone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Date the order was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"extended_info": {
|
|
"attribution": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order attribution information.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of order coupons.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"customer": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order customer information.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"products": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of order product IDs, names, quantities.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"net_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net total revenue.",
|
|
"readonly": true,
|
|
"type": "float"
|
|
},
|
|
"num_items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_number": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order Number.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_formatted": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net total revenue (formatted).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_orders",
|
|
"type": "object"
|
|
},
|
|
"report_orders_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"intervals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by intervals.",
|
|
"items": {
|
|
"properties": {
|
|
"date_end": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, in the site's time zone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_end_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_start": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, in the site's time zone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_start_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"interval": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of interval.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"download_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of downloads.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Downloads",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"download_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of downloads.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Downloads",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_orders_stats",
|
|
"type": "object"
|
|
},
|
|
"report_performance_indicator": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"chart": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The specific chart this stat referrers to.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Human readable label for the stat.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"stat": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"enum": [
|
|
"coupons/amount",
|
|
"coupons/orders_count",
|
|
"downloads/download_count",
|
|
"orders/avg_order_value",
|
|
"orders/orders_count",
|
|
"products/items_sold",
|
|
"revenue/gross_sales",
|
|
"revenue/net_revenue",
|
|
"revenue/refunds",
|
|
"revenue/shipping",
|
|
"revenue/total_sales",
|
|
"taxes/order_tax",
|
|
"taxes/shipping_tax",
|
|
"taxes/total_tax",
|
|
"variations/items_sold"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_performance_indicator",
|
|
"type": "object"
|
|
},
|
|
"report_product_total": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Product type name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Amount of products.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_product_total",
|
|
"type": "object"
|
|
},
|
|
"report_products": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"extended_info": {
|
|
"category_ids": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product category IDs.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product image.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"low_stock_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product inventory threshold for low stock.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product link.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product price.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product SKU.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product inventory quantity.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product inventory status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variations": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product variations IDs.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total Net sales of all items sold.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders product appeared in.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "report_products",
|
|
"type": "object"
|
|
},
|
|
"report_products_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"intervals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by intervals.",
|
|
"items": {
|
|
"properties": {
|
|
"date_end": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_end_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"interval": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of interval.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of product items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Products sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segment_label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Human readable segment label, either product or variation name.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of product items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Products sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of product items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Products sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segment_label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Human readable segment label, either product or variation name.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of product items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Products sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_products_stats",
|
|
"type": "object"
|
|
},
|
|
"report_revenue_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"intervals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by intervals.",
|
|
"items": {
|
|
"properties": {
|
|
"date_end": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_end_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"interval": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of interval.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount discounted by coupons.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique coupons count.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"gross_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Gross sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"num_items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"refunds": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of returns.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Returns",
|
|
"type": "number"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount discounted by coupons.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique coupons count.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"gross_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Gross sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"num_items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"refunds": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of returns.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Returns",
|
|
"type": "number"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of shipping.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Shipping",
|
|
"type": "number"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of taxes.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"total_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of shipping.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Shipping",
|
|
"type": "number"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of taxes.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"total_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount discounted by coupons.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique coupons count.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"gross_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Gross sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"num_items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"products": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Products sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"refunds": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of returns.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Returns",
|
|
"type": "number"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"coupons": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount discounted by coupons.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"coupons_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique coupons count.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"gross_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Gross sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"num_items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"refunds": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of returns.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Returns",
|
|
"type": "number"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of shipping.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Shipping",
|
|
"type": "number"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of taxes.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"total_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of shipping.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Shipping",
|
|
"type": "number"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total of taxes.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"total_sales": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total sales.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_revenue_stats",
|
|
"type": "object"
|
|
},
|
|
"report_review_total": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Review type name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Amount of reviews.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_review_total",
|
|
"type": "object"
|
|
},
|
|
"report_stock": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"manage_stock": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Manage stock.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product parent ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Stock quantity.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Stock status.",
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "report_stock",
|
|
"type": "object"
|
|
},
|
|
"report_taxes": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country/Region.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order tax.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"priority": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Priority.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_rate": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"tax_rate_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"title": "report_taxes",
|
|
"type": "object"
|
|
},
|
|
"report_taxes_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"intervals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by intervals.",
|
|
"items": {
|
|
"properties": {
|
|
"date_end": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_end_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"interval": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of interval.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"order_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"order_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"tax_codes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of tax codes.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"tax_codes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of tax codes.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"order_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"order_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"tax_codes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of tax codes.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"tax_codes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Amount of tax codes.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total tax.",
|
|
"format": "currency",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_taxes_stats",
|
|
"type": "object"
|
|
},
|
|
"report_variations_stats": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"intervals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by intervals.",
|
|
"items": {
|
|
"properties": {
|
|
"date_end": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_end_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report end, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_start_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the report start, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"interval": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of interval.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of variation items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Variations Sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segment_label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Human readable segment label, either product or variation name.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of variation items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Variations Sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Totals data.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of variation items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Variations Sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segments": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reports data grouped by segment condition.",
|
|
"items": {
|
|
"properties": {
|
|
"segment_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Segment identificator.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"segment_label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Human readable segment label, either product or variation name.",
|
|
"enum": [
|
|
"day",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotals": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Interval subtotals.",
|
|
"properties": {
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of variation items sold.",
|
|
"indicator": true,
|
|
"readonly": true,
|
|
"title": "Variations Sold",
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Net sales.",
|
|
"format": "currency",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "report_variations_stats",
|
|
"type": "object"
|
|
},
|
|
"report_varitations": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"extended_info": {
|
|
"attributes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product attributes.",
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product image.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"low_stock_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product inventory threshold for low stock.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"permalink": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product link.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product price.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"stock_quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product inventory quantity.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product inventory status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"items_sold": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of items sold.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"net_revenue": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total Net sales of all items sold.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"orders_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of orders product appeared in.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"variation_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "report_varitations",
|
|
"type": "object"
|
|
},
|
|
"sales_report": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"average_sales": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Average net daily sales.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"net_sales": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Net sales in the period.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_discount": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total of coupons used.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_items": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total of items purchased.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_orders": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total of orders placed.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_refunds": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total of refunded orders.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total_sales": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Gross sales in the period.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_shipping": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total charged for shipping.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total charged for taxes.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"totals": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Totals.",
|
|
"items": {
|
|
"type": "array"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"totals_grouped_by": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Group type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "sales_report",
|
|
"type": "object"
|
|
},
|
|
"search-result": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the object.",
|
|
"readonly": true,
|
|
"type": [
|
|
"integer",
|
|
"string"
|
|
]
|
|
},
|
|
"subtype": {
|
|
"context": [
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Object subtype.",
|
|
"enum": [
|
|
"category",
|
|
"page",
|
|
"post",
|
|
"post_tag",
|
|
"product",
|
|
"product_cat",
|
|
"product_tag"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the object.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Object type.",
|
|
"enum": [
|
|
"post",
|
|
"post-format",
|
|
"term"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"context": [
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the object.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "search-result",
|
|
"type": "object"
|
|
},
|
|
"setting": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"default": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Default value for the setting.",
|
|
"readonly": true,
|
|
"type": "mixed"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human readable description for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A unique identifier for the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human readable label for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"placeholder": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Placeholder text to be displayed in text inputs.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tip": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Additional help text shown to the user about the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of setting.",
|
|
"enum": [
|
|
"checkbox",
|
|
"color",
|
|
"email",
|
|
"image_width",
|
|
"multiselect",
|
|
"number",
|
|
"password",
|
|
"radio",
|
|
"select",
|
|
"text",
|
|
"textarea",
|
|
"thumbnail_cropping"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Setting value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"title": "setting",
|
|
"type": "object"
|
|
},
|
|
"setting_group": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "A human readable description for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "A unique identifier that can be used to link settings together.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "A human readable label for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "ID of parent grouping.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sub_groups": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "IDs for settings sub groups.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "setting_group",
|
|
"type": "object"
|
|
},
|
|
"settings": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"date_format": {
|
|
"default": null,
|
|
"description": "A date format for all date strings.",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"default_category": {
|
|
"default": null,
|
|
"description": "Default post category.",
|
|
"title": "",
|
|
"type": "integer"
|
|
},
|
|
"default_comment_status": {
|
|
"default": null,
|
|
"description": "Allow people to submit comments on new posts.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"title": "Allow comments on new posts",
|
|
"type": "string"
|
|
},
|
|
"default_ping_status": {
|
|
"default": null,
|
|
"description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.",
|
|
"enum": [
|
|
"closed",
|
|
"open"
|
|
],
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"default_post_format": {
|
|
"default": null,
|
|
"description": "Default post format.",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"default": null,
|
|
"description": "Site tagline.",
|
|
"title": "Tagline",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"default": null,
|
|
"description": "This address is used for admin purposes, like new user notification.",
|
|
"format": "email",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"default": "en_US",
|
|
"description": "WordPress locale code.",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"page_for_posts": {
|
|
"default": null,
|
|
"description": "The ID of the page that should display the latest posts",
|
|
"title": "",
|
|
"type": "integer"
|
|
},
|
|
"page_on_front": {
|
|
"default": null,
|
|
"description": "The ID of the page that should be displayed on the front page",
|
|
"title": "Page on front",
|
|
"type": "integer"
|
|
},
|
|
"pickup_location_settings": {
|
|
"additionalProperties": false,
|
|
"default": [],
|
|
"description": "WooCommerce Local Pickup Method Settings",
|
|
"properties": {
|
|
"cost": {
|
|
"description": "Optional cost to charge for local pickup.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "If enabled, this method will appear on the block based checkout.",
|
|
"enum": [
|
|
"no",
|
|
"yes"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "If a cost is defined, this controls if taxes are applied to that cost.",
|
|
"enum": [
|
|
"none",
|
|
"taxable"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "This controls the title which the user sees during checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "",
|
|
"type": "object"
|
|
},
|
|
"pickup_locations": {
|
|
"default": [],
|
|
"description": "WooCommerce Local Pickup Locations",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"address": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"address_1": {
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"details": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "",
|
|
"type": "array"
|
|
},
|
|
"posts_per_page": {
|
|
"default": 10,
|
|
"description": "Blog pages show at most.",
|
|
"title": "Maximum posts per page",
|
|
"type": "integer"
|
|
},
|
|
"show_on_front": {
|
|
"default": null,
|
|
"description": "What to show on the front page",
|
|
"title": "Show on front",
|
|
"type": "string"
|
|
},
|
|
"site_icon": {
|
|
"default": null,
|
|
"description": "Site icon.",
|
|
"title": "Icon",
|
|
"type": "integer"
|
|
},
|
|
"site_logo": {
|
|
"default": null,
|
|
"description": "Site logo.",
|
|
"title": "Logo",
|
|
"type": "integer"
|
|
},
|
|
"start_of_week": {
|
|
"default": null,
|
|
"description": "A day number of the week that the week should start on.",
|
|
"title": "",
|
|
"type": "integer"
|
|
},
|
|
"time_format": {
|
|
"default": null,
|
|
"description": "A time format for all time strings.",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"default": null,
|
|
"description": "A city in the same timezone as you.",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"default": null,
|
|
"description": "Site title.",
|
|
"title": "Title",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"default": null,
|
|
"description": "Site URL.",
|
|
"format": "uri",
|
|
"title": "",
|
|
"type": "string"
|
|
},
|
|
"use_smilies": {
|
|
"default": true,
|
|
"description": "Convert emoticons like :-) and :-P to graphics on display.",
|
|
"title": "",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"title": "settings",
|
|
"type": "object"
|
|
},
|
|
"shipping-partner-suggestions": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"items": [
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"required": "layout_row"
|
|
},
|
|
{
|
|
"required": "layout_column"
|
|
}
|
|
],
|
|
"properties": {
|
|
"available_layouts": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Available layouts -- single, dual, or both",
|
|
"items": {
|
|
"enum": [
|
|
"column",
|
|
"row"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Description",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"is_visible": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Suggestion visibility.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"layout_column": {
|
|
"properties": {
|
|
"features": {
|
|
"items": {
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"layout_row": {
|
|
"properties": {
|
|
"features": {
|
|
"items": {
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"learn_more_link": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Learn more link .",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Plugin name.",
|
|
"readonly": true,
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"available_layouts",
|
|
"is_visible",
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
],
|
|
"title": "shipping-partner-suggestions",
|
|
"type": "array"
|
|
},
|
|
"shipping_method": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"description": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Shipping method description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Method ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Shipping method title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "shipping_method",
|
|
"type": "object"
|
|
},
|
|
"shipping_zone": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "shipping_zone",
|
|
"type": "object"
|
|
},
|
|
"shipping_zone_location": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "country",
|
|
"description": "Shipping zone location type.",
|
|
"enum": [
|
|
"continent",
|
|
"country",
|
|
"postcode",
|
|
"state"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "shipping_zone_location",
|
|
"type": "object"
|
|
},
|
|
"shipping_zone_method": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"enabled": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method instance ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"instance_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method instance ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"method_description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"method_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method ID.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"method_title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method settings.",
|
|
"properties": {
|
|
"default": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Default value for the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human readable description for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A unique identifier for the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human readable label for the setting used in interfaces.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"placeholder": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Placeholder text to be displayed in text inputs.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tip": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Additional help text shown to the user about the setting.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Type of setting.",
|
|
"enum": [
|
|
"checkbox",
|
|
"color",
|
|
"email",
|
|
"image_width",
|
|
"multiselect",
|
|
"number",
|
|
"password",
|
|
"radio",
|
|
"select",
|
|
"text",
|
|
"textarea"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Setting value.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method customer facing title.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "shipping_zone_method",
|
|
"type": "object"
|
|
},
|
|
"shop_coupon": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the coupon was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the coupon was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_expires": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": "date-time"
|
|
},
|
|
"date_expires_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": "date-time"
|
|
},
|
|
"date_modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the coupon was last modified, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the coupon was last modified, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "fixed_cart",
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"enum": [
|
|
"fixed_cart",
|
|
"fixed_product",
|
|
"percent"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the object.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"individual_use": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of times the coupon has been used already.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"usage_limit": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
},
|
|
"used_by": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of user IDs (or guest email addresses) that have used the coupon.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "shop_coupon",
|
|
"type": "object"
|
|
},
|
|
"shop_order": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"billing": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Billing address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 1",
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 2",
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company name.",
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country code in ISO 3166-1 alpha-2 format.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Email address.",
|
|
"format": "email",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name.",
|
|
"type": "string"
|
|
},
|
|
"phone": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Phone number.",
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postal code.",
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code or name of the county, state, province or district.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"cart_hash": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "MD5 hash of basket items to ensure orders are not modified.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"cart_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sum of line item taxes only.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"coupon_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupons line data.",
|
|
"items": {
|
|
"properties": {
|
|
"code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Coupon code.",
|
|
"type": "mixed"
|
|
},
|
|
"discount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Discount total.",
|
|
"type": "string"
|
|
},
|
|
"discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Discount total tax.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Discount type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"free_shipping": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Whether the coupon grants free shipping or not.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nominal_amount": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).",
|
|
"readonly": true,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"created_via": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shows where the order was created.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "EUR",
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"enum": [
|
|
"AED",
|
|
"AFN",
|
|
"ALL",
|
|
"AMD",
|
|
"ANG",
|
|
"AOA",
|
|
"ARS",
|
|
"AUD",
|
|
"AWG",
|
|
"AZN",
|
|
"BAM",
|
|
"BBD",
|
|
"BDT",
|
|
"BGN",
|
|
"BHD",
|
|
"BIF",
|
|
"BMD",
|
|
"BND",
|
|
"BOB",
|
|
"BRL",
|
|
"BSD",
|
|
"BTC",
|
|
"BTN",
|
|
"BWP",
|
|
"BYN",
|
|
"BYR",
|
|
"BZD",
|
|
"CAD",
|
|
"CDF",
|
|
"CHF",
|
|
"CLP",
|
|
"CNY",
|
|
"COP",
|
|
"CRC",
|
|
"CUC",
|
|
"CUP",
|
|
"CVE",
|
|
"CZK",
|
|
"DJF",
|
|
"DKK",
|
|
"DOP",
|
|
"DZD",
|
|
"EGP",
|
|
"ERN",
|
|
"ETB",
|
|
"EUR",
|
|
"FJD",
|
|
"FKP",
|
|
"GBP",
|
|
"GEL",
|
|
"GGP",
|
|
"GHS",
|
|
"GIP",
|
|
"GMD",
|
|
"GNF",
|
|
"GTQ",
|
|
"GYD",
|
|
"HKD",
|
|
"HNL",
|
|
"HRK",
|
|
"HTG",
|
|
"HUF",
|
|
"IDR",
|
|
"ILS",
|
|
"IMP",
|
|
"INR",
|
|
"IQD",
|
|
"IRR",
|
|
"IRT",
|
|
"ISK",
|
|
"JEP",
|
|
"JMD",
|
|
"JOD",
|
|
"JPY",
|
|
"KES",
|
|
"KGS",
|
|
"KHR",
|
|
"KMF",
|
|
"KPW",
|
|
"KRW",
|
|
"KWD",
|
|
"KYD",
|
|
"KZT",
|
|
"LAK",
|
|
"LBP",
|
|
"LKR",
|
|
"LRD",
|
|
"LSL",
|
|
"LYD",
|
|
"MAD",
|
|
"MDL",
|
|
"MGA",
|
|
"MKD",
|
|
"MMK",
|
|
"MNT",
|
|
"MOP",
|
|
"MRU",
|
|
"MUR",
|
|
"MVR",
|
|
"MWK",
|
|
"MXN",
|
|
"MYR",
|
|
"MZN",
|
|
"NAD",
|
|
"NGN",
|
|
"NIO",
|
|
"NOK",
|
|
"NPR",
|
|
"NZD",
|
|
"OMR",
|
|
"PAB",
|
|
"PEN",
|
|
"PGK",
|
|
"PHP",
|
|
"PKR",
|
|
"PLN",
|
|
"PRB",
|
|
"PYG",
|
|
"QAR",
|
|
"RON",
|
|
"RSD",
|
|
"RUB",
|
|
"RWF",
|
|
"SAR",
|
|
"SBD",
|
|
"SCR",
|
|
"SDG",
|
|
"SEK",
|
|
"SGD",
|
|
"SHP",
|
|
"SLL",
|
|
"SOS",
|
|
"SRD",
|
|
"SSP",
|
|
"STN",
|
|
"SYP",
|
|
"SZL",
|
|
"THB",
|
|
"TJS",
|
|
"TMT",
|
|
"TND",
|
|
"TOP",
|
|
"TRY",
|
|
"TTD",
|
|
"TWD",
|
|
"TZS",
|
|
"UAH",
|
|
"UGX",
|
|
"USD",
|
|
"UYU",
|
|
"UZS",
|
|
"VEF",
|
|
"VES",
|
|
"VND",
|
|
"VUV",
|
|
"WST",
|
|
"XAF",
|
|
"XCD",
|
|
"XOF",
|
|
"XPF",
|
|
"YER",
|
|
"ZAR",
|
|
"ZMW"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 0,
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_ip_address": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Customer's IP address.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"customer_note": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"customer_user_agent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "User agent of the customer.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"date_completed": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was completed, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_completed_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was completed, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was last modified, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was last modified, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_paid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was paid, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_paid_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order was paid, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"discount_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount tax amount for the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"discount_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total discount amount for the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Fee lines data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Fee name.",
|
|
"type": "mixed"
|
|
},
|
|
"tax_class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax class of fee.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax status of fee.",
|
|
"enum": [
|
|
"none",
|
|
"taxable"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line taxes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax subtotal.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (after discounts).",
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"is_editable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether an order can be edited.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"line_items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line items data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"image": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Properties of the main product image.",
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image ID.",
|
|
"type": "integer"
|
|
},
|
|
"src": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Image URL.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"display_key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key for UI display.",
|
|
"type": "string"
|
|
},
|
|
"display_value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value for UI display.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"type": "mixed"
|
|
},
|
|
"parent_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Parent product name if the product is a variation.",
|
|
"type": "string"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product price.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"type": "mixed"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity ordered.",
|
|
"type": "integer"
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product SKU.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal (before discounts).",
|
|
"type": "string"
|
|
},
|
|
"subtotal_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal tax (before discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax class of product.",
|
|
"type": "string"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line taxes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"type": "integer"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax subtotal.",
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (after discounts).",
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variation_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation ID, if applicable.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"needs_payment": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether an order needs payment, based on status and order total.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"needs_processing": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether an order needs processing before it can be completed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"number": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order number.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"order_key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order key.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"payment_url": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Order payment URL.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"prices_include_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "True the prices included tax during checkout.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"refunds": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "List of refunds.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Refund ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"reason": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Refund reason.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Refund total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"set_paid": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"default": false,
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping address.",
|
|
"properties": {
|
|
"address_1": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 1",
|
|
"type": "string"
|
|
},
|
|
"address_2": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Address line 2",
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"company": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Company name.",
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country code in ISO 3166-1 alpha-2 format.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "First name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Last name.",
|
|
"type": "string"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postal code.",
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "ISO code or name of the county, state, province or district.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping lines data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"instance_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping instance ID.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"method_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method ID.",
|
|
"type": "mixed"
|
|
},
|
|
"method_title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method name.",
|
|
"type": "mixed"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line taxes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (after discounts).",
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"shipping_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total shipping tax amount for the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"shipping_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Total shipping amount for the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "pending",
|
|
"description": "Order status.",
|
|
"enum": [
|
|
"auto-draft",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"tax_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax lines data.",
|
|
"items": {
|
|
"properties": {
|
|
"compound": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Show if is a compound tax rate.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate label.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"rate_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rate_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"shipping_tax_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total (not including shipping taxes).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Grand total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Sum of all taxes.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Version of WooCommerce which last updated the order.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "shop_order",
|
|
"type": "object"
|
|
},
|
|
"shop_order_refund": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"amount": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Refund amount.",
|
|
"type": "string"
|
|
},
|
|
"api_refund": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"default": true,
|
|
"description": "When true, the payment gateway API is used to generate the refund.",
|
|
"type": "boolean"
|
|
},
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order refund was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the order refund was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"fee_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Fee lines data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Fee name.",
|
|
"type": "mixed"
|
|
},
|
|
"tax_class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax class of fee.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax status of fee.",
|
|
"enum": [
|
|
"none",
|
|
"taxable"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line taxes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax subtotal.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (after discounts).",
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"line_items": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line items data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"readonly": true,
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "mixed"
|
|
},
|
|
"price": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product price.",
|
|
"readonly": true,
|
|
"type": "number"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"readonly": true,
|
|
"type": "mixed"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Quantity ordered.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"sku": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Product SKU.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal (before discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"subtotal_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line subtotal tax (before discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax class of product.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line taxes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"subtotal": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax subtotal.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"variation_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Variation ID, if applicable.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"reason": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Reason for refund.",
|
|
"type": "string"
|
|
},
|
|
"refunded_by": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "User ID of user who created the refund.",
|
|
"type": "integer"
|
|
},
|
|
"refunded_payment": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If the payment was refunded via the API.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"shipping_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping lines data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"instance_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping instance ID.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"method_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method ID.",
|
|
"type": "mixed"
|
|
},
|
|
"method_title": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping method name.",
|
|
"type": "mixed"
|
|
},
|
|
"taxes": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line taxes.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total (after discounts).",
|
|
"type": "string"
|
|
},
|
|
"total_tax": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Line total tax (after discounts).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"tax_lines": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax lines data.",
|
|
"items": {
|
|
"properties": {
|
|
"compound": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Show if is a compound tax rate.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Item ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"label": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate label.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta data.",
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"key": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta key.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta value.",
|
|
"type": "mixed"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"rate_code": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate code.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rate_id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate ID",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"shipping_tax_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Shipping tax total.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tax_total": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax total (not including shipping taxes).",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "shop_order_refund",
|
|
"type": "object"
|
|
},
|
|
"sidebar": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"after_title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "HTML content to append to the sidebar title when displayed. Default is a closing h2 element.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"after_widget": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"before_title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"before_widget": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Extra CSS class to assign to the sidebar in the Widgets interface.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Description of sidebar.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "ID of sidebar.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique name identifying the sidebar.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Status of sidebar.",
|
|
"enum": [
|
|
"active",
|
|
"inactive"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"widgets": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": [],
|
|
"description": "Nested widgets.",
|
|
"items": {
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "sidebar",
|
|
"type": "object"
|
|
},
|
|
"status": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"date_floating": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether posts of this status may have floating published dates.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"private": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Whether posts with this status should be private.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Whether posts with this status should be protected.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"public": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether posts of this status should be shown in the front end of the site.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"queryable": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether posts with this status should be publicly-queryable.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"show_in_list": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Whether to include posts in the edit listing for their post type.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "status",
|
|
"type": "object"
|
|
},
|
|
"system_status": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"active_plugins": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Active plugins.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"database": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Database.",
|
|
"properties": {
|
|
"database_prefix": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Database prefix.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"database_tables": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Database tables.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"maxmind_geoip_database": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "MaxMind GeoIP database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"wc_database_version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WC database version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"dropins_mu_plugins": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Dropins & MU plugins.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"environment": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Environment.",
|
|
"properties": {
|
|
"curl_version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "cURL version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"default_timezone": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Default timezone.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"domdocument_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is DomDocument class enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"fsockopen_or_curl_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is fsockopen/cURL enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"gzip_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is GZip enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"home_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Home URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WordPress language.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"log_directory": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Log directory.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"log_directory_writable": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is log directory writable?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"max_upload_size": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Max upload size.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"mbstring_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is mbstring enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"mysql_version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "MySQL version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"mysql_version_string": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "MySQL version string.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"php_max_execution_time": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "PHP max execution time.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"php_max_input_vars": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "PHP max input vars.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"php_post_max_size": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "PHP post max size.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"php_version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "PHP version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"remote_get_response": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Remote GET response.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"remote_get_successful": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Remote GET successful?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"remote_post_response": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Remote POST response.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"remote_post_successful": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Remote POST successful?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"server_info": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Server info.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"site_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Site URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"soapclient_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is SoapClient class enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"store_id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WooCommerce Store Identifier.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"suhosin_installed": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is SUHOSIN installed?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WooCommerce version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"wp_cron": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Are WordPress cron jobs enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"wp_debug_mode": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is WordPress debug mode active?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"wp_memory_limit": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WordPress memory limit.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"wp_multisite": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is WordPress multisite?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"wp_version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WordPress version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"inactive_plugins": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Inactive plugins.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"logging": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Logging.",
|
|
"properties": {
|
|
"default_handler": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The logging handler class.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"level_threshold": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Minimum severity level.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"log_directory_size": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The size of the log directory.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"logging_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is logging enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"retention_period_days": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The number of days log entries are retained.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"pages": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "WooCommerce pages.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"post_type_counts": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total post count.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"security": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Security.",
|
|
"properties": {
|
|
"hide_errors": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Hide errors from visitors?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"secure_connection": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is the connection to your store secure?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"settings": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Settings.",
|
|
"properties": {
|
|
"HPOS_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is HPOS enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"HPOS_sync_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is HPOS sync enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"api_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Legacy REST API enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"currency": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Currency.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_position": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Currency position.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"currency_symbol": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Currency symbol.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"decimal_separator": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Decimal separator.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"enforce_approved_download_dirs": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Enforce approved download directories?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"force_ssl": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "SSL forced?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"geolocation_enabled": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Geolocation enabled?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"number_of_decimals": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Number of decimals.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"order_datastore": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Order datastore.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_visibility_terms": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Terms in the product visibility taxonomy.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"taxonomies": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Taxonomy terms for product/order statuses.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"thousand_separator": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Thousand separator.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"wccom_connected": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is store connected to WooCommerce.com?",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"theme": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Theme.",
|
|
"properties": {
|
|
"author_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Theme author URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"has_outdated_templates": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Does this theme have outdated templates?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"has_woocommerce_file": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Does the theme have a woocommerce.php file?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"has_woocommerce_support": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Does the theme declare WooCommerce support?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"is_child_theme": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Is this theme a child theme?",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Theme name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"overrides": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Template overrides.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"parent_author_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Parent theme author URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent_name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Parent theme name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent_version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Parent theme version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Theme version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"version_latest": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Latest version of theme.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "system_status",
|
|
"type": "object"
|
|
},
|
|
"system_status_tool": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"action": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A unique identifier for the tool.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"title": "system_status_tool",
|
|
"type": "object"
|
|
},
|
|
"tag": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published posts for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL of the term.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type attribution for the term.",
|
|
"enum": [
|
|
"post_tag"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "tag",
|
|
"type": "object"
|
|
},
|
|
"tax": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"city": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "standard",
|
|
"description": "Tax class.",
|
|
"enum": [
|
|
"reduced-rate",
|
|
"standard",
|
|
"zero-rate"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": false,
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": 1,
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": true,
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "tax",
|
|
"type": "object"
|
|
},
|
|
"tax_class": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Tax class name.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "tax_class",
|
|
"type": "object"
|
|
},
|
|
"taxonomy": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"capabilities": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "All capabilities used by the taxonomy.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human-readable description of the taxonomy.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"hierarchical": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not the taxonomy should have children.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"labels": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Human-readable labels for the taxonomy for various contexts.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the taxonomy.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rest_base": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "REST base route for the taxonomy.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rest_namespace": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "REST namespace route for the taxonomy.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"show_cloud": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Whether or not the term cloud should be displayed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the taxonomy.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"types": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Types associated with the taxonomy.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"visibility": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "The visibility settings for the taxonomy.",
|
|
"properties": {
|
|
"public": {
|
|
"description": "Whether a taxonomy is intended for use publicly either via the admin interface or by front end users.",
|
|
"type": "boolean"
|
|
},
|
|
"publicly_queryable": {
|
|
"description": "Whether the taxonomy is publicly queryable.",
|
|
"type": "boolean"
|
|
},
|
|
"show_admin_column": {
|
|
"description": "Whether to allow automatic creation of taxonomy columns on associated post types table.",
|
|
"type": "boolean"
|
|
},
|
|
"show_in_nav_menus": {
|
|
"description": "Whether to make the taxonomy available for selection in navigation menus.",
|
|
"type": "boolean"
|
|
},
|
|
"show_in_quick_edit": {
|
|
"description": "Whether to show the taxonomy in the Quick/Bulk edit panel.",
|
|
"type": "boolean"
|
|
},
|
|
"show_ui": {
|
|
"description": "Whether to generate a default UI for managing this taxonomy.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "taxonomy",
|
|
"type": "object"
|
|
},
|
|
"term": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of objects (posts of any type) assigned to the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Term description.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Term name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Parent term ID, if applicable.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "String based identifier for the term.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "term",
|
|
"type": "object"
|
|
},
|
|
"theme": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"description": "The theme author.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The theme author's name, as found in the theme header.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"description": "HTML for the theme author, transformed for display.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"author_uri": {
|
|
"description": "The website of the theme author.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The website of the theme author, as found in the theme header.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"description": "The website of the theme author, transformed for display.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"description": "A description of the theme.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The theme description, as found in the theme header.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"description": "The theme description, transformed for display.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"is_block_theme": {
|
|
"description": "Whether the theme is a block-based theme.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "The name of the theme.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The theme name, as found in the theme header.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"description": "The theme name, transformed for display.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"requires_php": {
|
|
"description": "The minimum PHP version required for the theme to work.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"requires_wp": {
|
|
"description": "The minimum WordPress version required for the theme to work.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"screenshot": {
|
|
"description": "The theme's screenshot URL.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the theme.",
|
|
"enum": [
|
|
"active",
|
|
"inactive"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"stylesheet": {
|
|
"description": "The theme's style sheet. This uniquely identifies the theme.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"stylesheet_uri": {
|
|
"description": "The URI for the theme's style sheet directory.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "Tags indicating styles and features of the theme.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The theme tags, as found in the theme header.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"rendered": {
|
|
"description": "The theme tags, transformed for display.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"template": {
|
|
"description": "The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"template_uri": {
|
|
"description": "The URI for the theme's template directory. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet directory.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"textdomain": {
|
|
"description": "The theme's text domain.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"theme_supports": {
|
|
"description": "Features supported by this theme.",
|
|
"properties": {
|
|
"align-wide": {
|
|
"default": false,
|
|
"description": "Whether theme opts in to wide alignment CSS class.",
|
|
"type": "boolean"
|
|
},
|
|
"automatic-feed-links": {
|
|
"default": false,
|
|
"description": "Whether posts and comments RSS feed links are added to head.",
|
|
"type": "boolean"
|
|
},
|
|
"block-template-parts": {
|
|
"default": false,
|
|
"description": "Whether a theme uses block-based template parts.",
|
|
"type": "boolean"
|
|
},
|
|
"block-templates": {
|
|
"default": false,
|
|
"description": "Whether a theme uses block-based templates.",
|
|
"type": "boolean"
|
|
},
|
|
"custom-background": {
|
|
"additionalProperties": false,
|
|
"default": false,
|
|
"description": "Custom background if defined by the theme.",
|
|
"properties": {
|
|
"default-attachment": {
|
|
"enum": [
|
|
"fixed",
|
|
"scroll"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"default-color": {
|
|
"type": "string"
|
|
},
|
|
"default-image": {
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"default-position-x": {
|
|
"enum": [
|
|
"center",
|
|
"left",
|
|
"right"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"default-position-y": {
|
|
"enum": [
|
|
"center",
|
|
"left",
|
|
"right"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"default-preset": {
|
|
"enum": [
|
|
"custom",
|
|
"default",
|
|
"fill",
|
|
"fit",
|
|
"repeat"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"default-repeat": {
|
|
"enum": [
|
|
"no-repeat",
|
|
"repeat",
|
|
"repeat-x",
|
|
"repeat-y"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"default-size": {
|
|
"enum": [
|
|
"auto",
|
|
"contain",
|
|
"cover"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"boolean",
|
|
"object"
|
|
]
|
|
},
|
|
"custom-header": {
|
|
"additionalProperties": false,
|
|
"default": false,
|
|
"description": "Custom header if defined by the theme.",
|
|
"properties": {
|
|
"default-image": {
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"default-text-color": {
|
|
"type": "string"
|
|
},
|
|
"flex-height": {
|
|
"type": "boolean"
|
|
},
|
|
"flex-width": {
|
|
"type": "boolean"
|
|
},
|
|
"header-text": {
|
|
"type": "boolean"
|
|
},
|
|
"height": {
|
|
"type": "integer"
|
|
},
|
|
"random-default": {
|
|
"type": "boolean"
|
|
},
|
|
"uploads": {
|
|
"type": "boolean"
|
|
},
|
|
"video": {
|
|
"type": "boolean"
|
|
},
|
|
"width": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": [
|
|
"boolean",
|
|
"object"
|
|
]
|
|
},
|
|
"custom-logo": {
|
|
"additionalProperties": false,
|
|
"default": false,
|
|
"description": "Custom logo if defined by the theme.",
|
|
"properties": {
|
|
"flex-height": {
|
|
"type": "boolean"
|
|
},
|
|
"flex-width": {
|
|
"type": "boolean"
|
|
},
|
|
"header-text": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"height": {
|
|
"type": "integer"
|
|
},
|
|
"unlink-homepage-logo": {
|
|
"type": "boolean"
|
|
},
|
|
"width": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": [
|
|
"boolean",
|
|
"object"
|
|
]
|
|
},
|
|
"customize-selective-refresh-widgets": {
|
|
"default": false,
|
|
"description": "Whether the theme enables Selective Refresh for Widgets being managed with the Customizer.",
|
|
"type": "boolean"
|
|
},
|
|
"dark-editor-style": {
|
|
"default": false,
|
|
"description": "Whether theme opts in to the dark editor style UI.",
|
|
"type": "boolean"
|
|
},
|
|
"disable-custom-colors": {
|
|
"default": false,
|
|
"description": "Whether the theme disables custom colors.",
|
|
"type": "boolean"
|
|
},
|
|
"disable-custom-font-sizes": {
|
|
"default": false,
|
|
"description": "Whether the theme disables custom font sizes.",
|
|
"type": "boolean"
|
|
},
|
|
"disable-custom-gradients": {
|
|
"default": false,
|
|
"description": "Whether the theme disables custom gradients.",
|
|
"type": "boolean"
|
|
},
|
|
"disable-layout-styles": {
|
|
"default": false,
|
|
"description": "Whether the theme disables generated layout styles.",
|
|
"type": "boolean"
|
|
},
|
|
"editor-color-palette": {
|
|
"default": false,
|
|
"description": "Custom color palette if defined by the theme.",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"color": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": [
|
|
"array",
|
|
"boolean"
|
|
]
|
|
},
|
|
"editor-font-sizes": {
|
|
"default": false,
|
|
"description": "Custom font sizes if defined by the theme.",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": [
|
|
"array",
|
|
"boolean"
|
|
]
|
|
},
|
|
"editor-gradient-presets": {
|
|
"default": false,
|
|
"description": "Custom gradient presets if defined by the theme.",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"gradient": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": [
|
|
"array",
|
|
"boolean"
|
|
]
|
|
},
|
|
"editor-spacing-sizes": {
|
|
"default": false,
|
|
"description": "Custom spacing sizes if defined by the theme.",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"size": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": [
|
|
"array",
|
|
"boolean"
|
|
]
|
|
},
|
|
"editor-styles": {
|
|
"default": false,
|
|
"description": "Whether theme opts in to the editor styles CSS wrapper.",
|
|
"type": "boolean"
|
|
},
|
|
"formats": {
|
|
"default": [
|
|
"standard"
|
|
],
|
|
"description": "Post formats supported.",
|
|
"items": {
|
|
"enum": {
|
|
"aside": "aside",
|
|
"audio": "audio",
|
|
"chat": "chat",
|
|
"gallery": "gallery",
|
|
"image": "image",
|
|
"link": "link",
|
|
"quote": "quote",
|
|
"standard": "standard",
|
|
"status": "status",
|
|
"video": "video"
|
|
},
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"html5": {
|
|
"default": false,
|
|
"description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.",
|
|
"items": {
|
|
"enum": [
|
|
"caption",
|
|
"comment-form",
|
|
"comment-list",
|
|
"gallery",
|
|
"script",
|
|
"search-form",
|
|
"style"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": [
|
|
"array",
|
|
"boolean"
|
|
]
|
|
},
|
|
"post-thumbnails": {
|
|
"default": false,
|
|
"description": "The post types that support thumbnails or true if all post types are supported.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": [
|
|
"array",
|
|
"boolean"
|
|
]
|
|
},
|
|
"responsive-embeds": {
|
|
"default": false,
|
|
"description": "Whether the theme supports responsive embedded content.",
|
|
"type": "boolean"
|
|
},
|
|
"title-tag": {
|
|
"default": false,
|
|
"description": "Whether the theme can manage the document title tag.",
|
|
"type": "boolean"
|
|
},
|
|
"wp-block-styles": {
|
|
"default": false,
|
|
"description": "Whether theme opts in to default WordPress block styles for viewing.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"theme_uri": {
|
|
"description": "The URI of the theme's webpage.",
|
|
"properties": {
|
|
"raw": {
|
|
"description": "The URI of the theme's webpage, as found in the theme header.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"description": "The URI of the theme's webpage, transformed for display.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"version": {
|
|
"description": "The theme's current version.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "theme",
|
|
"type": "object"
|
|
},
|
|
"top_sellers_report": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"name": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Product name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"product_id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Product ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"quantity": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Total number of purchases.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "top_sellers_report",
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"capabilities": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "All capabilities used by the post type.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A human-readable description of the post type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"has_archive": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.",
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean",
|
|
"string"
|
|
]
|
|
},
|
|
"hierarchical": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Whether or not the post type should have children.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"icon": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The icon for the post type.",
|
|
"readonly": true,
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"labels": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Human-readable labels for the post type for various contexts.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rest_base": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "REST base route for the post type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rest_namespace": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "REST route's namespace for the post type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"supports": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "All features, supported by the post type.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"taxonomies": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Taxonomies associated with post type.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The block template associated with the post type.",
|
|
"readonly": true,
|
|
"type": [
|
|
"array"
|
|
]
|
|
},
|
|
"template_lock": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The template_lock associated with the post type, or false if none.",
|
|
"enum": [
|
|
"all",
|
|
"insert",
|
|
"contentOnly",
|
|
false
|
|
],
|
|
"readonly": true,
|
|
"type": [
|
|
"boolean",
|
|
"string"
|
|
]
|
|
},
|
|
"viewable": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Whether or not the post type can be viewed.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"visibility": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "The visibility settings for the post type.",
|
|
"properties": {
|
|
"show_in_nav_menus": {
|
|
"description": "Whether to make the post type available for selection in navigation menus.",
|
|
"type": "boolean"
|
|
},
|
|
"show_ui": {
|
|
"description": "Whether to generate a default UI for managing this post type.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "type",
|
|
"type": "object"
|
|
},
|
|
"upload_theme": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"message": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Theme installation message.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Theme installation status.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Uploaded theme.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "upload_theme",
|
|
"type": "object"
|
|
},
|
|
"user": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"avatar_urls": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URLs for the user.",
|
|
"properties": {
|
|
"24": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL with image size of 24 pixels.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"48": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL with image size of 48 pixels.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"96": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Avatar URL with image size of 96 pixels.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"capabilities": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "All capabilities assigned to the user.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "The email address for the user.",
|
|
"format": "email",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"extra_capabilities": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Any extra capabilities assigned to the user.",
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"first_name": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the user.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"last_name": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Author URL of the user.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Locale for the user.",
|
|
"enum": [
|
|
"",
|
|
"en_GB",
|
|
"en_US",
|
|
"fr_BE",
|
|
"fr_FR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"persisted_preferences": {
|
|
"additionalProperties": true,
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"default": [],
|
|
"description": "",
|
|
"properties": {
|
|
"_modified": {
|
|
"description": "The date and time the preferences were updated.",
|
|
"format": "date-time",
|
|
"readonly": false,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"woocommerce_coming_soon_banner_dismissed": {
|
|
"default": "",
|
|
"description": "Indicate whether the user has dismissed the coming soon notice or not.",
|
|
"type": "string"
|
|
},
|
|
"woocommerce_launch_your_store_tour_hidden": {
|
|
"default": "",
|
|
"description": "Indicate whether the user has dismissed the site visibility tour on the home screen.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"context": [],
|
|
"description": "Password for the user (never included).",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"registered_date": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Registration date for the user.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Roles assigned to the user.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL of the user.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Login name for the user.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "user",
|
|
"type": "object"
|
|
},
|
|
"webhook": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the webhook was created, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the webhook was created, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the webhook was last modified, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the webhook was last modified, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"delivery_url": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The URL where the webhook payload is delivered.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"event": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Webhook event.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"hooks": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "WooCommerce action names associated with the webhook.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Webhook resource.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"default": "active",
|
|
"description": "Webhook status.",
|
|
"enum": [
|
|
"active",
|
|
"disabled",
|
|
"paused"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "webhook",
|
|
"type": "object"
|
|
},
|
|
"webhook_delivery": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"date_created": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the webhook delivery was logged, in the site's timezone.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"date_created_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the webhook delivery was logged, as GMT.",
|
|
"readonly": true,
|
|
"type": "date-time"
|
|
},
|
|
"duration": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The delivery duration, in seconds.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the resource.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"request_body": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Request body",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"request_headers": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Request headers",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"request_url": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The URL where the webhook was delivered.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"response_body": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The response body from the receiving server.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"response_code": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The HTTP response code from the receiving server.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"response_headers": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "Array of the response headers from the receiving server.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"readonly": true,
|
|
"type": "array"
|
|
},
|
|
"response_message": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "The HTTP response message from the receiving server.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"summary": {
|
|
"context": [
|
|
"view"
|
|
],
|
|
"description": "A friendly summary of the response including the HTTP response code, message, and body.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "webhook_delivery",
|
|
"type": "object"
|
|
},
|
|
"widget": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"form_data": {
|
|
"context": [],
|
|
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the widget.",
|
|
"type": "string"
|
|
},
|
|
"id_base": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"default": null,
|
|
"description": "Instance settings of the widget, if supported.",
|
|
"properties": {
|
|
"encoded": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Base64 encoded representation of the instance settings.",
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Cryptographic hash of the instance settings.",
|
|
"type": "string"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Unencoded instance settings, if supported.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML representation of the widget.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered_form": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "HTML representation of the widget admin form.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"sidebar": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "wp_inactive_widgets",
|
|
"description": "The sidebar to which the widget belongs.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "widget",
|
|
"type": "object"
|
|
},
|
|
"widget-type": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"classname": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Class name",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Description of the widget.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique slug identifying the widget type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"is_multi": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the widget supports multiple instances",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Human-readable name identifying the widget type.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "widget-type",
|
|
"type": "object"
|
|
},
|
|
"wp-site-health-test": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"actions": {
|
|
"description": "HTML containing an action to direct the user to where they can resolve the issue.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"badge": {
|
|
"description": "The category this test is grouped in.",
|
|
"properties": {
|
|
"color": {
|
|
"enum": [
|
|
"blue",
|
|
"gray",
|
|
"green",
|
|
"orange",
|
|
"purple",
|
|
"red"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"description": {
|
|
"description": "A more descriptive explanation of what the test looks for, and why it is important for the user.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"label": {
|
|
"description": "A label describing the test.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "The status of the test.",
|
|
"enum": [
|
|
"critical",
|
|
"good",
|
|
"recommended"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"test": {
|
|
"description": "The name of the test being run.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "wp-site-health-test",
|
|
"type": "object"
|
|
},
|
|
"wp_block": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}",
|
|
"rel": "https:/api.w.org/action-publish",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"status": {
|
|
"enum": [
|
|
"future",
|
|
"publish"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can publish this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}",
|
|
"rel": "https:/api.w.org/action-assign-wp_pattern_category",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"wp_pattern_category": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can assign terms in the wp_pattern_category taxonomy."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}",
|
|
"rel": "https:/api.w.org/action-create-wp_pattern_category",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"wp_pattern_category": {
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can create terms in the wp_pattern_category taxonomy."
|
|
}
|
|
],
|
|
"properties": {
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"footnotes": {
|
|
"default": "",
|
|
"description": "",
|
|
"type": "string"
|
|
},
|
|
"wp_pattern_sync_status": {
|
|
"default": "",
|
|
"description": "",
|
|
"enum": [
|
|
"partial",
|
|
"unsynced"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"wp_pattern_category": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "wp_block",
|
|
"type": "object"
|
|
},
|
|
"wp_block-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"excerpt": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The excerpt for the post.",
|
|
"properties": {
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the excerpt is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Excerpt for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML excerpt for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the revision.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": {
|
|
"footnotes": {
|
|
"default": "",
|
|
"description": "",
|
|
"type": "string"
|
|
},
|
|
"wp_pattern_sync_status": {
|
|
"default": "",
|
|
"description": "",
|
|
"enum": [
|
|
"partial",
|
|
"unsynced"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"preview_link": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Preview link for the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the revision unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "wp_block-revision",
|
|
"type": "object"
|
|
},
|
|
"wp_font_face": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"font_face_settings": {
|
|
"additionalProperties": false,
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "font-face declaration in theme.json format.",
|
|
"properties": {
|
|
"ascentOverride": {
|
|
"description": "CSS ascent-override value.",
|
|
"type": "string"
|
|
},
|
|
"descentOverride": {
|
|
"description": "CSS descent-override value.",
|
|
"type": "string"
|
|
},
|
|
"fontDisplay": {
|
|
"default": "fallback",
|
|
"description": "CSS font-display value.",
|
|
"enum": [
|
|
"auto",
|
|
"block",
|
|
"fallback",
|
|
"optional",
|
|
"swap"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"fontFamily": {
|
|
"default": "",
|
|
"description": "CSS font-family value.",
|
|
"type": "string"
|
|
},
|
|
"fontFeatureSettings": {
|
|
"description": "CSS font-feature-settings value.",
|
|
"type": "string"
|
|
},
|
|
"fontStretch": {
|
|
"description": "CSS font-stretch value.",
|
|
"type": "string"
|
|
},
|
|
"fontStyle": {
|
|
"default": "normal",
|
|
"description": "CSS font-style value.",
|
|
"type": "string"
|
|
},
|
|
"fontVariant": {
|
|
"description": "CSS font-variant value.",
|
|
"type": "string"
|
|
},
|
|
"fontVariationSettings": {
|
|
"description": "CSS font-variation-settings value.",
|
|
"type": "string"
|
|
},
|
|
"fontWeight": {
|
|
"default": "400",
|
|
"description": "List of available font weights, separated by a space.",
|
|
"type": [
|
|
"integer",
|
|
"string"
|
|
]
|
|
},
|
|
"lineGapOverride": {
|
|
"description": "CSS line-gap-override value.",
|
|
"type": "string"
|
|
},
|
|
"preview": {
|
|
"default": "",
|
|
"description": "URL to a preview image of the font face.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"sizeAdjust": {
|
|
"description": "CSS size-adjust value.",
|
|
"type": "string"
|
|
},
|
|
"src": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
],
|
|
"default": [],
|
|
"description": "Paths or URLs to the font files."
|
|
},
|
|
"unicodeRange": {
|
|
"description": "CSS unicode-range value.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"fontFamily",
|
|
"src"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent font family of the font face.",
|
|
"type": "integer"
|
|
},
|
|
"theme_json_version": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 3,
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"maximum": 3,
|
|
"minimum": 2,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "wp_font_face",
|
|
"type": "object"
|
|
},
|
|
"wp_font_family": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"font_faces": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The IDs of the child font faces in the font family.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"font_family_settings": {
|
|
"additionalProperties": false,
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "font-face definition in theme.json format.",
|
|
"properties": {
|
|
"fontFamily": {
|
|
"description": "CSS font-family value.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name of the font family preset, translatable.",
|
|
"type": "string"
|
|
},
|
|
"preview": {
|
|
"default": "",
|
|
"description": "URL to a preview image of the font family.",
|
|
"format": "uri",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Kebab-case unique identifier for the font family preset.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"fontFamily",
|
|
"name",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"theme_json_version": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": 3,
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"maximum": 3,
|
|
"minimum": 2,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "wp_font_family",
|
|
"type": "object"
|
|
},
|
|
"wp_global_styles": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "ID of global styles config.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"settings": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Global settings.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"styles": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Global styles.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Title of the global styles variation.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Title for the global styles variation, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"title": "wp_global_styles",
|
|
"type": "object"
|
|
},
|
|
"wp_global_styles-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "ID of global styles config.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Global settings.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"styles": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Global styles.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
}
|
|
},
|
|
"title": "wp_global_styles-revision",
|
|
"type": "object"
|
|
},
|
|
"wp_navigation": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"links": [
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}",
|
|
"rel": "https:/api.w.org/action-publish",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"status": {
|
|
"enum": [
|
|
"future",
|
|
"publish"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can publish this post."
|
|
},
|
|
{
|
|
"href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}",
|
|
"rel": "https:/api.w.org/action-unfiltered-html",
|
|
"targetSchema": {
|
|
"properties": {
|
|
"content": {
|
|
"raw": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"title": "The current user can post unfiltered HTML markup and JavaScript."
|
|
}
|
|
],
|
|
"properties": {
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit",
|
|
"embed"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL to the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the post was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "A named status for the object.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of post.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "wp_navigation",
|
|
"type": "object"
|
|
},
|
|
"wp_navigation-revision": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The content for the post.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit",
|
|
"embed"
|
|
],
|
|
"description": "Version of the content block format used by the post.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"protected": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether the content is protected with a password.",
|
|
"readonly": true,
|
|
"type": "boolean"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed"
|
|
],
|
|
"description": "Content for the post, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML content for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was published, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"guid": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The globally unique identifier for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "GUID for the post, as it exists in the database.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "GUID for the post, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"type": "object"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the revision.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"modified_gmt": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the revision was last modified, as GMT.",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the parent of the revision.",
|
|
"type": "integer"
|
|
},
|
|
"preview_link": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Preview link for the post.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the revision unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The title for the post.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed"
|
|
],
|
|
"description": "Title for the object, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the object, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"title": "wp_navigation-revision",
|
|
"type": "object"
|
|
},
|
|
"wp_pattern_category": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"count": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Number of published posts for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique identifier for the term.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"link": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "URL of the term.",
|
|
"format": "uri",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Meta fields.",
|
|
"properties": [],
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type attribution for the term.",
|
|
"enum": [
|
|
"wp_pattern_category"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "wp_pattern_category",
|
|
"type": "object"
|
|
},
|
|
"wp_template": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"author_text": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Human readable text for the author.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Content of template.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the template.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Content for the template, as it exists in the database.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"has_theme_file": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Theme file exists.",
|
|
"readonly": true,
|
|
"type": "bool"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "ID of template.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"is_custom": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Whether a template is a custom template.",
|
|
"readonly": true,
|
|
"type": "bool"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the template was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"origin": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Source of a customised template",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"original_source": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "From where the template originally comes, eg 'theme'",
|
|
"enum": [
|
|
"plugin",
|
|
"site",
|
|
"theme",
|
|
"user"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique slug identifying the template.",
|
|
"minLength": 1,
|
|
"pattern": "[a-zA-Z0-9_\\%-]+",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Source of template",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "publish",
|
|
"description": "Status of template.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Title of template.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Title for the template, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the template, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
},
|
|
"wp_id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Post ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "wp_template",
|
|
"type": "object"
|
|
},
|
|
"wp_template_part": {
|
|
"$schema": "http:/json-schema.org/draft-04/schema#",
|
|
"properties": {
|
|
"area": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Where the template part is intended for use (header, footer, etc)",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"author_text": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Human readable text for the author.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Content of template.",
|
|
"properties": {
|
|
"block_version": {
|
|
"context": [
|
|
"edit"
|
|
],
|
|
"description": "Version of the content block format used by the template.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
},
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Content for the template, as it exists in the database.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"has_theme_file": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Theme file exists.",
|
|
"readonly": true,
|
|
"type": "bool"
|
|
},
|
|
"id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "ID of template.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"modified": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "The date the template was last modified, in the site's time zone.",
|
|
"format": "date-time",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"origin": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Source of a customised template",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"original_source": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "From where the template originally comes, eg 'theme'",
|
|
"enum": [
|
|
"plugin",
|
|
"site",
|
|
"theme",
|
|
"user"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Unique slug identifying the template.",
|
|
"minLength": 1,
|
|
"pattern": "[a-zA-Z0-9_\\%-]+",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Source of template",
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "publish",
|
|
"description": "Status of template.",
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"default": "",
|
|
"description": "Title of template.",
|
|
"properties": {
|
|
"raw": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Title for the template, as it exists in the database.",
|
|
"type": "string"
|
|
},
|
|
"rendered": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "HTML title for the template, transformed for display.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
},
|
|
"wp_id": {
|
|
"context": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
],
|
|
"description": "Post ID.",
|
|
"readonly": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "wp_template_part",
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"info": {
|
|
"contact": {
|
|
"email": "contact@gcch.fr",
|
|
"name": "Haiku Atelier",
|
|
"url": "https:/haikuatelier.fr.ddev.site"
|
|
},
|
|
"description": "",
|
|
"title": "Haiku Atelier API",
|
|
"version": "6.6.1"
|
|
},
|
|
"openapi": "3.1.0",
|
|
"paths": {
|
|
"/carbon-fields/v1": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/association": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/association/options": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/attachment": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The requested type: ID or URL.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID / URL of the attachment",
|
|
"in": "query",
|
|
"name": "value",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/block-renderer": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content of the block.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the block.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"post_id": {
|
|
"description": "ID of the post context.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"content",
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/comments/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/options": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/posts/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/terms/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/carbon-fields/v1/users/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"isActive": {
|
|
"description": "Set to false will trigger the site to disconnect.",
|
|
"required": true
|
|
}
|
|
},
|
|
"required": [
|
|
"isActive"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"isActive": {
|
|
"description": "Set to false will trigger the site to disconnect.",
|
|
"required": true
|
|
}
|
|
},
|
|
"required": [
|
|
"isActive"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"isActive": {
|
|
"description": "Set to false will trigger the site to disconnect.",
|
|
"required": true
|
|
}
|
|
},
|
|
"required": [
|
|
"isActive"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection/authorize_url": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "URI of the admin page where the user should be redirected after connection flow",
|
|
"in": "query",
|
|
"name": "redirect_uri",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection/data": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection/owner": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"owner": {
|
|
"description": "New owner",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"owner"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"owner": {
|
|
"description": "New owner",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"owner"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"owner": {
|
|
"description": "New owner",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"owner"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection/plugins": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection/reconnect": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/connection/register": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"from": {
|
|
"description": "Indicates where the registration action was triggered for tracking/segmentation purposes",
|
|
"type": "string"
|
|
},
|
|
"plugin_slug": {
|
|
"description": "Indicates from what plugin the request is coming from",
|
|
"type": "string"
|
|
},
|
|
"redirect_uri": {
|
|
"description": "URI of the admin page where the user should be redirected after connection flow",
|
|
"type": "string"
|
|
},
|
|
"registration_nonce": {
|
|
"description": "The registration nonce",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"registration_nonce"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"from": {
|
|
"description": "Indicates where the registration action was triggered for tracking/segmentation purposes",
|
|
"type": "string"
|
|
},
|
|
"plugin_slug": {
|
|
"description": "Indicates from what plugin the request is coming from",
|
|
"type": "string"
|
|
},
|
|
"redirect_uri": {
|
|
"description": "URI of the admin page where the user should be redirected after connection flow",
|
|
"type": "string"
|
|
},
|
|
"registration_nonce": {
|
|
"description": "The registration nonce",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"registration_nonce"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"from": {
|
|
"description": "Indicates where the registration action was triggered for tracking/segmentation purposes",
|
|
"type": "string"
|
|
},
|
|
"plugin_slug": {
|
|
"description": "Indicates from what plugin the request is coming from",
|
|
"type": "string"
|
|
},
|
|
"redirect_uri": {
|
|
"description": "URI of the admin page where the user should be redirected after connection flow",
|
|
"type": "string"
|
|
},
|
|
"registration_nonce": {
|
|
"description": "The registration nonce",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"registration_nonce"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/remote_authorize": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/user-token": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"is_connection_owner": {
|
|
"description": "Is connection owner",
|
|
"type": "boolean"
|
|
},
|
|
"user_token": {
|
|
"description": "New user token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"user_token"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"is_connection_owner": {
|
|
"description": "Is connection owner",
|
|
"type": "boolean"
|
|
},
|
|
"user_token": {
|
|
"description": "New user token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"user_token"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"is_connection_owner": {
|
|
"description": "Is connection owner",
|
|
"type": "boolean"
|
|
},
|
|
"user_token": {
|
|
"description": "New user token",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"user_token"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/verify_registration": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/jetpack/v4/verify_xmlrpc_error": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"nonce": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"nonce"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/experiments/assignment": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/features": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/launch-your-store/initialize-coming-soon": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/launch-your-store/survey-completed": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/launch-your-store/update-survey-status": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/launch-your-store/woopayments/test-orders": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/launch-your-store/woopayments/test-orders/count": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/campaign-types": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/marketing_campaign_type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/campaigns": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/marketing_campaign"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/channels": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/marketing_channel"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/knowledge-base": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/overview/activate-plugin": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"plugin": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"plugin": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"plugin": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/overview/installed-plugins": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/recommendations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": true,
|
|
"schema": {
|
|
"enum": [
|
|
"channels",
|
|
"extensions"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/marketing_recommendation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/marketing/recommended": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/mobile-app": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/mobile-app/send-magic-link": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/navigation/favorites/me": {
|
|
"delete": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"item_id": {
|
|
"required": true
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"item_id": {
|
|
"required": true
|
|
}
|
|
},
|
|
"required": [
|
|
"item_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/notice/dismiss": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/free-extensions": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/plugins/install-and-activate": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Install and Activate Schema"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/plugins/install-and-activate-async": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"plugins": {
|
|
"description": "A list of plugins to install",
|
|
"required": true,
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugins"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Install Async Schema"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/plugins/jetpack-authorization-url": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The URL to redirect to after authorization",
|
|
"in": "query",
|
|
"name": "redirect_url",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "from value for the jetpack authorization page",
|
|
"in": "query",
|
|
"name": "from",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "job_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Install Async Schema"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/product-types": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/products": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/profile": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_profile"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_extensions": {
|
|
"description": "Extra business extensions to install.",
|
|
"type": "array"
|
|
},
|
|
"completed": {
|
|
"description": "Whether or not the profile was completed.",
|
|
"type": "boolean"
|
|
},
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"industry": {
|
|
"description": "Industry.",
|
|
"type": "array"
|
|
},
|
|
"is_agree_marketing": {
|
|
"description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.",
|
|
"type": "boolean"
|
|
},
|
|
"is_plugins_page_skipped": {
|
|
"description": "Whether or not plugins step in core profiler was skipped.",
|
|
"type": "boolean"
|
|
},
|
|
"is_store_country_set": {
|
|
"description": "Whether or not this store country is set via onboarding profiler.",
|
|
"type": "boolean"
|
|
},
|
|
"number_employees": {
|
|
"description": "Number of employees of the store.",
|
|
"type": "string"
|
|
},
|
|
"other_platform": {
|
|
"description": "Name of other platform used to sell.",
|
|
"type": "string"
|
|
},
|
|
"other_platform_name": {
|
|
"description": "Name of other platform used to sell (not listed).",
|
|
"type": "string"
|
|
},
|
|
"product_count": {
|
|
"description": "Number of products to be added.",
|
|
"type": "string"
|
|
},
|
|
"product_types": {
|
|
"description": "Types of products sold.",
|
|
"type": "array"
|
|
},
|
|
"revenue": {
|
|
"description": "Current annual revenue of the store.",
|
|
"type": "string"
|
|
},
|
|
"selling_venues": {
|
|
"description": "Other places the store is selling products.",
|
|
"type": "string"
|
|
},
|
|
"setup_client": {
|
|
"description": "Whether or not this store was setup for a client.",
|
|
"type": "boolean"
|
|
},
|
|
"skipped": {
|
|
"description": "Whether or not the profile was skipped.",
|
|
"type": "boolean"
|
|
},
|
|
"store_email": {
|
|
"description": "Store email address.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Selected store theme.",
|
|
"type": "string"
|
|
},
|
|
"wccom_connected": {
|
|
"description": "Whether or not the store was connected to WooCommerce.com during the extension flow.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_profile"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_extensions": {
|
|
"description": "Extra business extensions to install.",
|
|
"type": "array"
|
|
},
|
|
"completed": {
|
|
"description": "Whether or not the profile was completed.",
|
|
"type": "boolean"
|
|
},
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"industry": {
|
|
"description": "Industry.",
|
|
"type": "array"
|
|
},
|
|
"is_agree_marketing": {
|
|
"description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.",
|
|
"type": "boolean"
|
|
},
|
|
"is_plugins_page_skipped": {
|
|
"description": "Whether or not plugins step in core profiler was skipped.",
|
|
"type": "boolean"
|
|
},
|
|
"is_store_country_set": {
|
|
"description": "Whether or not this store country is set via onboarding profiler.",
|
|
"type": "boolean"
|
|
},
|
|
"number_employees": {
|
|
"description": "Number of employees of the store.",
|
|
"type": "string"
|
|
},
|
|
"other_platform": {
|
|
"description": "Name of other platform used to sell.",
|
|
"type": "string"
|
|
},
|
|
"other_platform_name": {
|
|
"description": "Name of other platform used to sell (not listed).",
|
|
"type": "string"
|
|
},
|
|
"product_count": {
|
|
"description": "Number of products to be added.",
|
|
"type": "string"
|
|
},
|
|
"product_types": {
|
|
"description": "Types of products sold.",
|
|
"type": "array"
|
|
},
|
|
"revenue": {
|
|
"description": "Current annual revenue of the store.",
|
|
"type": "string"
|
|
},
|
|
"selling_venues": {
|
|
"description": "Other places the store is selling products.",
|
|
"type": "string"
|
|
},
|
|
"setup_client": {
|
|
"description": "Whether or not this store was setup for a client.",
|
|
"type": "boolean"
|
|
},
|
|
"skipped": {
|
|
"description": "Whether or not the profile was skipped.",
|
|
"type": "boolean"
|
|
},
|
|
"store_email": {
|
|
"description": "Store email address.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Selected store theme.",
|
|
"type": "string"
|
|
},
|
|
"wccom_connected": {
|
|
"description": "Whether or not the store was connected to WooCommerce.com during the extension flow.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_profile"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_extensions": {
|
|
"description": "Extra business extensions to install.",
|
|
"type": "array"
|
|
},
|
|
"completed": {
|
|
"description": "Whether or not the profile was completed.",
|
|
"type": "boolean"
|
|
},
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"industry": {
|
|
"description": "Industry.",
|
|
"type": "array"
|
|
},
|
|
"is_agree_marketing": {
|
|
"description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.",
|
|
"type": "boolean"
|
|
},
|
|
"is_plugins_page_skipped": {
|
|
"description": "Whether or not plugins step in core profiler was skipped.",
|
|
"type": "boolean"
|
|
},
|
|
"is_store_country_set": {
|
|
"description": "Whether or not this store country is set via onboarding profiler.",
|
|
"type": "boolean"
|
|
},
|
|
"number_employees": {
|
|
"description": "Number of employees of the store.",
|
|
"type": "string"
|
|
},
|
|
"other_platform": {
|
|
"description": "Name of other platform used to sell.",
|
|
"type": "string"
|
|
},
|
|
"other_platform_name": {
|
|
"description": "Name of other platform used to sell (not listed).",
|
|
"type": "string"
|
|
},
|
|
"product_count": {
|
|
"description": "Number of products to be added.",
|
|
"type": "string"
|
|
},
|
|
"product_types": {
|
|
"description": "Types of products sold.",
|
|
"type": "array"
|
|
},
|
|
"revenue": {
|
|
"description": "Current annual revenue of the store.",
|
|
"type": "string"
|
|
},
|
|
"selling_venues": {
|
|
"description": "Other places the store is selling products.",
|
|
"type": "string"
|
|
},
|
|
"setup_client": {
|
|
"description": "Whether or not this store was setup for a client.",
|
|
"type": "boolean"
|
|
},
|
|
"skipped": {
|
|
"description": "Whether or not the profile was skipped.",
|
|
"type": "boolean"
|
|
},
|
|
"store_email": {
|
|
"description": "Store email address.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Selected store theme.",
|
|
"type": "string"
|
|
},
|
|
"wccom_connected": {
|
|
"description": "Whether or not the store was connected to WooCommerce.com during the extension flow.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_profile"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/profile/experimental_get_email_prefill": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_profile"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Optional parameter to get only specific task lists by ID.",
|
|
"in": "query",
|
|
"name": "ids",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"extended",
|
|
"secret_tasklist",
|
|
"setup"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extended_tasks": {
|
|
"description": "List of extended deprecated tasks from the client-side filter.",
|
|
"type": "array"
|
|
},
|
|
"ids": {
|
|
"description": "Optional parameter to get only specific task lists by ID.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/create_homepage": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/create_product_from_template": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"template_name": {
|
|
"description": "Product template name.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"template_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/import_sample_products": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/action": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/dismiss": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/hide": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/snooze": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"duration": {
|
|
"description": "Time period to snooze the task.",
|
|
"type": "string"
|
|
},
|
|
"task_list_id": {
|
|
"description": "Optional parameter to query specific task list.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/undo_dismiss": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/undo_snooze": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/tasks/{id}/unhide": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/themes/activate": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/themes/install": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/onboarding_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/onboarding/themes/recommended": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Limits the results to themes relevant for this industry (optional)",
|
|
"in": "query",
|
|
"name": "industry",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Returns pricing in this currency (optional, default: USD)",
|
|
"in": "query",
|
|
"name": "currency",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"AUD",
|
|
"CAD",
|
|
"EUR",
|
|
"GBP",
|
|
"USD"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/options": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/options"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/options"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/options"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/options"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/payment-gateway-suggestions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no",
|
|
"in": "query",
|
|
"name": "force_default_suggestions",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment-gateway-suggestions"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/payment-gateway-suggestions/dismiss": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment-gateway-suggestions"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/activate": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/activate/status": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/activate/status/{job_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "job_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/active": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/connect-jetpack": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/connect-square": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/connect-wcpay": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/finish-wccom-connect": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/install": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/install/status": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/install/status/{job_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "job_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/installed": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/plugins/request-wccom-connect": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugins"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/shipping-partner-suggestions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no",
|
|
"in": "query",
|
|
"name": "force_default_suggestions",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping-partner-suggestions"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-admin/themes": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"pluginzip": {
|
|
"description": "A zip file of the theme to be uploaded.",
|
|
"type": "file"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/upload_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"pluginzip": {
|
|
"description": "A zip file of the theme to be uploaded.",
|
|
"type": "file"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/upload_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"pluginzip": {
|
|
"description": "A zip file of the theme to be uploaded.",
|
|
"type": "file"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/upload_theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"note_id",
|
|
"status",
|
|
"title",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Type of note.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"email",
|
|
"error",
|
|
"info",
|
|
"marketing",
|
|
"survey",
|
|
"update",
|
|
"warning"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Status of note.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"actioned",
|
|
"pending",
|
|
"sent",
|
|
"snoozed",
|
|
"unactioned"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Source of note.",
|
|
"in": "query",
|
|
"name": "source",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/delete/all": {
|
|
"delete": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"status": {
|
|
"description": "Status of note.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/delete/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "promo_note_name",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "promo_note_name",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "promo_note_name",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/tracker/{note_id}/user/{user_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "note_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/update": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/admin/notes/{note_id}/action/{action_id}": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the Note.",
|
|
"in": "path",
|
|
"name": "note_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the Note Action.",
|
|
"in": "path",
|
|
"name": "action_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the Note.",
|
|
"in": "path",
|
|
"name": "note_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the Note Action.",
|
|
"in": "path",
|
|
"name": "action_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the Note.",
|
|
"in": "path",
|
|
"name": "note_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the Note Action.",
|
|
"in": "path",
|
|
"name": "action_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/coupons": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to coupons with codes matching a given string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific code.",
|
|
"in": "query",
|
|
"name": "code",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/coupons/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/coupons/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/customers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"avg_order_value",
|
|
"city",
|
|
"country",
|
|
"date_last_active",
|
|
"date_registered",
|
|
"name",
|
|
"orders_count",
|
|
"postcode",
|
|
"state",
|
|
"total_spend",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
|
|
"in": "query",
|
|
"name": "searchby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"email",
|
|
"name",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific names.",
|
|
"in": "query",
|
|
"name": "name_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific names.",
|
|
"in": "query",
|
|
"name": "name_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific usernames.",
|
|
"in": "query",
|
|
"name": "username_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific usernames.",
|
|
"in": "query",
|
|
"name": "username_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects including emails.",
|
|
"in": "query",
|
|
"name": "email_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding emails.",
|
|
"in": "query",
|
|
"name": "email_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific countries.",
|
|
"in": "query",
|
|
"name": "country_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific countries.",
|
|
"in": "query",
|
|
"name": "country_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count greater than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count less than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count between two given integers.",
|
|
"in": "query",
|
|
"name": "orders_count_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend less than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "total_spend_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "avg_order_value_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified user IDs.",
|
|
"in": "query",
|
|
"name": "users",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Filter out results where any of the passed fields are empty",
|
|
"in": "query",
|
|
"name": "filter_empty",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"city",
|
|
"country",
|
|
"email",
|
|
"name",
|
|
"postcode",
|
|
"state"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified customer IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_customers"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/customers/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"avg_order_value",
|
|
"city",
|
|
"country",
|
|
"date_last_active",
|
|
"date_registered",
|
|
"name",
|
|
"orders_count",
|
|
"postcode",
|
|
"state",
|
|
"total_spend",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
|
|
"in": "query",
|
|
"name": "searchby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"email",
|
|
"name",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific names.",
|
|
"in": "query",
|
|
"name": "name_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific names.",
|
|
"in": "query",
|
|
"name": "name_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific usernames.",
|
|
"in": "query",
|
|
"name": "username_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific usernames.",
|
|
"in": "query",
|
|
"name": "username_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects including emails.",
|
|
"in": "query",
|
|
"name": "email_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding emails.",
|
|
"in": "query",
|
|
"name": "email_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific countries.",
|
|
"in": "query",
|
|
"name": "country_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific countries.",
|
|
"in": "query",
|
|
"name": "country_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count greater than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count less than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count between two given integers.",
|
|
"in": "query",
|
|
"name": "orders_count_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend less than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "total_spend_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "avg_order_value_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified user IDs.",
|
|
"in": "query",
|
|
"name": "users",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Filter out results where any of the passed fields are empty",
|
|
"in": "query",
|
|
"name": "filter_empty",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"city",
|
|
"country",
|
|
"email",
|
|
"name",
|
|
"postcode",
|
|
"state"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified customer IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_customers"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/data": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/data/countries": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_countries"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/data/countries/locales": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_countries"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/data/countries/{location}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "ISO3166 alpha-2 country code.",
|
|
"in": "path",
|
|
"name": "location",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_countries"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/data/download-ips": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_download_ips"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/leaderboards": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 20,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "URL query to persist across links.",
|
|
"in": "query",
|
|
"name": "persisted_query",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/leaderboard"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/leaderboards/allowed": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/leaderboard"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/leaderboards/{leaderboard}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "leaderboard",
|
|
"required": true,
|
|
"schema": {
|
|
"enum": [
|
|
"categories",
|
|
"coupons",
|
|
"customers",
|
|
"products"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 20,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "URL query to persist across links.",
|
|
"in": "query",
|
|
"name": "persisted_query",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/leaderboard"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/orders": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders which have specific statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific customer.",
|
|
"in": "query",
|
|
"name": "customer",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Only show meta which is meant to be displayed for an order.",
|
|
"in": "query",
|
|
"name": "order_item_display_meta",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders matching part of an order number.",
|
|
"in": "query",
|
|
"name": "number",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/orders/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/orders/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Search by similar product name or SKU.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"popularity",
|
|
"popularity",
|
|
"price",
|
|
"rating",
|
|
"rating",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those with a SKU that partially matches a string.",
|
|
"in": "query",
|
|
"name": "search_sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products that are low or out of stock. (Deprecated)",
|
|
"in": "query",
|
|
"name": "low_in_stock",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Search by similar attribute name.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/{attribute_id}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/{attribute_id}/terms/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/{attribute_id}/terms/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/{slug}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Slug identifier for the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/attributes/{slug}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/categories/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/categories/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/count-low-in-stock": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Count Low in Stock Items"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/low-in-stock": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/reviews": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to reviews published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"id",
|
|
"include",
|
|
"product"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews assigned to specific user IDs.",
|
|
"in": "query",
|
|
"name": "reviewer",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes reviews assigned to specific user IDs.",
|
|
"in": "query",
|
|
"name": "reviewer_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to that from a specific author email.",
|
|
"in": "query",
|
|
"name": "reviewer_email",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "email"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews assigned to specific product IDs.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"approved",
|
|
"hold",
|
|
"spam",
|
|
"trash"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product.",
|
|
"required": true,
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "Review content.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Name of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Email of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"product_id",
|
|
"review",
|
|
"reviewer",
|
|
"reviewer_email"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/reviews/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/reviews/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/suggested-products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"popularity",
|
|
"rating",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products in stock or out of stock.",
|
|
"in": "query",
|
|
"name": "in_stock",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific product categorie ids.",
|
|
"in": "query",
|
|
"name": "categories",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific product tag ids.",
|
|
"in": "query",
|
|
"name": "tags",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific amount of suggested products.",
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/{id}/duplicate": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/{product_id}/variations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Search by similar product name, SKU, or attribute value.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with or without price.",
|
|
"in": "query",
|
|
"name": "has_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute slug.",
|
|
"type": "string"
|
|
},
|
|
"term": {
|
|
"description": "Attribute term.",
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"description": "Attribute terms.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/{product_id}/variations/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/{product_id}/variations/generate": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_values": {
|
|
"description": "Default values for generated variations.",
|
|
"type": "object"
|
|
},
|
|
"delete": {
|
|
"description": "Deletes unused variations.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/products/{product_id}/variations/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product parent name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"category",
|
|
"category_id",
|
|
"items_sold",
|
|
"net_revenue",
|
|
"orders_count",
|
|
"products_count"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified order status.",
|
|
"in": "query",
|
|
"name": "status_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified order status.",
|
|
"in": "query",
|
|
"name": "status_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.",
|
|
"in": "query",
|
|
"name": "categories",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Add additional piece of info about each category to the report.",
|
|
"in": "query",
|
|
"name": "extended_info",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_categories"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/coupons": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"amount",
|
|
"code",
|
|
"coupon_id",
|
|
"orders_count"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to coupons assigned specific coupon IDs.",
|
|
"in": "query",
|
|
"name": "coupons",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Add additional piece of info about each coupon to the report.",
|
|
"in": "query",
|
|
"name": "extended_info",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_coupons"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/coupons/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"amount",
|
|
"coupons_count",
|
|
"date",
|
|
"orders_count"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to coupons assigned specific coupon IDs.",
|
|
"in": "query",
|
|
"name": "coupons",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Segment the response by additional constraint.",
|
|
"in": "query",
|
|
"name": "segmentby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"category",
|
|
"coupon",
|
|
"product",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_coupons_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/customers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"avg_order_value",
|
|
"city",
|
|
"country",
|
|
"date_last_active",
|
|
"date_registered",
|
|
"name",
|
|
"orders_count",
|
|
"postcode",
|
|
"state",
|
|
"total_spend",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
|
|
"in": "query",
|
|
"name": "searchby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"email",
|
|
"name",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific names.",
|
|
"in": "query",
|
|
"name": "name_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific names.",
|
|
"in": "query",
|
|
"name": "name_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific usernames.",
|
|
"in": "query",
|
|
"name": "username_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific usernames.",
|
|
"in": "query",
|
|
"name": "username_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects including emails.",
|
|
"in": "query",
|
|
"name": "email_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding emails.",
|
|
"in": "query",
|
|
"name": "email_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific countries.",
|
|
"in": "query",
|
|
"name": "country_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific countries.",
|
|
"in": "query",
|
|
"name": "country_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count greater than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count less than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count between two given integers.",
|
|
"in": "query",
|
|
"name": "orders_count_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend less than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "total_spend_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "avg_order_value_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified customer IDs.",
|
|
"in": "query",
|
|
"name": "customers",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified user IDs.",
|
|
"in": "query",
|
|
"name": "users",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Filter out results where any of the passed fields are empty",
|
|
"in": "query",
|
|
"name": "filter_empty",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"city",
|
|
"country",
|
|
"email",
|
|
"name",
|
|
"postcode",
|
|
"state"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_customers"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/customers/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit results with `search` and `searchby` to specific fields containing the search term.",
|
|
"in": "query",
|
|
"name": "searchby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"email",
|
|
"name",
|
|
"username"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific names.",
|
|
"in": "query",
|
|
"name": "name_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific names.",
|
|
"in": "query",
|
|
"name": "name_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific usernames.",
|
|
"in": "query",
|
|
"name": "username_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific usernames.",
|
|
"in": "query",
|
|
"name": "username_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects including emails.",
|
|
"in": "query",
|
|
"name": "email_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding emails.",
|
|
"in": "query",
|
|
"name": "email_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with specific countries.",
|
|
"in": "query",
|
|
"name": "country_includes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects excluding specific countries.",
|
|
"in": "query",
|
|
"name": "country_excludes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_active_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects last active between two given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "registered_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count greater than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count less than or equal to given integer.",
|
|
"in": "query",
|
|
"name": "orders_count_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an order count between two given integers.",
|
|
"in": "query",
|
|
"name": "orders_count_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend less than or equal to given number.",
|
|
"in": "query",
|
|
"name": "total_spend_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with a total order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "total_spend_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend greater than or equal to given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_min",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend less than or equal to a given number.",
|
|
"in": "query",
|
|
"name": "avg_order_value_max",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with an average order spend between two given numbers.",
|
|
"in": "query",
|
|
"name": "avg_order_value_between",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.",
|
|
"in": "query",
|
|
"name": "last_order_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified customer IDs.",
|
|
"in": "query",
|
|
"name": "customers",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_customers_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/downloads": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"product"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: products, orders, username, ip_address.",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified order IDs.",
|
|
"in": "query",
|
|
"name": "order_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified order IDs.",
|
|
"in": "query",
|
|
"name": "order_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that have the specified user IDs.",
|
|
"in": "query",
|
|
"name": "customer_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that don't have the specified user IDs.",
|
|
"in": "query",
|
|
"name": "customer_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that have a specified IP address.",
|
|
"in": "query",
|
|
"name": "ip_address_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that don't have a specified IP address.",
|
|
"in": "query",
|
|
"name": "ip_address_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_downloads"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/downloads/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"download_count"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified order IDs.",
|
|
"in": "query",
|
|
"name": "order_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified order IDs.",
|
|
"in": "query",
|
|
"name": "order_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that have the specified customer IDs.",
|
|
"in": "query",
|
|
"name": "customer_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that don't have the specified customer IDs.",
|
|
"in": "query",
|
|
"name": "customer_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that have a specified IP address.",
|
|
"in": "query",
|
|
"name": "ip_address_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to objects that don't have a specified IP address.",
|
|
"in": "query",
|
|
"name": "ip_address_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_orders_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/import": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"days": {
|
|
"description": "Number of days to import.",
|
|
"type": "integer"
|
|
},
|
|
"skip_existing": {
|
|
"description": "Skip importing existing order data.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"days": {
|
|
"description": "Number of days to import.",
|
|
"type": "integer"
|
|
},
|
|
"skip_existing": {
|
|
"description": "Skip importing existing order data.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"days": {
|
|
"description": "Number of days to import.",
|
|
"type": "integer"
|
|
},
|
|
"skip_existing": {
|
|
"description": "Skip importing existing order data.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/import/cancel": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/import/delete": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/import/status": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/import/totals": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Number of days to import.",
|
|
"in": "query",
|
|
"name": "days",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Skip importing existing order data.",
|
|
"in": "query",
|
|
"name": "skip_existing",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_import"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/orders": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"net_total",
|
|
"num_items_sold"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified variation(s) assigned.",
|
|
"in": "query",
|
|
"name": "variation_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified variation(s) assigned.",
|
|
"in": "query",
|
|
"name": "variation_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified coupon(s) assigned.",
|
|
"in": "query",
|
|
"name": "coupon_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified coupon(s) assigned.",
|
|
"in": "query",
|
|
"name": "coupon_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified tax rate(s) assigned.",
|
|
"in": "query",
|
|
"name": "tax_rate_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified tax rate(s) assigned.",
|
|
"in": "query",
|
|
"name": "tax_rate_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified order status.",
|
|
"in": "query",
|
|
"name": "status_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified order status.",
|
|
"in": "query",
|
|
"name": "status_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to returning or new customers.",
|
|
"in": "query",
|
|
"name": "customer_type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"",
|
|
"new",
|
|
"returning"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific types of refunds.",
|
|
"in": "query",
|
|
"name": "refunds",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"",
|
|
"all",
|
|
"full",
|
|
"none",
|
|
"partial"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Add additional piece of info about each coupon to the report.",
|
|
"in": "query",
|
|
"name": "extended_info",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified order IDs.",
|
|
"in": "query",
|
|
"name": "order_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified order IDs.",
|
|
"in": "query",
|
|
"name": "order_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that include products with the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that don't include products with the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_orders"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/orders/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"avg_order_value",
|
|
"date",
|
|
"net_revenue",
|
|
"orders_count"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified order status.",
|
|
"in": "query",
|
|
"name": "status_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified order status.",
|
|
"in": "query",
|
|
"name": "status_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified product(s) assigned.",
|
|
"in": "query",
|
|
"name": "product_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified variation(s) assigned.",
|
|
"in": "query",
|
|
"name": "variation_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified variation(s) assigned.",
|
|
"in": "query",
|
|
"name": "variation_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified coupon(s) assigned.",
|
|
"in": "query",
|
|
"name": "coupon_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified coupon(s) assigned.",
|
|
"in": "query",
|
|
"name": "coupon_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified tax rate(s) assigned.",
|
|
"in": "query",
|
|
"name": "tax_rate_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified tax rate(s) assigned.",
|
|
"in": "query",
|
|
"name": "tax_rate_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Alias for customer_type (deprecated).",
|
|
"in": "query",
|
|
"name": "customer",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"new",
|
|
"returning"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that have the specified customer_type",
|
|
"in": "query",
|
|
"name": "customer_type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"new",
|
|
"returning"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific types of refunds.",
|
|
"in": "query",
|
|
"name": "refunds",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"",
|
|
"all",
|
|
"full",
|
|
"none",
|
|
"partial"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that include products with the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that don't include products with the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Segment the response by additional constraint.",
|
|
"in": "query",
|
|
"name": "segmentby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"category",
|
|
"coupon",
|
|
"customer_type",
|
|
"product",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_orders_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/performance-indicators": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.",
|
|
"in": "query",
|
|
"name": "stats",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"coupons/amount",
|
|
"coupons/orders_count",
|
|
"downloads/download_count",
|
|
"orders/avg_order_value",
|
|
"orders/orders_count",
|
|
"products/items_sold",
|
|
"revenue/gross_sales",
|
|
"revenue/net_revenue",
|
|
"revenue/refunds",
|
|
"revenue/shipping",
|
|
"revenue/total_sales",
|
|
"taxes/order_tax",
|
|
"taxes/shipping_tax",
|
|
"taxes/total_tax",
|
|
"variations/items_sold"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_performance_indicator"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/performance-indicators/allowed": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to specific report stats. Allowed values: revenue/total_sales, revenue/net_revenue, revenue/shipping, revenue/refunds, revenue/gross_sales, orders/orders_count, orders/avg_order_value, products/items_sold, variations/items_sold, coupons/amount, coupons/orders_count, taxes/total_tax, taxes/order_tax, taxes/shipping_tax, downloads/download_count.",
|
|
"in": "query",
|
|
"name": "stats",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"coupons/amount",
|
|
"coupons/orders_count",
|
|
"downloads/download_count",
|
|
"orders/avg_order_value",
|
|
"orders/orders_count",
|
|
"products/items_sold",
|
|
"revenue/gross_sales",
|
|
"revenue/net_revenue",
|
|
"revenue/refunds",
|
|
"revenue/shipping",
|
|
"revenue/total_sales",
|
|
"taxes/order_tax",
|
|
"taxes/shipping_tax",
|
|
"taxes/total_tax",
|
|
"variations/items_sold"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_performance_indicator"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"items_sold",
|
|
"net_revenue",
|
|
"orders_count",
|
|
"product_name",
|
|
"sku",
|
|
"variations"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result to items from the specified categories.",
|
|
"in": "query",
|
|
"name": "categories",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified product IDs.",
|
|
"in": "query",
|
|
"name": "products",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Add additional piece of info about each product to the report.",
|
|
"in": "query",
|
|
"name": "extended_info",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_products"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/products/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"coupons",
|
|
"date",
|
|
"items_sold",
|
|
"net_revenue",
|
|
"net_revenue",
|
|
"orders_count",
|
|
"refunds",
|
|
"shipping",
|
|
"taxes"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items from the specified categories.",
|
|
"in": "query",
|
|
"name": "categories",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified product IDs.",
|
|
"in": "query",
|
|
"name": "products",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified variation IDs.",
|
|
"in": "query",
|
|
"name": "variations",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Segment the response by additional constraint.",
|
|
"in": "query",
|
|
"name": "segmentby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"category",
|
|
"product",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_products_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/revenue/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"coupons",
|
|
"date",
|
|
"gross_sales",
|
|
"items_sold",
|
|
"net_revenue",
|
|
"orders_count",
|
|
"refunds",
|
|
"shipping",
|
|
"taxes",
|
|
"total_sales"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Segment the response by additional constraint.",
|
|
"in": "query",
|
|
"name": "segmentby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"category",
|
|
"coupon",
|
|
"customer_type",
|
|
"product",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.",
|
|
"in": "query",
|
|
"name": "date_type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date_completed",
|
|
"date_created",
|
|
"date_paid"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_revenue_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/stock": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"sku",
|
|
"stock_quantity",
|
|
"stock_status",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items assigned a stock report type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"instock",
|
|
"lowstock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_stock"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/stock/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_customers_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/taxes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"name",
|
|
"order_tax",
|
|
"orders_count",
|
|
"rate",
|
|
"shipping_tax",
|
|
"tax_code",
|
|
"tax_rate_id",
|
|
"total_tax"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to items assigned one or more tax rates.",
|
|
"in": "query",
|
|
"name": "taxes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_taxes"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/taxes/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"items_sold",
|
|
"orders_count",
|
|
"products_count",
|
|
"total_sales"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.",
|
|
"in": "query",
|
|
"name": "taxes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Segment the response by additional constraint.",
|
|
"in": "query",
|
|
"name": "segmentby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"tax_rate_id"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_taxes_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/variations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"items_sold",
|
|
"net_revenue",
|
|
"orders_count",
|
|
"sku"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified parent product(s).",
|
|
"in": "query",
|
|
"name": "product_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified parent product(s).",
|
|
"in": "query",
|
|
"name": "product_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified variation IDs.",
|
|
"in": "query",
|
|
"name": "variations",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Add additional piece of info about each variation to the report.",
|
|
"in": "query",
|
|
"name": "extended_info",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to variations that include the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to variations that don't include the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to variations in the specified categories.",
|
|
"in": "query",
|
|
"name": "category_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to variations not in the specified categories.",
|
|
"in": "query",
|
|
"name": "category_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified product IDs.",
|
|
"in": "query",
|
|
"name": "products",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_varitations"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/variations/stats": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"coupons",
|
|
"date",
|
|
"items_sold",
|
|
"net_revenue",
|
|
"net_revenue",
|
|
"orders_count",
|
|
"refunds",
|
|
"shipping",
|
|
"taxes"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Force retrieval of fresh data instead of from the cache.",
|
|
"in": "query",
|
|
"name": "force_cache_refresh",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Time interval to use for buckets in the returned data.",
|
|
"in": "query",
|
|
"name": "interval",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"day",
|
|
"hour",
|
|
"month",
|
|
"quarter",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Indicates whether all the conditions should be true for the resulting set, or if any one of them is sufficient. Match affects the following parameters: status_is, status_is_not, product_includes, product_excludes, coupon_includes, coupon_excludes, customer, categories",
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items from the specified categories.",
|
|
"in": "query",
|
|
"name": "category_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to variations not in the specified categories.",
|
|
"in": "query",
|
|
"name": "category_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified parent product(s).",
|
|
"in": "query",
|
|
"name": "product_includes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that don't have the specified parent product(s).",
|
|
"in": "query",
|
|
"name": "product_excludes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to items with specified variation IDs.",
|
|
"in": "query",
|
|
"name": "variations",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Segment the response by additional constraint.",
|
|
"in": "query",
|
|
"name": "segmentby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"category",
|
|
"product",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit stats fields to the specified items.",
|
|
"in": "query",
|
|
"name": "fields",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that include products with the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders that don't include products with the specified attributes.",
|
|
"in": "query",
|
|
"name": "attribute_is_not",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_variations_stats"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/{type}/export": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"email": {
|
|
"description": "When true, email a link to download the export to the requesting user.",
|
|
"type": "boolean"
|
|
},
|
|
"report_args": {
|
|
"description": "Parameters to pass on to the exported report.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_export"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"email": {
|
|
"description": "When true, email a link to download the export to the requesting user.",
|
|
"type": "boolean"
|
|
},
|
|
"report_args": {
|
|
"description": "Parameters to pass on to the exported report.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_export"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"email": {
|
|
"description": "When true, email a link to download the export to the requesting user.",
|
|
"type": "boolean"
|
|
},
|
|
"report_args": {
|
|
"description": "Parameters to pass on to the exported report.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_export"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/reports/{type}/export/{export_id}/status": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "export_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_export_status"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/settings/{group_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Settings group ID.",
|
|
"in": "query",
|
|
"name": "group",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/settings/{group_id}/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/settings/{group_id}/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Settings group ID.",
|
|
"in": "query",
|
|
"name": "group",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/taxes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"order",
|
|
"priority"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by tax class.",
|
|
"in": "query",
|
|
"name": "class",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"reduced-rate",
|
|
"standard",
|
|
"zero-rate"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Search by similar tax code.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that have the specified rate ID(s) assigned.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/taxes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/taxes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-analytics/variations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Search by similar product name, SKU, or attribute value.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with or without price.",
|
|
"in": "query",
|
|
"name": "has_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute slug.",
|
|
"type": "string"
|
|
},
|
|
"term": {
|
|
"description": "Attribute term.",
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"description": "Attribute terms.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-telemetry": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc-telemetry/tracker": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"installation_date": {
|
|
"description": "Installation date of the WooCommerce mobile app.",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
"platform": {
|
|
"description": "Platform to track.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"description": "Platform version to track.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"platform",
|
|
"version"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/business-description": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_description": {
|
|
"description": "The business description for a given store.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/business-description"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/images": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_description": {
|
|
"description": "The business description for a given store.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/images"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/patterns": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/patterns"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_description": {
|
|
"description": "The business description for a given store.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "The images for a given store.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/patterns"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/product": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"last_product": {
|
|
"description": "Whether the product being updated is the last one in the loop",
|
|
"type": "boolean"
|
|
},
|
|
"products_information": {
|
|
"description": "Data generated by AI for updating dummy products.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/products": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/products"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_description": {
|
|
"description": "The business description for a given store.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "The images for a given store.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/products"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/store-info": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/store-info"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/ai/store-title": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"business_description": {
|
|
"description": "The business description for a given store.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ai/store-title"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/private/patterns": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/patterns"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/patterns"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/batch": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"requests": {
|
|
"required": true,
|
|
"type": "array"
|
|
},
|
|
"validation": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"requests"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/add-item": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": {
|
|
"description": "The basket item product or variation ID.",
|
|
"type": "integer"
|
|
},
|
|
"quantity": {
|
|
"description": "Quantity of this item to add to the basket.",
|
|
"type": "integer"
|
|
},
|
|
"variation": {
|
|
"description": "Chosen attributes (for variations).",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/apply-coupon": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/coupons": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "The coupon's unique code.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "The discount type for the coupon (eg percentage or fixed amount)",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/coupons/{code}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/extensions": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"description": "Additional data to pass to the extension",
|
|
"type": "object"
|
|
},
|
|
"namespace": {
|
|
"description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart-extensions"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/items": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/items/{key}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/remove-coupon": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/remove-item": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"key": {
|
|
"description": "Unique identifier (key) for the basket item.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/select-shipping-rate": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"package_id": {
|
|
"description": "The ID of the package being shipped. Leave blank to apply to all packages.",
|
|
"required": false,
|
|
"type": [
|
|
"integer",
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"rate_id": {
|
|
"description": "The chosen rate ID for the package.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"rate_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/update-customer": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing_address": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_address": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/cart/update-item": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"key": {
|
|
"description": "Unique identifier (key) for the basket item to update.",
|
|
"type": "string"
|
|
},
|
|
"quantity": {
|
|
"description": "New quantity of the item in the basket.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/checkout": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/checkout"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"additional_fields": {
|
|
"description": "Additional fields to be persisted on the order.",
|
|
"type": "object"
|
|
},
|
|
"billing_address": {
|
|
"description": "Billing address.",
|
|
"required": true,
|
|
"type": "object"
|
|
},
|
|
"create_account": {
|
|
"description": "Whether to create a new user account as part of order processing.",
|
|
"type": "boolean"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note added to the order by the customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"customer_password": {
|
|
"description": "Customer password for new accounts, if applicable.",
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"type": "object"
|
|
},
|
|
"payment_data": {
|
|
"description": "Data to pass through to the payment method when processing payment.",
|
|
"type": "array"
|
|
},
|
|
"payment_method": {
|
|
"description": "The ID of the payment method being used to process the payment.",
|
|
"type": "string"
|
|
},
|
|
"shipping_address": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"billing_address"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/checkout"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/checkout/{id}": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"additional_fields": {
|
|
"description": "Additional fields to be persisted on the order.",
|
|
"type": "object"
|
|
},
|
|
"billing_address": {
|
|
"description": "Billing address.",
|
|
"required": true,
|
|
"type": "object"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note added to the order by the customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"type": "object"
|
|
},
|
|
"payment_data": {
|
|
"description": "Data to pass through to the payment method when processing payment.",
|
|
"type": "array"
|
|
},
|
|
"payment_method": {
|
|
"description": "The ID of the payment method being used to process the payment.",
|
|
"type": "string"
|
|
},
|
|
"shipping_address": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"billing_address"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/checkout-order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/order/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "When limiting response using after/before, which date column to compare against.",
|
|
"in": "query",
|
|
"name": "date_column",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"modified",
|
|
"modified_gmt"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"comment_count",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"price",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product category terms.",
|
|
"in": "query",
|
|
"name": "category_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product tags.",
|
|
"in": "query",
|
|
"name": "tag_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
],
|
|
"sanitize_callback": "sanitize_text_field",
|
|
"type": "string",
|
|
"validate_callback": "rest_validate_request_arg"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with selected global attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute taxonomy name.",
|
|
"sanitize_callback": "wc_sanitize_taxonomy_name",
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"description": "Operator to compare product attribute terms.",
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"sanitize_callback": "wp_parse_slug_list",
|
|
"type": "array"
|
|
},
|
|
"term_id": {
|
|
"description": "List of attribute term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"sanitize_callback": "wp_parse_id_list",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "The logical relationship between attributes when filtering across several at once.",
|
|
"in": "query",
|
|
"name": "attribute_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Determines if hidden or visible catalogue products are shown.",
|
|
"in": "query",
|
|
"name": "catalog_visibility",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"catalog",
|
|
"hidden",
|
|
"search",
|
|
"visible"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a certain average rating.",
|
|
"in": "query",
|
|
"name": "rating",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
1,
|
|
2,
|
|
3,
|
|
4,
|
|
5
|
|
],
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/attributes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/attributes/{attribute_id}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by term property.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"id",
|
|
"menu_order",
|
|
"name",
|
|
"name_num",
|
|
"slug"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, empty terms will not be returned.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/attributes/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by term property.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"name",
|
|
"slug"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, empty terms will not be returned.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/categories/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/collection-data": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "When limiting response using after/before, which date column to compare against.",
|
|
"in": "query",
|
|
"name": "date_column",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"modified",
|
|
"modified_gmt"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"comment_count",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"price",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product category terms.",
|
|
"in": "query",
|
|
"name": "category_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product tags.",
|
|
"in": "query",
|
|
"name": "tag_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
],
|
|
"sanitize_callback": "sanitize_text_field",
|
|
"type": "string",
|
|
"validate_callback": "rest_validate_request_arg"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with selected global attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute taxonomy name.",
|
|
"sanitize_callback": "wc_sanitize_taxonomy_name",
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"description": "Operator to compare product attribute terms.",
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"sanitize_callback": "wp_parse_slug_list",
|
|
"type": "array"
|
|
},
|
|
"term_id": {
|
|
"description": "List of attribute term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"sanitize_callback": "wp_parse_id_list",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "The logical relationship between attributes when filtering across several at once.",
|
|
"in": "query",
|
|
"name": "attribute_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Determines if hidden or visible catalogue products are shown.",
|
|
"in": "query",
|
|
"name": "catalog_visibility",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"catalog",
|
|
"hidden",
|
|
"search",
|
|
"visible"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a certain average rating.",
|
|
"in": "query",
|
|
"name": "rating",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
1,
|
|
2,
|
|
3,
|
|
4,
|
|
5
|
|
],
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, calculates the minimum and maximum product prices for the collection.",
|
|
"in": "query",
|
|
"name": "calculate_price_range",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "If true, calculates stock counts for products in the collection.",
|
|
"in": "query",
|
|
"name": "calculate_stock_status_counts",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "If requested, calculates attribute term counts for products in the collection.",
|
|
"in": "query",
|
|
"name": "calculate_attribute_counts",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"query_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".",
|
|
"enum": [
|
|
"and",
|
|
"or"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Taxonomy name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, calculates rating counts for products in the collection.",
|
|
"in": "query",
|
|
"name": "calculate_rating_counts",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-collection-data"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/reviews": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"id",
|
|
"product",
|
|
"rating"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews from specific category IDs.",
|
|
"in": "query",
|
|
"name": "category_id",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews from specific product IDs.",
|
|
"in": "query",
|
|
"name": "product_id",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/tags": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by term property.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"name",
|
|
"slug"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, empty terms will not be returned.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/products/{slug}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Slug of the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/batch": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"requests": {
|
|
"required": true,
|
|
"type": "array"
|
|
},
|
|
"validation": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"requests"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/add-item": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": {
|
|
"description": "The basket item product or variation ID.",
|
|
"type": "integer"
|
|
},
|
|
"quantity": {
|
|
"description": "Quantity of this item to add to the basket.",
|
|
"type": "integer"
|
|
},
|
|
"variation": {
|
|
"description": "Chosen attributes (for variations).",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/apply-coupon": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/coupons": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "The coupon's unique code.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "The discount type for the coupon (eg percentage or fixed amount)",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/coupons/{code}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/extensions": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"description": "Additional data to pass to the extension",
|
|
"type": "object"
|
|
},
|
|
"namespace": {
|
|
"description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart-extensions"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/items": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/items/{key}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the item within the basket.",
|
|
"in": "path",
|
|
"name": "key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"extensions": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/remove-coupon": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Unique identifier for the coupon within the basket.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/remove-item": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"key": {
|
|
"description": "Unique identifier (key) for the basket item.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/select-shipping-rate": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"package_id": {
|
|
"description": "The ID of the package being shipped. Leave blank to apply to all packages.",
|
|
"required": false,
|
|
"type": [
|
|
"integer",
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"rate_id": {
|
|
"description": "The chosen rate ID for the package.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"rate_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/update-customer": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing_address": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_address": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/cart/update-item": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"key": {
|
|
"description": "Unique identifier (key) for the basket item to update.",
|
|
"type": "string"
|
|
},
|
|
"quantity": {
|
|
"description": "New quantity of the item in the basket.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/cart"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/checkout": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/checkout"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"additional_fields": {
|
|
"description": "Additional fields to be persisted on the order.",
|
|
"type": "object"
|
|
},
|
|
"billing_address": {
|
|
"description": "Billing address.",
|
|
"required": true,
|
|
"type": "object"
|
|
},
|
|
"create_account": {
|
|
"description": "Whether to create a new user account as part of order processing.",
|
|
"type": "boolean"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note added to the order by the customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"customer_password": {
|
|
"description": "Customer password for new accounts, if applicable.",
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"type": "object"
|
|
},
|
|
"payment_data": {
|
|
"description": "Data to pass through to the payment method when processing payment.",
|
|
"type": "array"
|
|
},
|
|
"payment_method": {
|
|
"description": "The ID of the payment method being used to process the payment.",
|
|
"type": "string"
|
|
},
|
|
"shipping_address": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"billing_address"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/checkout"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/checkout/{id}": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"additional_fields": {
|
|
"description": "Additional fields to be persisted on the order.",
|
|
"type": "object"
|
|
},
|
|
"billing_address": {
|
|
"description": "Billing address.",
|
|
"required": true,
|
|
"type": "object"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note added to the order by the customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"extensions": {
|
|
"type": "object"
|
|
},
|
|
"payment_data": {
|
|
"description": "Data to pass through to the payment method when processing payment.",
|
|
"type": "array"
|
|
},
|
|
"payment_method": {
|
|
"description": "The ID of the payment method being used to process the payment.",
|
|
"type": "string"
|
|
},
|
|
"shipping_address": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"billing_address"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/checkout-order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/order/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "When limiting response using after/before, which date column to compare against.",
|
|
"in": "query",
|
|
"name": "date_column",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"modified",
|
|
"modified_gmt"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"comment_count",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"price",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product category terms.",
|
|
"in": "query",
|
|
"name": "category_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product tags.",
|
|
"in": "query",
|
|
"name": "tag_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
],
|
|
"sanitize_callback": "sanitize_text_field",
|
|
"type": "string",
|
|
"validate_callback": "rest_validate_request_arg"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with selected global attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute taxonomy name.",
|
|
"sanitize_callback": "wc_sanitize_taxonomy_name",
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"description": "Operator to compare product attribute terms.",
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"sanitize_callback": "wp_parse_slug_list",
|
|
"type": "array"
|
|
},
|
|
"term_id": {
|
|
"description": "List of attribute term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"sanitize_callback": "wp_parse_id_list",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "The logical relationship between attributes when filtering across several at once.",
|
|
"in": "query",
|
|
"name": "attribute_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Determines if hidden or visible catalogue products are shown.",
|
|
"in": "query",
|
|
"name": "catalog_visibility",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"catalog",
|
|
"hidden",
|
|
"search",
|
|
"visible"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a certain average rating.",
|
|
"in": "query",
|
|
"name": "rating",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
1,
|
|
2,
|
|
3,
|
|
4,
|
|
5
|
|
],
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/attributes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/attributes/{attribute_id}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by term property.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"id",
|
|
"menu_order",
|
|
"name",
|
|
"name_num",
|
|
"slug"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, empty terms will not be returned.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/attributes/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by term property.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"name",
|
|
"slug"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, empty terms will not be returned.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/categories/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/collection-data": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific slug(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources created before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "When limiting response using after/before, which date column to compare against.",
|
|
"in": "query",
|
|
"name": "date_column",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"modified",
|
|
"modified_gmt"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"comment_count",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"price",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable",
|
|
"variation"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product category terms.",
|
|
"in": "query",
|
|
"name": "category_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Operator to compare product tags.",
|
|
"in": "query",
|
|
"name": "tag_operator",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
],
|
|
"sanitize_callback": "sanitize_text_field",
|
|
"type": "string",
|
|
"validate_callback": "rest_validate_request_arg"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with selected global attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute taxonomy name.",
|
|
"sanitize_callback": "wc_sanitize_taxonomy_name",
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"description": "Operator to compare product attribute terms.",
|
|
"enum": [
|
|
"and",
|
|
"in",
|
|
"not_in"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "List of attribute slug(s). If a term ID is provided, this will be ignored.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"sanitize_callback": "wp_parse_slug_list",
|
|
"type": "array"
|
|
},
|
|
"term_id": {
|
|
"description": "List of attribute term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"sanitize_callback": "wp_parse_id_list",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "The logical relationship between attributes when filtering across several at once.",
|
|
"in": "query",
|
|
"name": "attribute_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"and",
|
|
"in"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Determines if hidden or visible catalogue products are shown.",
|
|
"in": "query",
|
|
"name": "catalog_visibility",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"catalog",
|
|
"hidden",
|
|
"search",
|
|
"visible"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a certain average rating.",
|
|
"in": "query",
|
|
"name": "rating",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
1,
|
|
2,
|
|
3,
|
|
4,
|
|
5
|
|
],
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, calculates the minimum and maximum product prices for the collection.",
|
|
"in": "query",
|
|
"name": "calculate_price_range",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "If true, calculates stock counts for products in the collection.",
|
|
"in": "query",
|
|
"name": "calculate_stock_status_counts",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "If requested, calculates attribute term counts for products in the collection.",
|
|
"in": "query",
|
|
"name": "calculate_attribute_counts",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"query_type": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".",
|
|
"enum": [
|
|
"and",
|
|
"or"
|
|
],
|
|
"readonly": true,
|
|
"type": "string"
|
|
},
|
|
"taxonomy": {
|
|
"context": [
|
|
"edit",
|
|
"view"
|
|
],
|
|
"description": "Taxonomy name.",
|
|
"readonly": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, calculates rating counts for products in the collection.",
|
|
"in": "query",
|
|
"name": "calculate_rating_counts",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-collection-data"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/reviews": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"id",
|
|
"product",
|
|
"rating"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews from specific category IDs.",
|
|
"in": "query",
|
|
"name": "category_id",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews from specific product IDs.",
|
|
"in": "query",
|
|
"name": "product_id",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/tags": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 0
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by term property.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"name",
|
|
"slug"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "If true, empty terms will not be returned.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/store/v1/products/{slug}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Slug of the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/coupons": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
|
|
"in": "query",
|
|
"name": "filter",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific code.",
|
|
"in": "query",
|
|
"name": "code",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/coupons/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/coupons/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"expiry_date": {
|
|
"description": "UTC DateTime when the coupon expires.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/customers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"registered_date"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific email.",
|
|
"in": "query",
|
|
"name": "email",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "email"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific role.",
|
|
"in": "query",
|
|
"name": "role",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"administrator",
|
|
"all",
|
|
"author",
|
|
"contributor",
|
|
"customer",
|
|
"editor",
|
|
"shop_manager",
|
|
"subscriber"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "New user email address.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "New user password.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "New user username.",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"password"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/customers/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/customers/{customer_id}/downloads": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "customer_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer_download"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/customers/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
},
|
|
"reassign": {
|
|
"description": "ID to reassign posts to.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
|
|
"in": "query",
|
|
"name": "filter",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific customer.",
|
|
"in": "query",
|
|
"name": "customer",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders/{order_id}/notes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"customer_note": {
|
|
"description": "Shows/define if the note is only for reference or for the customer (the user will be notified).",
|
|
"type": "boolean"
|
|
},
|
|
"note": {
|
|
"description": "Order note content.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders/{order_id}/notes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders/{order_id}/refunds": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
|
|
"in": "query",
|
|
"name": "filter",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific customer.",
|
|
"in": "query",
|
|
"name": "customer",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "Refund amount.",
|
|
"type": "string"
|
|
},
|
|
"reason": {
|
|
"description": "Reason for refund.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/orders/{order_id}/refunds/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.",
|
|
"in": "query",
|
|
"name": "filter",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific SKU.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/attributes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/attributes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/attributes/{attribute_id}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/attributes/{attribute_id}/terms/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/attributes/{attribute_id}/terms/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/attributes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/categories/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/categories/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/shipping_classes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/shipping_classes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/shipping_classes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/tags": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/tags/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/tags/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End data of sale price.",
|
|
"type": "string"
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"download_type": {
|
|
"description": "Download type, this controls the schema on the front-end.",
|
|
"type": "string"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"variations": {
|
|
"description": "List of variations.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/{product_id}/reviews": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "query",
|
|
"name": "id",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Email of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "Unique identifier for the variation.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "Review content.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"name",
|
|
"review"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/products/{product_id}/reviews/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/reports": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/reports/sales": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Report period.",
|
|
"in": "query",
|
|
"name": "period",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"last_month",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_min",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_max",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sales_report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/reports/top_sellers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Report period.",
|
|
"in": "query",
|
|
"name": "period",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"last_month",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_min",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_max",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/top_sellers_report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/taxes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"order",
|
|
"priority"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by tax class.",
|
|
"in": "query",
|
|
"name": "class",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"reduced-rate",
|
|
"standard",
|
|
"zero-rate"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/taxes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/taxes/classes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Tax class name.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/taxes/classes/{slug}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique slug for the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/taxes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/webhooks": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to webhooks assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"active",
|
|
"all",
|
|
"disabled",
|
|
"paused"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"delivery_url": {
|
|
"description": "Webhook delivery URL.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"delivery_url",
|
|
"topic"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/webhooks/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/webhooks/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/webhooks/{webhook_id}/deliveries": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the webhook.",
|
|
"in": "path",
|
|
"name": "webhook_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook_delivery"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v1/webhooks/{webhook_id}/deliveries/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the webhook.",
|
|
"in": "path",
|
|
"name": "webhook_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook_delivery"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/coupons": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific code.",
|
|
"in": "query",
|
|
"name": "code",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/coupons/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/coupons/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/customers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"registered_date"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific email.",
|
|
"in": "query",
|
|
"name": "email",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "email"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific role.",
|
|
"in": "query",
|
|
"name": "role",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"administrator",
|
|
"all",
|
|
"author",
|
|
"contributor",
|
|
"customer",
|
|
"editor",
|
|
"shop_manager",
|
|
"subscriber"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "New user email address.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "New user password.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "New user username.",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"password"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/customers/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/customers/{customer_id}/downloads": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "customer_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer_download"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/customers/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
},
|
|
"reassign": {
|
|
"description": "ID to reassign posts to.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific customer.",
|
|
"in": "query",
|
|
"name": "customer",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Only show meta which is meant to be displayed for an order.",
|
|
"in": "query",
|
|
"name": "order_item_display_meta",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders/{order_id}/notes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to customers or internal notes.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"customer",
|
|
"internal"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"customer_note": {
|
|
"description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.",
|
|
"type": "boolean"
|
|
},
|
|
"note": {
|
|
"description": "Order note content.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders/{order_id}/notes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders/{order_id}/refunds": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Only show meta which is meant to be displayed for an order.",
|
|
"in": "query",
|
|
"name": "order_item_display_meta",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "Refund amount.",
|
|
"type": "string"
|
|
},
|
|
"api_refund": {
|
|
"description": "When true, the payment gateway API is used to generate the refund.",
|
|
"type": "boolean"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"reason": {
|
|
"description": "Reason for refund.",
|
|
"type": "string"
|
|
},
|
|
"refunded_by": {
|
|
"description": "User ID of user who created the refund.",
|
|
"type": "integer"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/orders/{order_id}/refunds/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/payment_gateways": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/payment_gateways/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Payment gateway settings.",
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Payment gateway settings.",
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Payment gateway settings.",
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"popularity",
|
|
"rating",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products in stock or out of stock.",
|
|
"in": "query",
|
|
"name": "in_stock",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/attributes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/attributes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/attributes/{attribute_id}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/attributes/{attribute_id}/terms/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/attributes/{attribute_id}/terms/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/attributes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/categories/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/categories/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/shipping_classes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/shipping_classes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/shipping_classes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/tags": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/tags/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/tags/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"grouped_products": {
|
|
"description": "List of grouped products ID.",
|
|
"type": "array"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{product_id}/reviews": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "query",
|
|
"name": "id",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Email of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "Unique identifier for the variation.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "Review content.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"name",
|
|
"review"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{product_id}/reviews/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{product_id}/reviews/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_created": {
|
|
"description": "The date the review was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the review was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{product_id}/variations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products in stock or out of stock.",
|
|
"in": "query",
|
|
"name": "in_stock",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{product_id}/variations/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/products/{product_id}/variations/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"in_stock": {
|
|
"description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.",
|
|
"type": "boolean"
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Unique identifier.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"visible": {
|
|
"description": "Define if the variation is visible on the product's page.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/reports": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/reports/sales": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Report period.",
|
|
"in": "query",
|
|
"name": "period",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"last_month",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_min",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_max",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sales_report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/reports/top_sellers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Report period.",
|
|
"in": "query",
|
|
"name": "period",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"last_month",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_min",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_max",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/top_sellers_report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/settings": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting_group"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/settings/{group_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Settings group ID.",
|
|
"in": "query",
|
|
"name": "group",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/settings/{group_id}/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/settings/{group_id}/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Settings group ID.",
|
|
"in": "query",
|
|
"name": "group",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping/zones": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping/zones/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping/zones/{id}/locations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Shipping zone location type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Shipping zone location type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Shipping zone location type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping/zones/{zone_id}/methods": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"method_id": {
|
|
"description": "Shipping method ID.",
|
|
"required": true
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"method_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping/zones/{zone_id}/methods/{instance_id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping_methods": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/shipping_methods/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/system_status": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/system_status/tools": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/system_status/tools/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "A unique identifier for the tool.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "A unique identifier for the tool.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "A unique identifier for the tool.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/taxes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"order",
|
|
"priority"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by tax class.",
|
|
"in": "query",
|
|
"name": "class",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"reduced-rate",
|
|
"standard",
|
|
"zero-rate"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/taxes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/taxes/classes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Tax class name.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/taxes/classes/{slug}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique slug for the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique slug for the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/taxes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"city": {
|
|
"description": "City name.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode / ZIP.",
|
|
"type": "string"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/webhooks": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to webhooks assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"active",
|
|
"all",
|
|
"disabled",
|
|
"paused"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"delivery_url": {
|
|
"description": "Webhook delivery URL.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"delivery_url",
|
|
"topic"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/webhooks/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/webhooks/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/webhooks/{webhook_id}/deliveries": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the webhook.",
|
|
"in": "path",
|
|
"name": "webhook_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook_delivery"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v2/webhooks/{webhook_id}/deliveries/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the webhook.",
|
|
"in": "path",
|
|
"name": "webhook_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook_delivery"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/coupons": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific code.",
|
|
"in": "query",
|
|
"name": "code",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/coupons/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/coupons/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"description": "Coupon code.",
|
|
"type": "string"
|
|
},
|
|
"date_expires": {
|
|
"description": "The date the coupon expires, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_expires_gmt": {
|
|
"description": "The date the coupon expires, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Coupon description.",
|
|
"type": "string"
|
|
},
|
|
"discount_type": {
|
|
"description": "Determines the type of discount that will be applied.",
|
|
"type": "string"
|
|
},
|
|
"email_restrictions": {
|
|
"description": "List of email addresses that can use this coupon.",
|
|
"type": "array"
|
|
},
|
|
"exclude_sale_items": {
|
|
"description": "If true, this coupon will not be applied to items that have sale prices.",
|
|
"type": "boolean"
|
|
},
|
|
"excluded_product_categories": {
|
|
"description": "List of category IDs the coupon does not apply to.",
|
|
"type": "array"
|
|
},
|
|
"excluded_product_ids": {
|
|
"description": "List of product IDs the coupon cannot be used on.",
|
|
"type": "array"
|
|
},
|
|
"free_shipping": {
|
|
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"individual_use": {
|
|
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
|
|
"type": "boolean"
|
|
},
|
|
"limit_usage_to_x_items": {
|
|
"description": "Max number of items in the basket the coupon can be applied to.",
|
|
"type": "integer"
|
|
},
|
|
"maximum_amount": {
|
|
"description": "Maximum order amount allowed when using the coupon.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"minimum_amount": {
|
|
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
|
|
"type": "string"
|
|
},
|
|
"product_categories": {
|
|
"description": "List of category IDs the coupon applies to.",
|
|
"type": "array"
|
|
},
|
|
"product_ids": {
|
|
"description": "List of product IDs the coupon can be used on.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "The status of the coupon. Should always be draft, published, or pending review",
|
|
"type": "string"
|
|
},
|
|
"usage_limit": {
|
|
"description": "How many times the coupon can be used in total.",
|
|
"type": "integer"
|
|
},
|
|
"usage_limit_per_user": {
|
|
"description": "How many times the coupon can be used per customer.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_coupon"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/customers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"registered_date"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific email.",
|
|
"in": "query",
|
|
"name": "email",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "email"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific role.",
|
|
"in": "query",
|
|
"name": "role",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"administrator",
|
|
"all",
|
|
"author",
|
|
"contributor",
|
|
"customer",
|
|
"editor",
|
|
"shop_manager",
|
|
"subscriber"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "New user email address.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "New user password.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "New user username.",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"password"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/customers/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/customers/{customer_id}/downloads": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "customer_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer_download"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/customers/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
},
|
|
"reassign": {
|
|
"description": "ID to reassign posts to.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "List of billing address data.",
|
|
"type": "object"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the customer.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "Customer first name.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Customer last name.",
|
|
"type": "string"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"description": "Customer password.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "List of shipping address data.",
|
|
"type": "object"
|
|
},
|
|
"username": {
|
|
"description": "Customer login name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/customer"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_index"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/continents": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_continents"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/continents/{location}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "2 character continent code.",
|
|
"in": "query",
|
|
"name": "continent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "location",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_continents"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/countries": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_countries"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/countries/{location}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "ISO3166 alpha-2 country code.",
|
|
"in": "path",
|
|
"name": "location",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_countries"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/currencies": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_currencies"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/currencies/current": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_currencies"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/data/currencies/{currency}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "ISO4217 currency code.",
|
|
"in": "query",
|
|
"name": "location",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "currency",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/data_currencies"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/layout-templates": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Area to get templates for.",
|
|
"in": "query",
|
|
"name": "area",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/layout-templates/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/create-order": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"required": true
|
|
}
|
|
},
|
|
"required": [
|
|
"product_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/featured": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/refresh": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/subscriptions": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/subscriptions/activate": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_key": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"product_key"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/subscriptions/connect": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_key": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"product_key"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/subscriptions/disconnect": {
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_key": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"product_key"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/marketplace/subscriptions/install-url": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "product_key",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders which have specific statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"cancelled",
|
|
"checkout-draft",
|
|
"completed",
|
|
"failed",
|
|
"on-hold",
|
|
"pending",
|
|
"processing",
|
|
"refunded",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific customer.",
|
|
"in": "query",
|
|
"name": "customer",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to orders assigned a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Only show meta which is meant to be displayed for an order.",
|
|
"in": "query",
|
|
"name": "order_item_display_meta",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"billing": {
|
|
"description": "Billing address.",
|
|
"type": "object"
|
|
},
|
|
"coupon_lines": {
|
|
"description": "Coupons line data.",
|
|
"type": "array"
|
|
},
|
|
"currency": {
|
|
"description": "Currency the order was created with, in ISO format.",
|
|
"type": "string"
|
|
},
|
|
"customer_id": {
|
|
"description": "User ID who owns the order. 0 for guests.",
|
|
"type": "integer"
|
|
},
|
|
"customer_note": {
|
|
"description": "Note left by customer during checkout.",
|
|
"type": "string"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"line_items": {
|
|
"description": "Line items data.",
|
|
"type": "array"
|
|
},
|
|
"manual_update": {
|
|
"description": "Set the action as manual so that the order note registers as \"added by user\".",
|
|
"type": "boolean"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"parent_id": {
|
|
"description": "Parent order ID.",
|
|
"type": "integer"
|
|
},
|
|
"payment_method": {
|
|
"description": "Payment method ID.",
|
|
"type": "string"
|
|
},
|
|
"payment_method_title": {
|
|
"description": "Payment method title.",
|
|
"type": "string"
|
|
},
|
|
"set_paid": {
|
|
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
|
|
"type": "boolean"
|
|
},
|
|
"shipping": {
|
|
"description": "Shipping address.",
|
|
"type": "object"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
},
|
|
"status": {
|
|
"description": "Order status.",
|
|
"type": "string"
|
|
},
|
|
"transaction_id": {
|
|
"description": "Unique transaction ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/{id}/receipt": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier of the order.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier of the order.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"expiration_date": {
|
|
"description": "Expiration date formatted as dd-mm-yyyy.",
|
|
"type": "string"
|
|
},
|
|
"expiration_days": {
|
|
"description": "Number of days to be added to the current date to get the expiration date.",
|
|
"type": "integer"
|
|
},
|
|
"force_new": {
|
|
"description": "True to force the creation of a new receipt even if one already exists and has not expired yet.",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/{order_id}/notes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result to customers or internal notes.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"customer",
|
|
"internal"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"added_by_user": {
|
|
"description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.",
|
|
"type": "boolean"
|
|
},
|
|
"customer_note": {
|
|
"description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.",
|
|
"type": "boolean"
|
|
},
|
|
"note": {
|
|
"description": "Order note content.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/{order_id}/notes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/order_note"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/{order_id}/refunds": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Only show meta which is meant to be displayed for an order.",
|
|
"in": "query",
|
|
"name": "order_item_display_meta",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"amount": {
|
|
"description": "Refund amount.",
|
|
"type": "string"
|
|
},
|
|
"api_refund": {
|
|
"description": "When true, the payment gateway API is used to generate the refund.",
|
|
"type": "boolean"
|
|
},
|
|
"api_restock": {
|
|
"description": "When true, refunded items are restocked.",
|
|
"type": "boolean"
|
|
},
|
|
"fee_lines": {
|
|
"description": "Fee lines data.",
|
|
"type": "array"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"reason": {
|
|
"description": "Reason for refund.",
|
|
"type": "string"
|
|
},
|
|
"refunded_by": {
|
|
"description": "User ID of user who created the refund.",
|
|
"type": "integer"
|
|
},
|
|
"shipping_lines": {
|
|
"description": "Shipping lines data.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/orders/{order_id}/refunds/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The order ID.",
|
|
"in": "path",
|
|
"name": "order_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/payment_gateways": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/payment_gateways/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Payment gateway settings.",
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Payment gateway settings.",
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Payment gateway description on checkout.",
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"description": "Payment gateway enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Payment gateway sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Payment gateway settings.",
|
|
"type": "object"
|
|
},
|
|
"title": {
|
|
"description": "Payment gateway title on checkout.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/payment_gateway"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"popularity",
|
|
"popularity",
|
|
"price",
|
|
"rating",
|
|
"rating",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those with a SKU that partially matches a string.",
|
|
"in": "query",
|
|
"name": "search_sku",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/attributes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/attributes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/attributes/{attribute_id}/terms": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/attributes/{attribute_id}/terms/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/attributes/{attribute_id}/terms/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the attribute of the terms.",
|
|
"in": "path",
|
|
"name": "attribute_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Term name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute_term"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/attributes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"has_archives": {
|
|
"description": "Enable/Disable attribute archives.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Attribute name.",
|
|
"type": "string"
|
|
},
|
|
"order_by": {
|
|
"description": "Default sort order.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Type of attribute.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_attribute"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/categories/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/categories/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"display": {
|
|
"description": "Category archive display type.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Image data.",
|
|
"type": "object"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort the resource.",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"description": "Category name.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the resource.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/custom-fields/names": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort items ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/reviews": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to reviews published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"id",
|
|
"include",
|
|
"product"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews assigned to specific user IDs.",
|
|
"in": "query",
|
|
"name": "reviewer",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes reviews assigned to specific user IDs.",
|
|
"in": "query",
|
|
"name": "reviewer_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to that from a specific author email.",
|
|
"in": "query",
|
|
"name": "reviewer_email",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "email"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews assigned to specific product IDs.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to reviews assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"approved",
|
|
"hold",
|
|
"spam",
|
|
"trash"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product.",
|
|
"required": true,
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "Review content.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Name of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Email of the reviewer.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"product_id",
|
|
"review",
|
|
"reviewer",
|
|
"reviewer_email"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/reviews/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/reviews/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"product_id": {
|
|
"description": "Unique identifier for the product that the review belongs to.",
|
|
"type": "integer"
|
|
},
|
|
"product_name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"rating": {
|
|
"description": "Review rating (0 to 5).",
|
|
"type": "integer"
|
|
},
|
|
"review": {
|
|
"description": "The content of the review.",
|
|
"type": "string"
|
|
},
|
|
"reviewer": {
|
|
"description": "Reviewer name.",
|
|
"type": "string"
|
|
},
|
|
"reviewer_email": {
|
|
"description": "Reviewer email.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the review.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_review"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/shipping_classes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/shipping_classes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/shipping_classes/slug-suggestion": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Shipping class name.",
|
|
"in": "query",
|
|
"name": "name",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "HTML description of the resource.",
|
|
"in": "query",
|
|
"name": "description",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/shipping_classes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Shipping class name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_shipping_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/suggested-products": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"popularity",
|
|
"popularity",
|
|
"rating",
|
|
"rating",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"external",
|
|
"grouped",
|
|
"simple",
|
|
"variable"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to featured products.",
|
|
"in": "query",
|
|
"name": "featured",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific tag ID.",
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific shipping class ID.",
|
|
"in": "query",
|
|
"name": "shipping_class",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
|
|
"in": "query",
|
|
"name": "attribute",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
|
|
"in": "query",
|
|
"name": "attribute_term",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products in stock or out of stock.",
|
|
"in": "query",
|
|
"name": "in_stock",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific product categorie ids.",
|
|
"in": "query",
|
|
"name": "categories",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific product tag ids.",
|
|
"in": "query",
|
|
"name": "tags",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific amount of suggested products.",
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/tags": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by resource attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide resources not assigned to any products.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources assigned to a specific product.",
|
|
"in": "query",
|
|
"name": "product",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to resources with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Name for the resource.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/tags/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/tags/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the resource.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tag name.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the resource unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/{id}/duplicate": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"button_text": {
|
|
"description": "Product external button text. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"catalog_visibility": {
|
|
"description": "Catalogue visibility.",
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"description": "List of categories.",
|
|
"type": "array"
|
|
},
|
|
"cross_sell_ids": {
|
|
"description": "List of cross-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"date_created": {
|
|
"description": "The date the product was created, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_created_gmt": {
|
|
"description": "The date the product was created, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_attributes": {
|
|
"description": "Defaults variation attributes.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "Product description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Product dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the product is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"external_url": {
|
|
"description": "Product external URL. Only for external products.",
|
|
"type": "string"
|
|
},
|
|
"featured": {
|
|
"description": "Featured product.",
|
|
"type": "boolean"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"images": {
|
|
"description": "List of images.",
|
|
"type": "array"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the product.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at product level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"description": "Product name.",
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"description": "Product parent ID.",
|
|
"type": "integer"
|
|
},
|
|
"post_password": {
|
|
"description": "Post password.",
|
|
"type": "string"
|
|
},
|
|
"purchase_note": {
|
|
"description": "Optional note to send the customer after purchase.",
|
|
"type": "string"
|
|
},
|
|
"regular_price": {
|
|
"description": "Product regular price.",
|
|
"type": "string"
|
|
},
|
|
"reviews_allowed": {
|
|
"description": "Allow reviews.",
|
|
"type": "boolean"
|
|
},
|
|
"sale_price": {
|
|
"description": "Product sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"short_description": {
|
|
"description": "Product short description.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Product slug.",
|
|
"type": "string"
|
|
},
|
|
"sold_individually": {
|
|
"description": "Allow one item to be bought in a single order.",
|
|
"type": "boolean"
|
|
},
|
|
"status": {
|
|
"description": "Product status (post status).",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"description": "List of tags.",
|
|
"type": "array"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Product type.",
|
|
"type": "string"
|
|
},
|
|
"upsell_ids": {
|
|
"description": "List of up-sell products IDs.",
|
|
"type": "array"
|
|
},
|
|
"virtual": {
|
|
"description": "If the product is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Product weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/{product_id}/variations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"menu_order",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with a specific slug.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"any",
|
|
"draft",
|
|
"future",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"trash"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
|
|
"in": "query",
|
|
"name": "sku",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products on sale.",
|
|
"in": "query",
|
|
"name": "on_sale",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a minimum price.",
|
|
"in": "query",
|
|
"name": "min_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products based on a maximum price.",
|
|
"in": "query",
|
|
"name": "max_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified stock status.",
|
|
"in": "query",
|
|
"name": "stock_status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"instock",
|
|
"onbackorder",
|
|
"outofstock"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with or without price.",
|
|
"in": "query",
|
|
"name": "has_price",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to products with specified attributes.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"attribute": {
|
|
"description": "Attribute slug.",
|
|
"type": "string"
|
|
},
|
|
"term": {
|
|
"description": "Attribute term.",
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"description": "Attribute terms.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/{product_id}/variations/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/{product_id}/variations/generate": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"default_values": {
|
|
"description": "Default values for generated variations.",
|
|
"type": "object"
|
|
},
|
|
"delete": {
|
|
"description": "Deletes unused variations.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/products/{product_id}/variations/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the variable product.",
|
|
"in": "path",
|
|
"name": "product_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the variation.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "List of attributes.",
|
|
"type": "array"
|
|
},
|
|
"backorders": {
|
|
"description": "If managing stock, this controls if back-orders are allowed.",
|
|
"type": "string"
|
|
},
|
|
"date_on_sale_from": {
|
|
"description": "Start date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_from_gmt": {
|
|
"description": "Start date of sale price, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_on_sale_to_gmt": {
|
|
"description": "End date of sale price, in the site's timezone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Variation description.",
|
|
"type": "string"
|
|
},
|
|
"dimensions": {
|
|
"description": "Variation dimensions.",
|
|
"type": "object"
|
|
},
|
|
"download_expiry": {
|
|
"description": "Number of days until access to downloadable files expires.",
|
|
"type": "integer"
|
|
},
|
|
"download_limit": {
|
|
"description": "Number of times downloadable files can be downloaded after purchase.",
|
|
"type": "integer"
|
|
},
|
|
"downloadable": {
|
|
"description": "If the variation is downloadable.",
|
|
"type": "boolean"
|
|
},
|
|
"downloads": {
|
|
"description": "List of downloadable files.",
|
|
"type": "array"
|
|
},
|
|
"global_unique_id": {
|
|
"description": "GTIN, UPC, EAN or ISBN.",
|
|
"type": "string"
|
|
},
|
|
"image": {
|
|
"description": "Variation image data.",
|
|
"type": "object"
|
|
},
|
|
"low_stock_amount": {
|
|
"description": "Low Stock amount for the variation.",
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
]
|
|
},
|
|
"manage_stock": {
|
|
"description": "Stock management at variation level.",
|
|
"type": "boolean"
|
|
},
|
|
"menu_order": {
|
|
"description": "Menu order, used to custom sort products.",
|
|
"type": "integer"
|
|
},
|
|
"meta_data": {
|
|
"description": "Meta data.",
|
|
"type": "array"
|
|
},
|
|
"regular_price": {
|
|
"description": "Variation regular price.",
|
|
"type": "string"
|
|
},
|
|
"sale_price": {
|
|
"description": "Variation sale price.",
|
|
"type": "string"
|
|
},
|
|
"shipping_class": {
|
|
"description": "Shipping class slug.",
|
|
"type": "string"
|
|
},
|
|
"sku": {
|
|
"description": "Stock Keeping Unit.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Variation status.",
|
|
"type": "string"
|
|
},
|
|
"stock_quantity": {
|
|
"description": "Stock quantity.",
|
|
"type": "integer"
|
|
},
|
|
"stock_status": {
|
|
"description": "Controls the stock status of the product.",
|
|
"type": "string"
|
|
},
|
|
"tax_class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"tax_status": {
|
|
"description": "Tax status.",
|
|
"type": "string"
|
|
},
|
|
"virtual": {
|
|
"description": "If the variation is virtual.",
|
|
"type": "boolean"
|
|
},
|
|
"weight": {
|
|
"description": "Variation weight (kg).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_variation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/refunds": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to consider GMT post dates when limiting response by published or modified date.",
|
|
"in": "query",
|
|
"name": "dates_are_gmt",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"modified",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to those of particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Number of decimal points to use in each resource.",
|
|
"in": "query",
|
|
"name": "dp",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Only show meta which is meant to be displayed for an order.",
|
|
"in": "query",
|
|
"name": "order_item_display_meta",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit meta_data to specific keys.",
|
|
"in": "query",
|
|
"name": "include_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure meta_data excludes specific keys.",
|
|
"in": "query",
|
|
"name": "exclude_meta",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shop_order_refund"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/coupons/totals": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_coupon_total"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/customers/totals": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_customer_total"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/orders/totals": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_order_total"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/products/totals": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_product_total"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/reviews/totals": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/report_review_total"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/sales": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Report period.",
|
|
"in": "query",
|
|
"name": "period",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"last_month",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_min",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_max",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sales_report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/reports/top_sellers": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Report period.",
|
|
"in": "query",
|
|
"name": "period",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"last_month",
|
|
"month",
|
|
"week",
|
|
"year"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_min",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
},
|
|
{
|
|
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
|
|
"in": "query",
|
|
"name": "date_max",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/top_sellers_report"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/settings": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting_group"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/settings/batch": {
|
|
"patch": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/settings/{group_id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Settings group ID.",
|
|
"in": "query",
|
|
"name": "group",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/settings/{group_id}/batch": {
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/settings/{group_id}/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Settings group ID.",
|
|
"in": "query",
|
|
"name": "group",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "group_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"group": {
|
|
"description": "Settings group ID.",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "Setting value.",
|
|
"type": [
|
|
"array",
|
|
"boolean",
|
|
"integer",
|
|
"null",
|
|
"number",
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/setting"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping/zones": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping/zones/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Shipping zone name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Shipping zone order.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping/zones/{id}/locations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Shipping zone location type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Shipping zone location type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"code": {
|
|
"description": "Shipping zone location code.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Shipping zone location type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping/zones/{zone_id}/methods": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"method_id": {
|
|
"description": "Shipping method ID.",
|
|
"required": true
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"method_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping/zones/{zone_id}/methods/{instance_id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique ID for the zone.",
|
|
"in": "path",
|
|
"name": "zone_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique ID for the instance.",
|
|
"in": "path",
|
|
"name": "instance_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Shipping method enabled status.",
|
|
"type": "boolean"
|
|
},
|
|
"order": {
|
|
"description": "Shipping method sort order.",
|
|
"type": "integer"
|
|
},
|
|
"settings": {
|
|
"description": "Shipping method settings.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_zone_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping_methods": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/shipping_methods/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/shipping_method"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/system_status": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/system_status/tools": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/system_status/tools/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "A unique identifier for the tool.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "A unique identifier for the tool.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "A unique identifier for the tool.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"description": "What running the tool will do.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Tool description.",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Tool return message.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tool name.",
|
|
"type": "string"
|
|
},
|
|
"success": {
|
|
"description": "Did the tool run successfully?",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/system_status_tool"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/taxes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"order",
|
|
"priority"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort by tax class.",
|
|
"in": "query",
|
|
"name": "class",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"reduced-rate",
|
|
"standard",
|
|
"zero-rate"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/taxes/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/taxes/classes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "Tax class name.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/taxes/classes/{slug}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique slug for the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique slug for the resource.",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax_class"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/taxes/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"cities": {
|
|
"description": "List of city names. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"city": {
|
|
"description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"class": {
|
|
"description": "Tax class.",
|
|
"type": "string"
|
|
},
|
|
"compound": {
|
|
"description": "Whether or not this is a compound rate.",
|
|
"type": "boolean"
|
|
},
|
|
"country": {
|
|
"description": "Country ISO 3166 code.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Tax rate name.",
|
|
"type": "string"
|
|
},
|
|
"order": {
|
|
"description": "Indicates the order that will appear in queries.",
|
|
"type": "integer"
|
|
},
|
|
"postcode": {
|
|
"description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.",
|
|
"type": "string"
|
|
},
|
|
"postcodes": {
|
|
"description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.",
|
|
"type": "array"
|
|
},
|
|
"priority": {
|
|
"description": "Tax priority.",
|
|
"type": "integer"
|
|
},
|
|
"rate": {
|
|
"description": "Tax rate.",
|
|
"type": "string"
|
|
},
|
|
"shipping": {
|
|
"description": "Whether or not this tax rate also gets applied to shipping.",
|
|
"type": "boolean"
|
|
},
|
|
"state": {
|
|
"description": "State code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tax"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/webhooks": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to resources published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific ids.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to webhooks assigned a specific status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"active",
|
|
"all",
|
|
"disabled",
|
|
"paused"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"delivery_url": {
|
|
"description": "Webhook delivery URL.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"delivery_url",
|
|
"topic"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/webhooks/batch": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/batch"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wc/v3/webhooks/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as resource does not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the resource.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "A friendly name for the webhook.",
|
|
"type": "string"
|
|
},
|
|
"secret": {
|
|
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Webhook status.",
|
|
"type": "string"
|
|
},
|
|
"topic": {
|
|
"description": "Webhook topic.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/webhook"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wccom-site/v3": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wccom-site/v3/installer": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"idempotency-key": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"product-id": {
|
|
"required": true,
|
|
"type": "integer"
|
|
},
|
|
"run-until-step": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"idempotency-key",
|
|
"product-id",
|
|
"run-until-step"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"idempotency-key": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"product-id": {
|
|
"required": true,
|
|
"type": "integer"
|
|
},
|
|
"run-until-step": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"idempotency-key",
|
|
"product-id",
|
|
"run-until-step"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"idempotency-key": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"product-id": {
|
|
"required": true,
|
|
"type": "integer"
|
|
},
|
|
"run-until-step": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"idempotency-key",
|
|
"product-id",
|
|
"run-until-step"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wccom-site/v3/installer/reset": {
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"idempotency-key": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"product-id": {
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"idempotency-key",
|
|
"product-id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"idempotency-key": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"product-id": {
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"idempotency-key",
|
|
"product-id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"idempotency-key": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"product-id": {
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"idempotency-key",
|
|
"product-id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wccom-site/v3/ssr": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wccom-site/v3/status": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-block-editor/v1": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-block-editor/v1/export": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-block-editor/v1/navigation-fallback": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/navigation-fallback"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-block-editor/v1/url-details": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The URL to process.",
|
|
"in": "query",
|
|
"name": "url",
|
|
"required": true,
|
|
"schema": {
|
|
"format": "uri"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-openapi/v1": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-openapi/v1/schema": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/directory-sizes": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/tests/authorization-header": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp-site-health-test"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/tests/background-updates": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp-site-health-test"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/tests/dotorg-communication": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp-site-health-test"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/tests/https-status": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp-site-health-test"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/tests/loopback-requests": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp-site-health-test"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp-site-health/v1/tests/page-cache": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-directory/search": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to blocks matching the search term.",
|
|
"in": "query",
|
|
"name": "term",
|
|
"required": true,
|
|
"schema": {
|
|
"minLength": 1
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/block-directory-item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-patterns/categories": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/block-pattern-category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-patterns/patterns": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/block-pattern"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-renderer/{name}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique registered name for the block.",
|
|
"in": "path",
|
|
"name": "name",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Attributes for the block.",
|
|
"in": "query",
|
|
"name": "attributes",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "ID of the post context.",
|
|
"in": "query",
|
|
"name": "post_id",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/rendered-block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique registered name for the block.",
|
|
"in": "path",
|
|
"name": "name",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attributes": {
|
|
"description": "Attributes for the block.",
|
|
"type": "object"
|
|
},
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"post_id": {
|
|
"description": "ID of the post context.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/rendered-block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-types": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Block namespace.",
|
|
"in": "query",
|
|
"name": "namespace",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/block-type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-types/{namespace}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Block namespace.",
|
|
"in": "path",
|
|
"name": "namespace",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/block-type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/block-types/{namespace}/{name}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Block name.",
|
|
"in": "path",
|
|
"name": "name",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Block namespace.",
|
|
"in": "path",
|
|
"name": "namespace",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/block-type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/blocks": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"draft",
|
|
"future",
|
|
"inherit",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"request-completed",
|
|
"request-confirmed",
|
|
"request-failed",
|
|
"request-pending",
|
|
"trash",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set based on relationship between multiple taxonomies.",
|
|
"in": "query",
|
|
"name": "tax_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.",
|
|
"in": "query",
|
|
"name": "wp_pattern_category",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"operator": {
|
|
"default": "OR",
|
|
"description": "Whether items must be assigned all or any of the specified terms.",
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.",
|
|
"in": "query",
|
|
"name": "wp_pattern_category_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
},
|
|
"wp_pattern_category": {
|
|
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/blocks/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Override the default excerpt length.",
|
|
"in": "query",
|
|
"name": "excerpt_length",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The password for the post if it is password protected.",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
},
|
|
"wp_pattern_category": {
|
|
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
},
|
|
"wp_pattern_category": {
|
|
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
},
|
|
"wp_pattern_category": {
|
|
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/blocks/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the autosave.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
},
|
|
"wp_pattern_category": {
|
|
"description": "The terms assigned to the object in the wp_pattern_category taxonomy.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/blocks/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/blocks/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/blocks/{parent}/revisions/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as revisions do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_block-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/categories": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by term attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide terms not assigned to any posts.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific parent.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific post.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/categories/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as terms do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/comments": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to comments published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.",
|
|
"in": "query",
|
|
"name": "author",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.",
|
|
"in": "query",
|
|
"name": "author_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to that from a specific author email. Requires authorisation.",
|
|
"in": "query",
|
|
"name": "author_email",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "email"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to comments published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by comment attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"date_gmt",
|
|
"id",
|
|
"include",
|
|
"parent",
|
|
"post",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to comments of specific parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific parent IDs.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to comments assigned to specific post IDs.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to comments assigned a specific status. Requires authorisation.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to comments assigned a specific type. Requires authorisation.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The password for the post if it is password protected.",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID of the user object, if author was a user.",
|
|
"type": "integer"
|
|
},
|
|
"author_email": {
|
|
"description": "Email address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_ip": {
|
|
"description": "IP address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_name": {
|
|
"description": "Display name for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_url": {
|
|
"description": "URL for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_user_agent": {
|
|
"description": "User agent for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the comment.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the comment was published, in the site's time zone.",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the comment was published, as GMT.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the comment.",
|
|
"type": "integer"
|
|
},
|
|
"post": {
|
|
"description": "The ID of the associated post object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "State of the comment.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/comments/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the comment.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
},
|
|
"password": {
|
|
"description": "The password for the parent post of the comment (if the post is password protected).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the comment.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "The password for the parent post of the comment (if the post is password protected).",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the comment.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID of the user object, if author was a user.",
|
|
"type": "integer"
|
|
},
|
|
"author_email": {
|
|
"description": "Email address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_ip": {
|
|
"description": "IP address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_name": {
|
|
"description": "Display name for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_url": {
|
|
"description": "URL for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_user_agent": {
|
|
"description": "User agent for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the comment.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the comment was published, in the site's time zone.",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the comment was published, as GMT.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the comment.",
|
|
"type": "integer"
|
|
},
|
|
"post": {
|
|
"description": "The ID of the associated post object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "State of the comment.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the comment.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID of the user object, if author was a user.",
|
|
"type": "integer"
|
|
},
|
|
"author_email": {
|
|
"description": "Email address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_ip": {
|
|
"description": "IP address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_name": {
|
|
"description": "Display name for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_url": {
|
|
"description": "URL for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_user_agent": {
|
|
"description": "User agent for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the comment.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the comment was published, in the site's time zone.",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the comment was published, as GMT.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the comment.",
|
|
"type": "integer"
|
|
},
|
|
"post": {
|
|
"description": "The ID of the associated post object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "State of the comment.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the comment.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID of the user object, if author was a user.",
|
|
"type": "integer"
|
|
},
|
|
"author_email": {
|
|
"description": "Email address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_ip": {
|
|
"description": "IP address for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_name": {
|
|
"description": "Display name for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_url": {
|
|
"description": "URL for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"author_user_agent": {
|
|
"description": "User agent for the comment author.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the comment.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the comment was published, in the site's time zone.",
|
|
"type": "string"
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the comment was published, as GMT.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the comment.",
|
|
"type": "integer"
|
|
},
|
|
"post": {
|
|
"description": "The ID of the associated post object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "State of the comment.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/comment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/font-collections": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/font-collection"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/font-collections/{slug}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/font-collection"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/font-families": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"include"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"font_family_settings": {
|
|
"description": "font-family declaration in theme.json format, encoded as a string.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"theme_json_version": {
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"font_family_settings"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/font-families/{font_family_id}/font-faces": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent font family of the font face.",
|
|
"in": "path",
|
|
"name": "font_family_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"id",
|
|
"include"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_face"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent font family of the font face.",
|
|
"in": "path",
|
|
"name": "font_family_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"font_face_settings": {
|
|
"description": "font-face declaration in theme.json format, encoded as a string.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"theme_json_version": {
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"font_face_settings"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_face"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/font-families/{font_family_id}/font-faces/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent font family of the font face.",
|
|
"in": "path",
|
|
"name": "font_family_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the font face.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_face"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent font family of the font face.",
|
|
"in": "path",
|
|
"name": "font_family_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the font face.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_face"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/font-families/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"font_family_settings": {
|
|
"description": "font-family declaration in theme.json format, encoded as a string.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"theme_json_version": {
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"font_family_settings"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"font_family_settings": {
|
|
"description": "font-family declaration in theme.json format, encoded as a string.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"theme_json_version": {
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"font_family_settings"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"font_family_settings": {
|
|
"description": "font-family declaration in theme.json format, encoded as a string.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"theme_json_version": {
|
|
"description": "Version of the theme.json schema used for the typography settings.",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"font_family_settings"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_font_family"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/global-styles/themes/{stylesheet}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The theme identifier",
|
|
"in": "path",
|
|
"name": "stylesheet",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/global-styles/themes/{stylesheet}/variations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The theme identifier",
|
|
"in": "path",
|
|
"name": "stylesheet",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/global-styles/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_global_styles"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"settings": {
|
|
"description": "Global settings.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"styles": {
|
|
"description": "Global styles.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"title": {
|
|
"description": "Title of the global styles variation.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_global_styles"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"settings": {
|
|
"description": "Global settings.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"styles": {
|
|
"description": "Global styles.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"title": {
|
|
"description": "Title of the global styles variation.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_global_styles"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"settings": {
|
|
"description": "Global settings.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"styles": {
|
|
"description": "Global styles.",
|
|
"type": [
|
|
"object"
|
|
]
|
|
},
|
|
"title": {
|
|
"description": "Title of the global styles variation.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_global_styles"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/global-styles/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_global_styles-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/global-styles/{parent}/revisions/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the global styles revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the global styles revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_global_styles-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/media": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned to specific authors.",
|
|
"in": "query",
|
|
"name": "author",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes posts assigned to specific authors.",
|
|
"in": "query",
|
|
"name": "author_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"inherit",
|
|
"private",
|
|
"trash"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to attachments of a particular media type.",
|
|
"in": "query",
|
|
"name": "media_type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"application",
|
|
"image",
|
|
"video"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to attachments of a particular MIME type.",
|
|
"in": "query",
|
|
"name": "mime_type",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"alt_text": {
|
|
"description": "Alternative text to display when attachment is not displayed.",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"caption": {
|
|
"description": "The attachment caption.",
|
|
"type": "object"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "The attachment description.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"post": {
|
|
"description": "The ID for the associated post of the attachment.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/media/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"alt_text": {
|
|
"description": "Alternative text to display when attachment is not displayed.",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"caption": {
|
|
"description": "The attachment caption.",
|
|
"type": "object"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "The attachment description.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"post": {
|
|
"description": "The ID for the associated post of the attachment.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"alt_text": {
|
|
"description": "Alternative text to display when attachment is not displayed.",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"caption": {
|
|
"description": "The attachment caption.",
|
|
"type": "object"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "The attachment description.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"post": {
|
|
"description": "The ID for the associated post of the attachment.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"alt_text": {
|
|
"description": "Alternative text to display when attachment is not displayed.",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"caption": {
|
|
"description": "The attachment caption.",
|
|
"type": "object"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "The attachment description.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"post": {
|
|
"description": "The ID for the associated post of the attachment.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/attachment"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/media/{id}/edit": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"height": {
|
|
"description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.",
|
|
"type": "number"
|
|
},
|
|
"modifiers": {
|
|
"description": "Array of image edits.",
|
|
"type": "array"
|
|
},
|
|
"rotation": {
|
|
"description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.",
|
|
"type": "integer"
|
|
},
|
|
"src": {
|
|
"description": "URL to the edited image file.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"width": {
|
|
"description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.",
|
|
"type": "number"
|
|
},
|
|
"x": {
|
|
"description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.",
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"src"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/media/{id}/post-process": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the attachment.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"action": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menu-items": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"menu_order",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"draft",
|
|
"future",
|
|
"inherit",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"request-completed",
|
|
"request-confirmed",
|
|
"request-failed",
|
|
"request-pending",
|
|
"trash",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set based on relationship between multiple taxonomies.",
|
|
"in": "query",
|
|
"name": "tax_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with specific terms assigned in the menus taxonomy.",
|
|
"in": "query",
|
|
"name": "menus",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"operator": {
|
|
"default": "OR",
|
|
"description": "Whether items must be assigned all or any of the specified terms.",
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.",
|
|
"in": "query",
|
|
"name": "menus_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with a specific menu_order value.",
|
|
"in": "query",
|
|
"name": "menu_order",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attr_title": {
|
|
"description": "Text for the title attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"classes": {
|
|
"description": "Class names for the link element of this menu item.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "The description of this menu item.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
|
|
"type": "integer"
|
|
},
|
|
"menus": {
|
|
"description": "The terms assigned to the object in the nav_menu taxonomy.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"object": {
|
|
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
|
|
"type": "string"
|
|
},
|
|
"object_id": {
|
|
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "The target attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the object.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "The URL to which this menu item points.",
|
|
"type": "string"
|
|
},
|
|
"xfn": {
|
|
"description": "The XFN relationship expressed in the link of this menu item.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menu-items/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attr_title": {
|
|
"description": "Text for the title attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"classes": {
|
|
"description": "Class names for the link element of this menu item.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "The description of this menu item.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
|
|
"type": "integer"
|
|
},
|
|
"menus": {
|
|
"description": "The terms assigned to the object in the nav_menu taxonomy.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"object": {
|
|
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
|
|
"type": "string"
|
|
},
|
|
"object_id": {
|
|
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "The target attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the object.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "The URL to which this menu item points.",
|
|
"type": "string"
|
|
},
|
|
"xfn": {
|
|
"description": "The XFN relationship expressed in the link of this menu item.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attr_title": {
|
|
"description": "Text for the title attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"classes": {
|
|
"description": "Class names for the link element of this menu item.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "The description of this menu item.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
|
|
"type": "integer"
|
|
},
|
|
"menus": {
|
|
"description": "The terms assigned to the object in the nav_menu taxonomy.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"object": {
|
|
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
|
|
"type": "string"
|
|
},
|
|
"object_id": {
|
|
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "The target attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the object.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "The URL to which this menu item points.",
|
|
"type": "string"
|
|
},
|
|
"xfn": {
|
|
"description": "The XFN relationship expressed in the link of this menu item.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attr_title": {
|
|
"description": "Text for the title attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"classes": {
|
|
"description": "Class names for the link element of this menu item.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "The description of this menu item.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
|
|
"type": "integer"
|
|
},
|
|
"menus": {
|
|
"description": "The terms assigned to the object in the nav_menu taxonomy.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"object": {
|
|
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
|
|
"type": "string"
|
|
},
|
|
"object_id": {
|
|
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "The target attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the object.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "The URL to which this menu item points.",
|
|
"type": "string"
|
|
},
|
|
"xfn": {
|
|
"description": "The XFN relationship expressed in the link of this menu item.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menu-items/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"attr_title": {
|
|
"description": "Text for the title attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"classes": {
|
|
"description": "Class names for the link element of this menu item.",
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"description": "The description of this menu item.",
|
|
"type": "string"
|
|
},
|
|
"menu_order": {
|
|
"description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.",
|
|
"type": "integer"
|
|
},
|
|
"menus": {
|
|
"description": "The terms assigned to the object in the nav_menu taxonomy.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"object": {
|
|
"description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".",
|
|
"type": "string"
|
|
},
|
|
"object_id": {
|
|
"description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "The target attribute of the link element for this menu item.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the object.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "The URL to which this menu item points.",
|
|
"type": "string"
|
|
},
|
|
"xfn": {
|
|
"description": "The XFN relationship expressed in the link of this menu item.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menu-items/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu_item-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menu-locations": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/menu-location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menu-locations/{location}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "An alphanumeric identifier for the menu location.",
|
|
"in": "path",
|
|
"name": "location",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/menu-location"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menus": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by term attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide terms not assigned to any posts.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific post.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"auto_add": {
|
|
"description": "Whether to automatically add top-level pages to this menu.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"locations": {
|
|
"description": "The locations assigned to the menu.",
|
|
"type": "array"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/menus/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as terms do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"auto_add": {
|
|
"description": "Whether to automatically add top-level pages to this menu.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"locations": {
|
|
"description": "The locations assigned to the menu.",
|
|
"type": "array"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"auto_add": {
|
|
"description": "Whether to automatically add top-level pages to this menu.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"locations": {
|
|
"description": "The locations assigned to the menu.",
|
|
"type": "array"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"auto_add": {
|
|
"description": "Whether to automatically add top-level pages to this menu.",
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"locations": {
|
|
"description": "The locations assigned to the menu.",
|
|
"type": "array"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/nav_menu"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/navigation": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"draft",
|
|
"future",
|
|
"inherit",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"request-completed",
|
|
"request-confirmed",
|
|
"request-failed",
|
|
"request-pending",
|
|
"trash",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/navigation/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "The password for the post if it is password protected.",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/navigation/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the autosave.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/navigation/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/navigation/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/navigation/{parent}/revisions/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as revisions do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_navigation-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pages": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned to specific authors.",
|
|
"in": "query",
|
|
"name": "author",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes posts assigned to specific authors.",
|
|
"in": "query",
|
|
"name": "author_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with a specific menu_order value.",
|
|
"in": "query",
|
|
"name": "menu_order",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"menu_order",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with particular parent IDs.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to all items except those of a particular parent ID.",
|
|
"in": "query",
|
|
"name": "parent_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"draft",
|
|
"future",
|
|
"inherit",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"request-completed",
|
|
"request-confirmed",
|
|
"request-failed",
|
|
"request-pending",
|
|
"trash",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"menu_order": {
|
|
"description": "The order of the post in relation to other posts.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pages/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Override the default excerpt length.",
|
|
"in": "query",
|
|
"name": "excerpt_length",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The password for the post if it is password protected.",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"menu_order": {
|
|
"description": "The order of the post in relation to other posts.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"menu_order": {
|
|
"description": "The order of the post in relation to other posts.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"menu_order": {
|
|
"description": "The order of the post in relation to other posts.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pages/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"menu_order": {
|
|
"description": "The order of the post in relation to other posts.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the object.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pages/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pages/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pages/{parent}/revisions/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as revisions do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/page-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/pattern-directory/patterns": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"minLength": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a category ID.",
|
|
"in": "query",
|
|
"name": "category",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a keyword ID.",
|
|
"in": "query",
|
|
"name": "keyword",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a pattern (slug).",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"favorite_count",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/pattern-directory-item"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/plugins": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limits results to plugins with the given status.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"active",
|
|
"inactive"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"slug": {
|
|
"description": "WordPress.org plugin directory slug.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "The plugin activation status.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/plugins/{plugin}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "plugin",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "plugin",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "plugin",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "The plugin activation status.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "plugin",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "The plugin activation status.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "plugin",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"context": {
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "The plugin activation status.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/plugin"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/posts": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned to specific authors.",
|
|
"in": "query",
|
|
"name": "author",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes posts assigned to specific authors.",
|
|
"in": "query",
|
|
"name": "author_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"modified",
|
|
"parent",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"draft",
|
|
"future",
|
|
"inherit",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"request-completed",
|
|
"request-confirmed",
|
|
"request-failed",
|
|
"request-pending",
|
|
"trash",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set based on relationship between multiple taxonomies.",
|
|
"in": "query",
|
|
"name": "tax_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with specific terms assigned in the categories taxonomy.",
|
|
"in": "query",
|
|
"name": "categories",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"include_children": {
|
|
"default": false,
|
|
"description": "Whether to include child terms in the terms limiting the result set.",
|
|
"type": "boolean"
|
|
},
|
|
"operator": {
|
|
"default": "OR",
|
|
"description": "Whether items must be assigned all or any of the specified terms.",
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.",
|
|
"in": "query",
|
|
"name": "categories_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"include_children": {
|
|
"default": false,
|
|
"description": "Whether to include child terms in the terms limiting the result set.",
|
|
"type": "boolean"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with specific terms assigned in the tags taxonomy.",
|
|
"in": "query",
|
|
"name": "tags",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"operator": {
|
|
"default": "OR",
|
|
"description": "Whether items must be assigned all or any of the specified terms.",
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.",
|
|
"in": "query",
|
|
"name": "tags_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items that are sticky.",
|
|
"in": "query",
|
|
"name": "sticky",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"categories": {
|
|
"description": "The terms assigned to the object in the category taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"description": "The format for the post.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"sticky": {
|
|
"description": "Whether or not the post should be treated as sticky.",
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"description": "The terms assigned to the object in the post_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/posts/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Override the default excerpt length.",
|
|
"in": "query",
|
|
"name": "excerpt_length",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The password for the post if it is password protected.",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"categories": {
|
|
"description": "The terms assigned to the object in the category taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"description": "The format for the post.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"sticky": {
|
|
"description": "Whether or not the post should be treated as sticky.",
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"description": "The terms assigned to the object in the post_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"categories": {
|
|
"description": "The terms assigned to the object in the category taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"description": "The format for the post.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"sticky": {
|
|
"description": "Whether or not the post should be treated as sticky.",
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"description": "The terms assigned to the object in the post_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"categories": {
|
|
"description": "The terms assigned to the object in the category taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"description": "The format for the post.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"sticky": {
|
|
"description": "Whether or not the post should be treated as sticky.",
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"description": "The terms assigned to the object in the post_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/posts/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the post.",
|
|
"type": "integer"
|
|
},
|
|
"categories": {
|
|
"description": "The terms assigned to the object in the category taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"comment_status": {
|
|
"description": "Whether or not comments are open on the post.",
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"format": {
|
|
"description": "The format for the post.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the autosave.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"ping_status": {
|
|
"description": "Whether or not the post can be pinged.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"sticky": {
|
|
"description": "Whether or not the post should be treated as sticky.",
|
|
"type": "boolean"
|
|
},
|
|
"tags": {
|
|
"description": "The terms assigned to the object in the post_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/posts/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/posts/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/posts/{parent}/revisions/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as revisions do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the revision.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/post-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified after a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_after",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts published before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit response to posts modified before a given ISO8601 compliant date.",
|
|
"in": "query",
|
|
"name": "modified_before",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time"
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by post attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"author",
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"modified",
|
|
"parent",
|
|
"popularity",
|
|
"popularity",
|
|
"rating",
|
|
"rating",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Array of column names to be searched.",
|
|
"in": "query",
|
|
"name": "search_columns",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"post_content",
|
|
"post_excerpt",
|
|
"post_title"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to posts assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"auto-draft",
|
|
"draft",
|
|
"future",
|
|
"inherit",
|
|
"pending",
|
|
"private",
|
|
"publish",
|
|
"request-completed",
|
|
"request-confirmed",
|
|
"request-failed",
|
|
"request-pending",
|
|
"trash",
|
|
"wc-cancelled",
|
|
"wc-checkout-draft",
|
|
"wc-completed",
|
|
"wc-failed",
|
|
"wc-on-hold",
|
|
"wc-pending",
|
|
"wc-processing",
|
|
"wc-refunded"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set based on relationship between multiple taxonomies.",
|
|
"in": "query",
|
|
"name": "tax_relation",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.",
|
|
"in": "query",
|
|
"name": "product_cat",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"include_children": {
|
|
"default": false,
|
|
"description": "Whether to include child terms in the terms limiting the result set.",
|
|
"type": "boolean"
|
|
},
|
|
"operator": {
|
|
"default": "OR",
|
|
"description": "Whether items must be assigned all or any of the specified terms.",
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.",
|
|
"in": "query",
|
|
"name": "product_cat_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"include_children": {
|
|
"default": false,
|
|
"description": "Whether to include child terms in the terms limiting the result set.",
|
|
"type": "boolean"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.",
|
|
"in": "query",
|
|
"name": "product_tag",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"operator": {
|
|
"default": "OR",
|
|
"description": "Whether items must be assigned all or any of the specified terms.",
|
|
"enum": [
|
|
"AND",
|
|
"OR"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.",
|
|
"in": "query",
|
|
"name": "product_tag_exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"description": "Match terms with the listed IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "Term ID List",
|
|
"type": "array"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Perform an advanced term query.",
|
|
"properties": {
|
|
"terms": {
|
|
"default": [],
|
|
"description": "Term IDs.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "Term ID Taxonomy Query",
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"product_cat": {
|
|
"description": "The terms assigned to the object in the product_cat taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"product_tag": {
|
|
"description": "The terms assigned to the object in the product_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Override the default excerpt length.",
|
|
"in": "query",
|
|
"name": "excerpt_length",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The password for the post if it is password protected.",
|
|
"in": "query",
|
|
"name": "password",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"product_cat": {
|
|
"description": "The terms assigned to the object in the product_cat taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"product_tag": {
|
|
"description": "The terms assigned to the object in the product_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"product_cat": {
|
|
"description": "The terms assigned to the object in the product_cat taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"product_tag": {
|
|
"description": "The terms assigned to the object in the product_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the post.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"product_cat": {
|
|
"description": "The terms assigned to the object in the product_cat taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"product_tag": {
|
|
"description": "The terms assigned to the object in the product_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"content": {
|
|
"description": "The content for the post.",
|
|
"type": "object"
|
|
},
|
|
"date": {
|
|
"description": "The date the post was published, in the site's time zone.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"date_gmt": {
|
|
"description": "The date the post was published, as GMT.",
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"excerpt": {
|
|
"description": "The excerpt for the post.",
|
|
"type": "object"
|
|
},
|
|
"featured_media": {
|
|
"description": "The ID of the featured media for the post.",
|
|
"type": "integer"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"parent": {
|
|
"description": "The ID for the parent of the autosave.",
|
|
"type": "integer"
|
|
},
|
|
"password": {
|
|
"description": "A password to protect access to the content and excerpt.",
|
|
"type": "string"
|
|
},
|
|
"product_cat": {
|
|
"description": "The terms assigned to the object in the product_cat taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"product_tag": {
|
|
"description": "The terms assigned to the object in the product_tag taxonomy.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the post unique to its type.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "A named status for the object.",
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"description": "The theme file to use to display the post.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "The title for the post.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID for the parent of the autosave.",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product-revision"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product_cat": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by term attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide terms not assigned to any posts.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific parent.",
|
|
"in": "query",
|
|
"name": "parent",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific post.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product_cat/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as terms do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"parent": {
|
|
"description": "The parent term ID.",
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_cat"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product_tag": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by term attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide terms not assigned to any posts.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific post.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/product_tag/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as terms do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/product_tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/search": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit results to items of an object type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"post",
|
|
"post-format",
|
|
"term"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to items of one or more object subtypes.",
|
|
"in": "query",
|
|
"name": "subtype",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"any",
|
|
"category",
|
|
"page",
|
|
"post",
|
|
"post_tag",
|
|
"product",
|
|
"product_cat",
|
|
"product_tag"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/search-result"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/settings": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/settings"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_format": {
|
|
"description": "A date format for all date strings.",
|
|
"type": "string"
|
|
},
|
|
"default_category": {
|
|
"description": "Default post category.",
|
|
"type": "integer"
|
|
},
|
|
"default_comment_status": {
|
|
"description": "Allow people to submit comments on new posts.",
|
|
"type": "string"
|
|
},
|
|
"default_ping_status": {
|
|
"description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.",
|
|
"type": "string"
|
|
},
|
|
"default_post_format": {
|
|
"description": "Default post format.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Site tagline.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "This address is used for admin purposes, like new user notification.",
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"description": "WordPress locale code.",
|
|
"type": "string"
|
|
},
|
|
"page_for_posts": {
|
|
"description": "The ID of the page that should display the latest posts",
|
|
"type": "integer"
|
|
},
|
|
"page_on_front": {
|
|
"description": "The ID of the page that should be displayed on the front page",
|
|
"type": "integer"
|
|
},
|
|
"pickup_location_settings": {
|
|
"description": "WooCommerce Local Pickup Method Settings",
|
|
"type": "object"
|
|
},
|
|
"pickup_locations": {
|
|
"description": "WooCommerce Local Pickup Locations",
|
|
"type": "array"
|
|
},
|
|
"posts_per_page": {
|
|
"description": "Blog pages show at most.",
|
|
"type": "integer"
|
|
},
|
|
"show_on_front": {
|
|
"description": "What to show on the front page",
|
|
"type": "string"
|
|
},
|
|
"site_icon": {
|
|
"description": "Site icon.",
|
|
"type": "integer"
|
|
},
|
|
"site_logo": {
|
|
"description": "Site logo.",
|
|
"type": "integer"
|
|
},
|
|
"start_of_week": {
|
|
"description": "A day number of the week that the week should start on.",
|
|
"type": "integer"
|
|
},
|
|
"time_format": {
|
|
"description": "A time format for all time strings.",
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"description": "A city in the same timezone as you.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Site title.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "Site URL.",
|
|
"type": "string"
|
|
},
|
|
"use_smilies": {
|
|
"description": "Convert emoticons like :-) and :-P to graphics on display.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/settings"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_format": {
|
|
"description": "A date format for all date strings.",
|
|
"type": "string"
|
|
},
|
|
"default_category": {
|
|
"description": "Default post category.",
|
|
"type": "integer"
|
|
},
|
|
"default_comment_status": {
|
|
"description": "Allow people to submit comments on new posts.",
|
|
"type": "string"
|
|
},
|
|
"default_ping_status": {
|
|
"description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.",
|
|
"type": "string"
|
|
},
|
|
"default_post_format": {
|
|
"description": "Default post format.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Site tagline.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "This address is used for admin purposes, like new user notification.",
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"description": "WordPress locale code.",
|
|
"type": "string"
|
|
},
|
|
"page_for_posts": {
|
|
"description": "The ID of the page that should display the latest posts",
|
|
"type": "integer"
|
|
},
|
|
"page_on_front": {
|
|
"description": "The ID of the page that should be displayed on the front page",
|
|
"type": "integer"
|
|
},
|
|
"pickup_location_settings": {
|
|
"description": "WooCommerce Local Pickup Method Settings",
|
|
"type": "object"
|
|
},
|
|
"pickup_locations": {
|
|
"description": "WooCommerce Local Pickup Locations",
|
|
"type": "array"
|
|
},
|
|
"posts_per_page": {
|
|
"description": "Blog pages show at most.",
|
|
"type": "integer"
|
|
},
|
|
"show_on_front": {
|
|
"description": "What to show on the front page",
|
|
"type": "string"
|
|
},
|
|
"site_icon": {
|
|
"description": "Site icon.",
|
|
"type": "integer"
|
|
},
|
|
"site_logo": {
|
|
"description": "Site logo.",
|
|
"type": "integer"
|
|
},
|
|
"start_of_week": {
|
|
"description": "A day number of the week that the week should start on.",
|
|
"type": "integer"
|
|
},
|
|
"time_format": {
|
|
"description": "A time format for all time strings.",
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"description": "A city in the same timezone as you.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Site title.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "Site URL.",
|
|
"type": "string"
|
|
},
|
|
"use_smilies": {
|
|
"description": "Convert emoticons like :-) and :-P to graphics on display.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/settings"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"date_format": {
|
|
"description": "A date format for all date strings.",
|
|
"type": "string"
|
|
},
|
|
"default_category": {
|
|
"description": "Default post category.",
|
|
"type": "integer"
|
|
},
|
|
"default_comment_status": {
|
|
"description": "Allow people to submit comments on new posts.",
|
|
"type": "string"
|
|
},
|
|
"default_ping_status": {
|
|
"description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.",
|
|
"type": "string"
|
|
},
|
|
"default_post_format": {
|
|
"description": "Default post format.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "Site tagline.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "This address is used for admin purposes, like new user notification.",
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"description": "WordPress locale code.",
|
|
"type": "string"
|
|
},
|
|
"page_for_posts": {
|
|
"description": "The ID of the page that should display the latest posts",
|
|
"type": "integer"
|
|
},
|
|
"page_on_front": {
|
|
"description": "The ID of the page that should be displayed on the front page",
|
|
"type": "integer"
|
|
},
|
|
"pickup_location_settings": {
|
|
"description": "WooCommerce Local Pickup Method Settings",
|
|
"type": "object"
|
|
},
|
|
"pickup_locations": {
|
|
"description": "WooCommerce Local Pickup Locations",
|
|
"type": "array"
|
|
},
|
|
"posts_per_page": {
|
|
"description": "Blog pages show at most.",
|
|
"type": "integer"
|
|
},
|
|
"show_on_front": {
|
|
"description": "What to show on the front page",
|
|
"type": "string"
|
|
},
|
|
"site_icon": {
|
|
"description": "Site icon.",
|
|
"type": "integer"
|
|
},
|
|
"site_logo": {
|
|
"description": "Site logo.",
|
|
"type": "integer"
|
|
},
|
|
"start_of_week": {
|
|
"description": "A day number of the week that the week should start on.",
|
|
"type": "integer"
|
|
},
|
|
"time_format": {
|
|
"description": "A time format for all time strings.",
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"description": "A city in the same timezone as you.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Site title.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "Site URL.",
|
|
"type": "string"
|
|
},
|
|
"use_smilies": {
|
|
"description": "Convert emoticons like :-) and :-P to graphics on display.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/settings"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/sidebars": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sidebar"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/sidebars/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a registered sidebar",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sidebar"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"widgets": {
|
|
"description": "Nested widgets.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sidebar"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"widgets": {
|
|
"description": "Nested widgets.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sidebar"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"widgets": {
|
|
"description": "Nested widgets.",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sidebar"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/statuses": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/status"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/statuses/{status}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "An alphanumeric identifier for the status.",
|
|
"in": "path",
|
|
"name": "status",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/status"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/tags": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by term attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide terms not assigned to any posts.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific post.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/tags/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as terms do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/tag"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/taxonomies": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to taxonomies associated with a specific post type.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/taxonomy"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/taxonomies/{taxonomy}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "An alphanumeric identifier for the taxonomy.",
|
|
"in": "path",
|
|
"name": "taxonomy",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/taxonomy"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit to the specified post ID.",
|
|
"in": "query",
|
|
"name": "wp_id",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit to the specified template part area.",
|
|
"in": "query",
|
|
"name": "area",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Post type for which to get the templates.",
|
|
"in": "query",
|
|
"name": "post_type",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"area": {
|
|
"description": "Where the template part is intended for use (header, footer, etc)",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts/lookup": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The slug of the template to get the fallback for",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Indicates if a template is custom or part of the template hierarchy",
|
|
"in": "query",
|
|
"name": "is_custom",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`",
|
|
"in": "query",
|
|
"name": "template_prefix",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"area": {
|
|
"description": "Where the template part is intended for use (header, footer, etc)",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"area": {
|
|
"description": "Where the template part is intended for use (header, footer, etc)",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"area": {
|
|
"description": "Where the template part is intended for use (header, footer, etc)",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"area": {
|
|
"description": "Where the template part is intended for use (header, footer, etc)",
|
|
"type": "string"
|
|
},
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/template-parts/{parent}/revisions/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as revisions do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template_part"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit to the specified post ID.",
|
|
"in": "query",
|
|
"name": "wp_id",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit to the specified template part area.",
|
|
"in": "query",
|
|
"name": "area",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Post type for which to get the templates.",
|
|
"in": "query",
|
|
"name": "post_type",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates/lookup": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The slug of the template to get the fallback for",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Indicates if a template is custom or part of the template hierarchy",
|
|
"in": "query",
|
|
"name": "is_custom",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`",
|
|
"in": "query",
|
|
"name": "template_prefix",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to bypass Bin and force deletion.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates/{id}/autosaves": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"author": {
|
|
"description": "The ID for the author of the template.",
|
|
"type": "integer"
|
|
},
|
|
"content": {
|
|
"description": "Content of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"description": {
|
|
"description": "Description of template.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "Unique slug identifying the template.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of template.",
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"description": "Theme identifier for the template.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Title of template.",
|
|
"type": [
|
|
"object",
|
|
"string"
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Type of template.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates/{parent}/autosaves/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "The ID for the autosave.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates/{parent}/revisions": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by object attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"date",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"relevance",
|
|
"slug",
|
|
"title"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/templates/{parent}/revisions/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as revisions do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The ID of a template",
|
|
"in": "path",
|
|
"name": "parent",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Unique identifier for the revision.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_template"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/themes": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Limit result set to themes assigned one or more statuses.",
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": [
|
|
"active",
|
|
"inactive"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/themes/{stylesheet}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The theme's style sheet. This uniquely identifies the theme.",
|
|
"in": "path",
|
|
"name": "stylesheet",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/theme"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/types": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/types/{type}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "An alphanumeric identifier for the post type.",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/users": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by user attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"email",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"registered_date",
|
|
"slug",
|
|
"url"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to users with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.",
|
|
"in": "query",
|
|
"name": "roles",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.",
|
|
"in": "query",
|
|
"name": "capabilities",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to users who are considered authors.",
|
|
"in": "query",
|
|
"name": "who",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"authors"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to users who have published posts.",
|
|
"in": "query",
|
|
"name": "has_published_posts",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"enum": {
|
|
"attachment": "attachment",
|
|
"nav_menu_item": "nav_menu_item",
|
|
"page": "page",
|
|
"post": "post",
|
|
"product": "product",
|
|
"wp_block": "wp_block",
|
|
"wp_font_face": "wp_font_face",
|
|
"wp_font_family": "wp_font_family",
|
|
"wp_global_styles": "wp_global_styles",
|
|
"wp_navigation": "wp_navigation",
|
|
"wp_template": "wp_template",
|
|
"wp_template_part": "wp_template_part"
|
|
},
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"password",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/users/me": {
|
|
"delete": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as users do not support binning.",
|
|
"type": "boolean"
|
|
},
|
|
"reassign": {
|
|
"description": "Reassign the deleted user's posts and links to this user ID.",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"reassign"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/users/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the user.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as users do not support binning.",
|
|
"type": "boolean"
|
|
},
|
|
"reassign": {
|
|
"description": "Reassign the deleted user's posts and links to this user ID.",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"reassign"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the user.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the user.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the user.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the user.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "Description of the user.",
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"description": "The email address for the user.",
|
|
"type": "string"
|
|
},
|
|
"first_name": {
|
|
"description": "First name for the user.",
|
|
"type": "string"
|
|
},
|
|
"last_name": {
|
|
"description": "Last name for the user.",
|
|
"type": "string"
|
|
},
|
|
"locale": {
|
|
"description": "Locale for the user.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Display name for the user.",
|
|
"type": "string"
|
|
},
|
|
"nickname": {
|
|
"description": "The nickname for the user.",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"description": "Password for the user (never included).",
|
|
"type": "string"
|
|
},
|
|
"roles": {
|
|
"description": "Roles assigned to the user.",
|
|
"type": "array"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the user.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL of the user.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Login name for the user.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/user"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/users/{user_id}/application-passwords": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"app_id": {
|
|
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the application password.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/users/{user_id}/application-passwords/introspect": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/users/{user_id}/application-passwords/{uuid}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "uuid",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "uuid",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "uuid",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"app_id": {
|
|
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the application password.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "uuid",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"app_id": {
|
|
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the application password.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "user_id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "uuid",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"app_id": {
|
|
"description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the application password.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/application-password"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/widget-types": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget-type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/widget-types/{id}": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "The widget type ID.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget-type"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/widget-types/{id}/encode": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The widget type ID.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"form_data": {
|
|
"description": "Serialised widget form data to encode into instance settings.",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"description": "Current instance settings of the widget.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/widget-types/{id}/render": {
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "The widget type ID.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"instance": {
|
|
"description": "Current instance settings of the widget.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/widgets": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "The sidebar for which to return widgets.",
|
|
"in": "query",
|
|
"name": "sidebar",
|
|
"required": false,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"form_data": {
|
|
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "Unique identifier for the widget.",
|
|
"type": "string"
|
|
},
|
|
"id_base": {
|
|
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"description": "Instance settings of the widget, if supported.",
|
|
"type": "object"
|
|
},
|
|
"sidebar": {
|
|
"description": "The sidebar to which the widget belongs.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sidebar"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/widgets/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Whether to force removal of the widget, or move it to the inactive sidebar.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the widget.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"form_data": {
|
|
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
|
|
"type": "string"
|
|
},
|
|
"id_base": {
|
|
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"description": "Instance settings of the widget, if supported.",
|
|
"type": "object"
|
|
},
|
|
"sidebar": {
|
|
"description": "The sidebar to which the widget belongs.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the widget.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"form_data": {
|
|
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
|
|
"type": "string"
|
|
},
|
|
"id_base": {
|
|
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"description": "Instance settings of the widget, if supported.",
|
|
"type": "object"
|
|
},
|
|
"sidebar": {
|
|
"description": "The sidebar to which the widget belongs.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the widget.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"form_data": {
|
|
"description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.",
|
|
"type": "string"
|
|
},
|
|
"id_base": {
|
|
"description": "The type of the widget. Corresponds to ID in widget-types endpoint.",
|
|
"type": "string"
|
|
},
|
|
"instance": {
|
|
"description": "Instance settings of the widget, if supported.",
|
|
"type": "object"
|
|
},
|
|
"sidebar": {
|
|
"description": "The sidebar to which the widget belongs.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/widget"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/wp_pattern_category": {
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Current page of the collection.",
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Maximum number of items to be returned in result set.",
|
|
"in": "query",
|
|
"name": "per_page",
|
|
"required": false,
|
|
"schema": {
|
|
"maximum": 100,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit results to those matching a string.",
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Ensure result set excludes specific IDs.",
|
|
"in": "query",
|
|
"name": "exclude",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Limit result set to specific IDs.",
|
|
"in": "query",
|
|
"name": "include",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"description": "Offset the result set by a specific number of items.",
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Order sort attribute ascending or descending.",
|
|
"in": "query",
|
|
"name": "order",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Sort collection by term attribute.",
|
|
"in": "query",
|
|
"name": "orderby",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"count",
|
|
"description",
|
|
"id",
|
|
"include",
|
|
"include_slugs",
|
|
"name",
|
|
"slug",
|
|
"term_group"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"description": "Whether to hide terms not assigned to any posts.",
|
|
"in": "query",
|
|
"name": "hide_empty",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms assigned to a specific post.",
|
|
"in": "query",
|
|
"name": "post",
|
|
"required": false,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Limit result set to terms with one or more specific slugs.",
|
|
"in": "query",
|
|
"name": "slug",
|
|
"required": false,
|
|
"schema": {
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/wp/v2/wp_pattern_category/{id}": {
|
|
"delete": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"force": {
|
|
"description": "Required to be true, as terms do not support binning.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
},
|
|
{
|
|
"description": "Scope under which the request is made; determines fields present in response.",
|
|
"in": "query",
|
|
"name": "context",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"edit",
|
|
"embed",
|
|
"view"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"parameters": [
|
|
{
|
|
"description": "Unique identifier for the term.",
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true,
|
|
"schema": {}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"description": "HTML description of the term.",
|
|
"type": "string"
|
|
},
|
|
"meta": {
|
|
"description": "Meta fields.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "HTML title for the term.",
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"description": "An alphanumeric identifier for the term unique to its type.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/wp_pattern_category"
|
|
}
|
|
}
|
|
},
|
|
"description": "OK"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [],
|
|
"servers": [
|
|
{
|
|
"url": "https:/haikuatelier.fr.ddev.site/wp-json"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"description": "",
|
|
"name": "wc/v3"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wp-openapi/v1"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "jetpack/v4"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc-admin"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc-analytics"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc/store"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc/store/v1"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc/private"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc/v1"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc/v2"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wc-telemetry"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wccom-site/v3"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "carbon-fields/v1"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wp/v2"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wp-site-health/v1"
|
|
},
|
|
{
|
|
"description": "",
|
|
"name": "wp-block-editor/v1"
|
|
}
|
|
]
|
|
}
|