Skip to content

Instantly share code, notes, and snippets.

@keithweaver

keithweaver/swagger.yml

Last active June 19, 2023 18:17
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save keithweaver/1936cc3cbaf67f59e97aa73f01d2bfbd to your computer and use it in GitHub Desktop.
Save keithweaver/1936cc3cbaf67f59e97aa73f01d2bfbd to your computer and use it in GitHub Desktop.
Download ZIP
Woo Commerce API as Swagger
Raw
swagger.yml
openapi: 3.0.0
info:
title: WooCommerce REST API
version: 1.0.0
servers:
- url: http://{{baseurl}}
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
security:
- basicAuth: []
tags:
- name: coupons
- name: coupons > {id}
- name: coupons > batch
- name: customers
- name: customers > {id}
- name: customers > batch
- name: orders
- name: orders > {order id}
- name: orders > {order id} > notes
- name: orders > {order id} > notes > {id}
- name: orders > {order id} > refunds
- name: orders > {order id} > refunds > {id}
- name: orders > {id}
- name: orders > batch
- name: products
- name: products > attributes
- name: products > attributes > {attribute id}/terms
- name: products > attributes > {attribute id}/terms > {id}
- name: products > attributes > {attribute id}/terms > batch
- name: products > attributes > {id}
- name: products > attributes > batch
- name: products > categories
- name: products > categories > {id}
- name: products > categories > batch
- name: products > reviews
- name: products > reviews > {id}
- name: products > reviews > batch
- name: products > shipping classes
- name: products > shipping classes > {id}
- name: products > shipping classes > batch
- name: products > tags
- name: products > tags > {id}
- name: products > tags > batch
- name: products > {id}
- name: products > batch
- name: products > {product id}/variations
- name: products > {product id}/variations > {id}
- name: products > {product id}/variations > batch
- name: reports
- name: settings
- name: settings > batch
- name: settings > {group id}
- name: settings > {group id} > batch
- name: settings > {group id} > {id}
- name: shipping/zones
- name: shipping/zones > {id}
- name: shipping/zones > {id} > locations
- name: shipping/zones > {zone id}/methods
- name: shipping/zones > {zone id}/methods > {instance id}
- name: taxes
- name: taxes > classes
- name: taxes > {id}
- name: taxes > batch
- name: webhooks
- name: webhooks > {id}
- name: webhooks > batch
- name: system status
- name: system status > tools
- name: system status > tools > {id}
- name: shipping methods
- name: payment gateways
- name: payment gateways > {id}
- name: data
- name: data > continents
- name: data > countries
- name: data > currencies
paths:
/wc/v3/coupons/{id}:
get:
tags:
- coupons > {id}
summary: /wc/v3/coupons/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- coupons > {id}
summary: /wc/v3/coupons/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
code:
type: string
description: Coupon code.
example: <string>
amount:
type: string
description: >-
The amount of discount. Should always be numeric, even if
setting a percentage.
example: <string>
discount_type:
type: string
description: Determines the type of discount that will be applied.
example: '["<string>","<string>"]'
description:
type: string
description: Coupon description.
example: <string>
date_expires:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
date_expires_gmt:
type: string
description: The date the coupon expires, as GMT.
example: <string>
individual_use:
type: string
description: >-
If true, the coupon can only be used individually. Other
applied coupons will be removed from the cart.
example: <string>
product_ids:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
excluded_product_ids:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
usage_limit:
type: string
description: How many times the coupon can be used in total.
example: <string>
usage_limit_per_user:
type: string
description: How many times the coupon can be used per customer.
example: <string>
limit_usage_to_x_items:
type: string
description: >-
Max number of items in the cart the coupon can be applied
to.
example: <string>
free_shipping:
type: string
description: >-
If true and if the free shipping method requires a coupon,
this coupon will enable free shipping.
example: <string>
product_categories:
type: string
description: List of category IDs the coupon applies to.
example: <string>
excluded_product_categories:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
exclude_sale_items:
type: string
description: >-
If true, this coupon will not be applied to items that have
sale prices.
example: <string>
minimum_amount:
type: string
description: >-
Minimum order amount that needs to be in the cart before
coupon applies.
example: <string>
maximum_amount:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
email_restrictions:
type: string
description: List of email addresses that can use this coupon.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- coupons > {id}
summary: /wc/v3/coupons/:id
requestBody:
content: {}
parameters:
- name: code
in: query
schema:
type: string
description: Coupon code.
example: <string>
- name: amount
in: query
schema:
type: string
description: >-
The amount of discount. Should always be numeric, even if setting a
percentage.
example: <string>
- name: discount_type
in: query
schema:
type: string
description: Determines the type of discount that will be applied.
example: <string>
- name: description
in: query
schema:
type: string
description: Coupon description.
example: <string>
- name: date_expires
in: query
schema:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
- name: date_expires_gmt
in: query
schema:
type: string
description: The date the coupon expires, as GMT.
example: <string>
- name: individual_use
in: query
schema:
type: string
description: >-
If true, the coupon can only be used individually. Other applied
coupons will be removed from the cart.
example: <string>
- name: product_ids
in: query
schema:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
- name: excluded_product_ids
in: query
schema:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
- name: usage_limit
in: query
schema:
type: string
description: How many times the coupon can be used in total.
example: <string>
- name: usage_limit_per_user
in: query
schema:
type: string
description: How many times the coupon can be used per customer.
example: <string>
- name: limit_usage_to_x_items
in: query
schema:
type: string
description: Max number of items in the cart the coupon can be applied to.
example: <string>
- name: free_shipping
in: query
schema:
type: string
description: >-
If true and if the free shipping method requires a coupon, this
coupon will enable free shipping.
example: <string>
- name: product_categories
in: query
schema:
type: string
description: List of category IDs the coupon applies to.
example: <string>
- name: excluded_product_categories
in: query
schema:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
- name: exclude_sale_items
in: query
schema:
type: string
description: >-
If true, this coupon will not be applied to items that have sale
prices.
example: <string>
- name: minimum_amount
in: query
schema:
type: string
description: >-
Minimum order amount that needs to be in the cart before coupon
applies.
example: <string>
- name: maximum_amount
in: query
schema:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
- name: email_restrictions
in: query
schema:
type: string
description: List of email addresses that can use this coupon.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- coupons > {id}
summary: /wc/v3/coupons/:id
requestBody:
content: {}
parameters:
- name: code
in: query
schema:
type: string
description: Coupon code.
example: <string>
- name: amount
in: query
schema:
type: string
description: >-
The amount of discount. Should always be numeric, even if setting a
percentage.
example: <string>
- name: discount_type
in: query
schema:
type: string
description: Determines the type of discount that will be applied.
example: <string>
- name: description
in: query
schema:
type: string
description: Coupon description.
example: <string>
- name: date_expires
in: query
schema:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
- name: date_expires_gmt
in: query
schema:
type: string
description: The date the coupon expires, as GMT.
example: <string>
- name: individual_use
in: query
schema:
type: string
description: >-
If true, the coupon can only be used individually. Other applied
coupons will be removed from the cart.
example: <string>
- name: product_ids
in: query
schema:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
- name: excluded_product_ids
in: query
schema:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
- name: usage_limit
in: query
schema:
type: string
description: How many times the coupon can be used in total.
example: <string>
- name: usage_limit_per_user
in: query
schema:
type: string
description: How many times the coupon can be used per customer.
example: <string>
- name: limit_usage_to_x_items
in: query
schema:
type: string
description: Max number of items in the cart the coupon can be applied to.
example: <string>
- name: free_shipping
in: query
schema:
type: string
description: >-
If true and if the free shipping method requires a coupon, this
coupon will enable free shipping.
example: <string>
- name: product_categories
in: query
schema:
type: string
description: List of category IDs the coupon applies to.
example: <string>
- name: excluded_product_categories
in: query
schema:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
- name: exclude_sale_items
in: query
schema:
type: string
description: >-
If true, this coupon will not be applied to items that have sale
prices.
example: <string>
- name: minimum_amount
in: query
schema:
type: string
description: >-
Minimum order amount that needs to be in the cart before coupon
applies.
example: <string>
- name: maximum_amount
in: query
schema:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
- name: email_restrictions
in: query
schema:
type: string
description: List of email addresses that can use this coupon.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- coupons > {id}
summary: /wc/v3/coupons/:id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/coupons/batch:
post:
tags:
- coupons > batch
summary: /wc/v3/coupons/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
code:
type: string
description: Coupon code.
example: <string>
amount:
type: string
description: >-
The amount of discount. Should always be numeric, even if
setting a percentage.
example: <string>
discount_type:
type: string
description: Determines the type of discount that will be applied.
example: '["<string>","<string>"]'
description:
type: string
description: Coupon description.
example: <string>
date_expires:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
date_expires_gmt:
type: string
description: The date the coupon expires, as GMT.
example: <string>
individual_use:
type: string
description: >-
If true, the coupon can only be used individually. Other
applied coupons will be removed from the cart.
example: <string>
product_ids:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
excluded_product_ids:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
usage_limit:
type: string
description: How many times the coupon can be used in total.
example: <string>
usage_limit_per_user:
type: string
description: How many times the coupon can be used per customer.
example: <string>
limit_usage_to_x_items:
type: string
description: >-
Max number of items in the cart the coupon can be applied
to.
example: <string>
free_shipping:
type: string
description: >-
If true and if the free shipping method requires a coupon,
this coupon will enable free shipping.
example: <string>
product_categories:
type: string
description: List of category IDs the coupon applies to.
example: <string>
excluded_product_categories:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
exclude_sale_items:
type: string
description: >-
If true, this coupon will not be applied to items that have
sale prices.
example: <string>
minimum_amount:
type: string
description: >-
Minimum order amount that needs to be in the cart before
coupon applies.
example: <string>
maximum_amount:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
email_restrictions:
type: string
description: List of email addresses that can use this coupon.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- coupons > batch
summary: /wc/v3/coupons/batch
requestBody:
content: {}
parameters:
- name: code
in: query
schema:
type: string
description: Coupon code.
example: <string>
- name: amount
in: query
schema:
type: string
description: >-
The amount of discount. Should always be numeric, even if setting a
percentage.
example: <string>
- name: discount_type
in: query
schema:
type: string
description: Determines the type of discount that will be applied.
example: <string>
- name: description
in: query
schema:
type: string
description: Coupon description.
example: <string>
- name: date_expires
in: query
schema:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
- name: date_expires_gmt
in: query
schema:
type: string
description: The date the coupon expires, as GMT.
example: <string>
- name: individual_use
in: query
schema:
type: string
description: >-
If true, the coupon can only be used individually. Other applied
coupons will be removed from the cart.
example: <string>
- name: product_ids
in: query
schema:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
- name: excluded_product_ids
in: query
schema:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
- name: usage_limit
in: query
schema:
type: string
description: How many times the coupon can be used in total.
example: <string>
- name: usage_limit_per_user
in: query
schema:
type: string
description: How many times the coupon can be used per customer.
example: <string>
- name: limit_usage_to_x_items
in: query
schema:
type: string
description: Max number of items in the cart the coupon can be applied to.
example: <string>
- name: free_shipping
in: query
schema:
type: string
description: >-
If true and if the free shipping method requires a coupon, this
coupon will enable free shipping.
example: <string>
- name: product_categories
in: query
schema:
type: string
description: List of category IDs the coupon applies to.
example: <string>
- name: excluded_product_categories
in: query
schema:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
- name: exclude_sale_items
in: query
schema:
type: string
description: >-
If true, this coupon will not be applied to items that have sale
prices.
example: <string>
- name: minimum_amount
in: query
schema:
type: string
description: >-
Minimum order amount that needs to be in the cart before coupon
applies.
example: <string>
- name: maximum_amount
in: query
schema:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
- name: email_restrictions
in: query
schema:
type: string
description: List of email addresses that can use this coupon.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- coupons > batch
summary: /wc/v3/coupons/batch
requestBody:
content: {}
parameters:
- name: code
in: query
schema:
type: string
description: Coupon code.
example: <string>
- name: amount
in: query
schema:
type: string
description: >-
The amount of discount. Should always be numeric, even if setting a
percentage.
example: <string>
- name: discount_type
in: query
schema:
type: string
description: Determines the type of discount that will be applied.
example: <string>
- name: description
in: query
schema:
type: string
description: Coupon description.
example: <string>
- name: date_expires
in: query
schema:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
- name: date_expires_gmt
in: query
schema:
type: string
description: The date the coupon expires, as GMT.
example: <string>
- name: individual_use
in: query
schema:
type: string
description: >-
If true, the coupon can only be used individually. Other applied
coupons will be removed from the cart.
example: <string>
- name: product_ids
in: query
schema:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
- name: excluded_product_ids
in: query
schema:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
- name: usage_limit
in: query
schema:
type: string
description: How many times the coupon can be used in total.
example: <string>
- name: usage_limit_per_user
in: query
schema:
type: string
description: How many times the coupon can be used per customer.
example: <string>
- name: limit_usage_to_x_items
in: query
schema:
type: string
description: Max number of items in the cart the coupon can be applied to.
example: <string>
- name: free_shipping
in: query
schema:
type: string
description: >-
If true and if the free shipping method requires a coupon, this
coupon will enable free shipping.
example: <string>
- name: product_categories
in: query
schema:
type: string
description: List of category IDs the coupon applies to.
example: <string>
- name: excluded_product_categories
in: query
schema:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
- name: exclude_sale_items
in: query
schema:
type: string
description: >-
If true, this coupon will not be applied to items that have sale
prices.
example: <string>
- name: minimum_amount
in: query
schema:
type: string
description: >-
Minimum order amount that needs to be in the cart before coupon
applies.
example: <string>
- name: maximum_amount
in: query
schema:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
- name: email_restrictions
in: query
schema:
type: string
description: List of email addresses that can use this coupon.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/coupons:
get:
tags:
- coupons
summary: /wc/v3/coupons
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to resources published before a given ISO8601
compliant date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date
- name: code
in: query
schema:
type: string
description: Limit result set to resources with a specific code.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- coupons
summary: /wc/v3/coupons
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
code:
type: string
description: Coupon code.
example: <string>
amount:
type: string
description: >-
The amount of discount. Should always be numeric, even if
setting a percentage.
example: <string>
discount_type:
type: string
description: Determines the type of discount that will be applied.
example: '["fixed_cart","fixed_cart"]'
description:
type: string
description: Coupon description.
example: <string>
date_expires:
type: string
description: The date the coupon expires, in the site's timezone.
example: <string>
date_expires_gmt:
type: string
description: The date the coupon expires, as GMT.
example: <string>
individual_use:
type: string
description: >-
If true, the coupon can only be used individually. Other
applied coupons will be removed from the cart.
example: <string>
product_ids:
type: string
description: List of product IDs the coupon can be used on.
example: <string>
excluded_product_ids:
type: string
description: List of product IDs the coupon cannot be used on.
example: <string>
usage_limit:
type: string
description: How many times the coupon can be used in total.
example: <string>
usage_limit_per_user:
type: string
description: How many times the coupon can be used per customer.
example: <string>
limit_usage_to_x_items:
type: string
description: >-
Max number of items in the cart the coupon can be applied
to.
example: <string>
free_shipping:
type: string
description: >-
If true and if the free shipping method requires a coupon,
this coupon will enable free shipping.
example: <string>
product_categories:
type: string
description: List of category IDs the coupon applies to.
example: <string>
excluded_product_categories:
type: string
description: List of category IDs the coupon does not apply to.
example: <string>
exclude_sale_items:
type: string
description: >-
If true, this coupon will not be applied to items that have
sale prices.
example: <string>
minimum_amount:
type: string
description: >-
Minimum order amount that needs to be in the cart before
coupon applies.
example: <string>
maximum_amount:
type: string
description: Maximum order amount allowed when using the coupon.
example: <string>
email_restrictions:
type: string
description: List of email addresses that can use this coupon.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/customers/{id}:
get:
tags:
- customers > {id}
summary: /wc/v3/customers/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- customers > {id}
summary: /wc/v3/customers/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
email:
type: string
description: The email address for the customer.
example: <email>
first_name:
type: string
description: Customer first name.
example: <string>
last_name:
type: string
description: Customer last name.
example: <string>
username:
type: string
description: Customer login name.
example: <string>
password:
type: string
description: Customer password.
example: <string>
billing:
type: string
description: List of billing address data.
example: <string>
shipping:
type: string
description: List of shipping address data.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- customers > {id}
summary: /wc/v3/customers/:id
requestBody:
content: {}
parameters:
- name: email
in: query
schema:
type: string
description: The email address for the customer.
example: <email>
- name: first_name
in: query
schema:
type: string
description: Customer first name.
example: <string>
- name: last_name
in: query
schema:
type: string
description: Customer last name.
example: <string>
- name: username
in: query
schema:
type: string
description: Customer login name.
example: <string>
- name: password
in: query
schema:
type: string
description: Customer password.
example: <string>
- name: billing
in: query
schema:
type: string
description: List of billing address data.
example: <string>
- name: shipping
in: query
schema:
type: string
description: List of shipping address data.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- customers > {id}
summary: /wc/v3/customers/:id
requestBody:
content: {}
parameters:
- name: email
in: query
schema:
type: string
description: The email address for the customer.
example: <email>
- name: first_name
in: query
schema:
type: string
description: Customer first name.
example: <string>
- name: last_name
in: query
schema:
type: string
description: Customer last name.
example: <string>
- name: username
in: query
schema:
type: string
description: Customer login name.
example: <string>
- name: password
in: query
schema:
type: string
description: Customer password.
example: <string>
- name: billing
in: query
schema:
type: string
description: List of billing address data.
example: <string>
- name: shipping
in: query
schema:
type: string
description: List of shipping address data.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- customers > {id}
summary: /wc/v3/customers/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: reassign
in: query
schema:
type: string
description: ID to reassign posts to.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/customers/batch:
post:
tags:
- customers > batch
summary: /wc/v3/customers/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
email:
type: string
description: The email address for the customer.
example: <email>
first_name:
type: string
description: Customer first name.
example: <string>
last_name:
type: string
description: Customer last name.
example: <string>
username:
type: string
description: Customer login name.
example: <string>
password:
type: string
description: Customer password.
example: <string>
billing:
type: string
description: List of billing address data.
example: <string>
shipping:
type: string
description: List of shipping address data.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- customers > batch
summary: /wc/v3/customers/batch
requestBody:
content: {}
parameters:
- name: email
in: query
schema:
type: string
description: The email address for the customer.
example: <email>
- name: first_name
in: query
schema:
type: string
description: Customer first name.
example: <string>
- name: last_name
in: query
schema:
type: string
description: Customer last name.
example: <string>
- name: username
in: query
schema:
type: string
description: Customer login name.
example: <string>
- name: password
in: query
schema:
type: string
description: Customer password.
example: <string>
- name: billing
in: query
schema:
type: string
description: List of billing address data.
example: <string>
- name: shipping
in: query
schema:
type: string
description: List of shipping address data.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- customers > batch
summary: /wc/v3/customers/batch
requestBody:
content: {}
parameters:
- name: email
in: query
schema:
type: string
description: The email address for the customer.
example: <email>
- name: first_name
in: query
schema:
type: string
description: Customer first name.
example: <string>
- name: last_name
in: query
schema:
type: string
description: Customer last name.
example: <string>
- name: username
in: query
schema:
type: string
description: Customer login name.
example: <string>
- name: password
in: query
schema:
type: string
description: Customer password.
example: <string>
- name: billing
in: query
schema:
type: string
description: List of billing address data.
example: <string>
- name: shipping
in: query
schema:
type: string
description: List of shipping address data.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/customers:
get:
tags:
- customers
summary: /wc/v3/customers
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific IDs.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: asc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: name
- name: email
in: query
schema:
type: string
description: Limit result set to resources with a specific email.
example: <email>
- name: role
in: query
schema:
type: string
description: Limit result set to resources with a specific role.
example: customer
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- customers
summary: /wc/v3/customers Copy
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
email:
type: string
description: New user email address.
example: <string>
first_name:
type: string
description: Customer first name.
example: <string>
last_name:
type: string
description: Customer last name.
example: <string>
username:
type: string
description: New user username.
example: <string>
password:
type: string
description: New user password.
example: <string>
billing:
type: string
description: List of billing address data.
example: <string>
shipping:
type: string
description: List of shipping address data.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/customers/{customer_id}/downloads:
get:
tags:
- customers
summary: /wc/v3/customers/:customer_id/downloads
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: customer_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders/{order_id}/notes/{id}:
get:
tags:
- orders > {order id} > notes > {id}
summary: /wc/v3/orders/:order_id/notes/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- orders > {order id} > notes > {id}
summary: /wc/v3/orders/:order_id/notes/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders/{order_id}/notes:
get:
tags:
- orders > {order id} > notes
summary: /wc/v3/orders/:order_id/notes
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: type
in: query
schema:
type: string
description: Limit result to customers or internal notes.
example: any
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- orders > {order id} > notes
summary: /wc/v3/orders/:order_id/notes
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
note:
type: string
description: Order note content.
example: <string>
customer_note:
type: string
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.
example: <string>
added_by_user:
type: string
description: >-
If true, this note will be attributed to the current user.
If false, the note will be attributed to the system.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders/{order_id}/refunds/{id}:
get:
tags:
- orders > {order id} > refunds > {id}
summary: /wc/v3/orders/:order_id/refunds/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- orders > {order id} > refunds > {id}
summary: /wc/v3/orders/:order_id/refunds/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders/{order_id}/refunds:
get:
tags:
- orders > {order id} > refunds
summary: /wc/v3/orders/:order_id/refunds
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to resources published before a given ISO8601
compliant date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date
- name: parent
in: query
schema:
type: string
description: Limit result set to those of particular parent IDs.
example: <string>
- name: parent_exclude
in: query
schema:
type: string
description: >-
Limit result set to all items except those of a particular parent
ID.
example: <string>
- name: dp
in: query
schema:
type: string
description: Number of decimal points to use in each resource.
example: <string>
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- orders > {order id} > refunds
summary: /wc/v3/orders/:order_id/refunds
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
amount:
type: string
description: Refund amount.
example: <string>
reason:
type: string
description: Reason for refund.
example: <string>
refunded_by:
type: string
description: User ID of user who created the refund.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
api_refund:
type: string
description: >-
When true, the payment gateway API is used to generate the
refund.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: order_id
in: path
schema:
type: string
required: true
description: (Required) The order ID.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders/{id}:
get:
tags:
- orders > {id}
summary: /wc/v3/orders/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- orders > {id}
summary: /wc/v3/orders/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
parent_id:
type: string
description: Parent order ID.
example: <string>
status:
type: string
description: Order status.
example: '["<string>","<string>"]'
currency:
type: string
description: Currency the order was created with, in ISO format.
example: '["<string>","<string>"]'
customer_id:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
customer_note:
type: string
description: Note left by customer during checkout.
example: <string>
billing:
type: string
description: Billing address.
example: <string>
shipping:
type: string
description: Shipping address.
example: <string>
payment_method:
type: string
description: Payment method ID.
example: <string>
payment_method_title:
type: string
description: Payment method title.
example: <string>
transaction_id:
type: string
description: Unique transaction ID.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
line_items:
type: string
description: Line items data.
example: <string>
shipping_lines:
type: string
description: Shipping lines data.
example: <string>
fee_lines:
type: string
description: Fee lines data.
example: <string>
coupon_lines:
type: string
description: Coupons line data.
example: <string>
set_paid:
type: string
description: >-
Define if the order is paid. It will set the status to
processing and reduce stock items.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- orders > {id}
summary: /wc/v3/orders/:id
requestBody:
content: {}
parameters:
- name: parent_id
in: query
schema:
type: string
description: Parent order ID.
example: <string>
- name: status
in: query
schema:
type: string
description: Order status.
example: <string>
- name: currency
in: query
schema:
type: string
description: Currency the order was created with, in ISO format.
example: <string>
- name: customer_id
in: query
schema:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
- name: customer_note
in: query
schema:
type: string
description: Note left by customer during checkout.
example: <string>
- name: billing
in: query
schema:
type: string
description: Billing address.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Shipping address.
example: <string>
- name: payment_method
in: query
schema:
type: string
description: Payment method ID.
example: <string>
- name: payment_method_title
in: query
schema:
type: string
description: Payment method title.
example: <string>
- name: transaction_id
in: query
schema:
type: string
description: Unique transaction ID.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: line_items
in: query
schema:
type: string
description: Line items data.
example: <string>
- name: shipping_lines
in: query
schema:
type: string
description: Shipping lines data.
example: <string>
- name: fee_lines
in: query
schema:
type: string
description: Fee lines data.
example: <string>
- name: coupon_lines
in: query
schema:
type: string
description: Coupons line data.
example: <string>
- name: set_paid
in: query
schema:
type: string
description: >-
Define if the order is paid. It will set the status to processing
and reduce stock items.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- orders > {id}
summary: /wc/v3/orders/:id
requestBody:
content: {}
parameters:
- name: parent_id
in: query
schema:
type: string
description: Parent order ID.
example: <string>
- name: status
in: query
schema:
type: string
description: Order status.
example: <string>
- name: currency
in: query
schema:
type: string
description: Currency the order was created with, in ISO format.
example: <string>
- name: customer_id
in: query
schema:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
- name: customer_note
in: query
schema:
type: string
description: Note left by customer during checkout.
example: <string>
- name: billing
in: query
schema:
type: string
description: Billing address.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Shipping address.
example: <string>
- name: payment_method
in: query
schema:
type: string
description: Payment method ID.
example: <string>
- name: payment_method_title
in: query
schema:
type: string
description: Payment method title.
example: <string>
- name: transaction_id
in: query
schema:
type: string
description: Unique transaction ID.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: line_items
in: query
schema:
type: string
description: Line items data.
example: <string>
- name: shipping_lines
in: query
schema:
type: string
description: Shipping lines data.
example: <string>
- name: fee_lines
in: query
schema:
type: string
description: Fee lines data.
example: <string>
- name: coupon_lines
in: query
schema:
type: string
description: Coupons line data.
example: <string>
- name: set_paid
in: query
schema:
type: string
description: >-
Define if the order is paid. It will set the status to processing
and reduce stock items.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- orders > {id}
summary: /wc/v3/orders/:id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders/batch:
post:
tags:
- orders > batch
summary: /wc/v3/orders/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
parent_id:
type: string
description: Parent order ID.
example: <string>
status:
type: string
description: Order status.
example: '["<string>","<string>"]'
currency:
type: string
description: Currency the order was created with, in ISO format.
example: '["<string>","<string>"]'
customer_id:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
customer_note:
type: string
description: Note left by customer during checkout.
example: <string>
billing:
type: string
description: Billing address.
example: <string>
shipping:
type: string
description: Shipping address.
example: <string>
payment_method:
type: string
description: Payment method ID.
example: <string>
payment_method_title:
type: string
description: Payment method title.
example: <string>
transaction_id:
type: string
description: Unique transaction ID.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
line_items:
type: string
description: Line items data.
example: <string>
shipping_lines:
type: string
description: Shipping lines data.
example: <string>
fee_lines:
type: string
description: Fee lines data.
example: <string>
coupon_lines:
type: string
description: Coupons line data.
example: <string>
set_paid:
type: string
description: >-
Define if the order is paid. It will set the status to
processing and reduce stock items.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- orders > batch
summary: /wc/v3/orders/batch
requestBody:
content: {}
parameters:
- name: parent_id
in: query
schema:
type: string
description: Parent order ID.
example: <string>
- name: status
in: query
schema:
type: string
description: Order status.
example: <string>
- name: currency
in: query
schema:
type: string
description: Currency the order was created with, in ISO format.
example: <string>
- name: customer_id
in: query
schema:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
- name: customer_note
in: query
schema:
type: string
description: Note left by customer during checkout.
example: <string>
- name: billing
in: query
schema:
type: string
description: Billing address.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Shipping address.
example: <string>
- name: payment_method
in: query
schema:
type: string
description: Payment method ID.
example: <string>
- name: payment_method_title
in: query
schema:
type: string
description: Payment method title.
example: <string>
- name: transaction_id
in: query
schema:
type: string
description: Unique transaction ID.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: line_items
in: query
schema:
type: string
description: Line items data.
example: <string>
- name: shipping_lines
in: query
schema:
type: string
description: Shipping lines data.
example: <string>
- name: fee_lines
in: query
schema:
type: string
description: Fee lines data.
example: <string>
- name: coupon_lines
in: query
schema:
type: string
description: Coupons line data.
example: <string>
- name: set_paid
in: query
schema:
type: string
description: >-
Define if the order is paid. It will set the status to processing
and reduce stock items.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- orders > batch
summary: /wc/v3/orders/batch
requestBody:
content: {}
parameters:
- name: parent_id
in: query
schema:
type: string
description: Parent order ID.
example: <string>
- name: status
in: query
schema:
type: string
description: Order status.
example: <string>
- name: currency
in: query
schema:
type: string
description: Currency the order was created with, in ISO format.
example: <string>
- name: customer_id
in: query
schema:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
- name: customer_note
in: query
schema:
type: string
description: Note left by customer during checkout.
example: <string>
- name: billing
in: query
schema:
type: string
description: Billing address.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Shipping address.
example: <string>
- name: payment_method
in: query
schema:
type: string
description: Payment method ID.
example: <string>
- name: payment_method_title
in: query
schema:
type: string
description: Payment method title.
example: <string>
- name: transaction_id
in: query
schema:
type: string
description: Unique transaction ID.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: line_items
in: query
schema:
type: string
description: Line items data.
example: <string>
- name: shipping_lines
in: query
schema:
type: string
description: Shipping lines data.
example: <string>
- name: fee_lines
in: query
schema:
type: string
description: Fee lines data.
example: <string>
- name: coupon_lines
in: query
schema:
type: string
description: Coupons line data.
example: <string>
- name: set_paid
in: query
schema:
type: string
description: >-
Define if the order is paid. It will set the status to processing
and reduce stock items.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/orders:
get:
tags:
- orders
summary: /wc/v3/orders
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to resources published before a given ISO8601
compliant date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date
- name: parent
in: query
schema:
type: string
description: Limit result set to those of particular parent IDs.
example: <string>
- name: parent_exclude
in: query
schema:
type: string
description: >-
Limit result set to all items except those of a particular parent
ID.
example: <string>
- name: status
in: query
schema:
type: string
description: Limit result set to orders which have specific statuses.
example: <string>
- name: customer
in: query
schema:
type: string
description: Limit result set to orders assigned a specific customer.
example: <string>
- name: product
in: query
schema:
type: string
description: Limit result set to orders assigned a specific product.
example: <string>
- name: dp
in: query
schema:
type: string
description: Number of decimal points to use in each resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- orders
summary: /wc/v3/orders
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
parent_id:
type: string
description: Parent order ID.
example: <string>
status:
type: string
description: Order status.
example: '["pending","pending"]'
currency:
type: string
description: Currency the order was created with, in ISO format.
example: '["USD","USD"]'
customer_id:
type: string
description: User ID who owns the order. 0 for guests.
example: <string>
customer_note:
type: string
description: Note left by customer during checkout.
example: <string>
billing:
type: string
description: Billing address.
example: <string>
shipping:
type: string
description: Shipping address.
example: <string>
payment_method:
type: string
description: Payment method ID.
example: <string>
payment_method_title:
type: string
description: Payment method title.
example: <string>
transaction_id:
type: string
description: Unique transaction ID.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
line_items:
type: string
description: Line items data.
example: <string>
shipping_lines:
type: string
description: Shipping lines data.
example: <string>
fee_lines:
type: string
description: Fee lines data.
example: <string>
coupon_lines:
type: string
description: Coupons line data.
example: <string>
set_paid:
type: string
description: >-
Define if the order is paid. It will set the status to
processing and reduce stock items.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/attributes/{attribute_id}/terms/{id}:
get:
tags:
- products > attributes > {attribute id}/terms > {id}
summary: /wc/v3/products/attributes/:attribute_id/terms/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > attributes > {attribute id}/terms > {id}
summary: /wc/v3/products/attributes/:attribute_id/terms/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Term name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > attributes > {attribute id}/terms > {id}
summary: /wc/v3/products/attributes/:attribute_id/terms/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Term name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > attributes > {attribute id}/terms > {id}
summary: /wc/v3/products/attributes/:attribute_id/terms/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Term name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > attributes > {attribute id}/terms > {id}
summary: /wc/v3/products/attributes/:attribute_id/terms/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/attributes/{attribute_id}/terms/batch:
post:
tags:
- products > attributes > {attribute id}/terms > batch
summary: /wc/v3/products/attributes/:attribute_id/terms/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Term name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > attributes > {attribute id}/terms > batch
summary: /wc/v3/products/attributes/:attribute_id/terms/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Term name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > attributes > {attribute id}/terms > batch
summary: /wc/v3/products/attributes/:attribute_id/terms/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Term name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/attributes/{attribute_id}/terms:
get:
tags:
- products > attributes > {attribute id}/terms
summary: /wc/v3/products/attributes/:attribute_id/terms
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: asc
- name: orderby
in: query
schema:
type: string
description: Sort collection by resource attribute.
example: name
- name: hide_empty
in: query
schema:
type: string
description: Whether to hide resources not assigned to any products.
example: <string>
- name: parent
in: query
schema:
type: string
description: Limit result set to resources assigned to a specific parent.
example: <string>
- name: product
in: query
schema:
type: string
description: Limit result set to resources assigned to a specific product.
example: <string>
- name: slug
in: query
schema:
type: string
description: Limit result set to resources with a specific slug.
example: <string>
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > attributes > {attribute id}/terms
summary: /wc/v3/products/attributes/:attribute_id/terms
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Name for the resource.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: attribute_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the attribute of the terms.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/attributes/{id}:
get:
tags:
- products > attributes > {id}
summary: /wc/v3/products/attributes/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > attributes > {id}
summary: /wc/v3/products/attributes/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Attribute name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
type:
type: string
description: Type of attribute.
example: '["<string>","<string>"]'
order_by:
type: string
description: Default sort order.
example: '["<string>","<string>"]'
has_archives:
type: string
description: Enable/Disable attribute archives.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > attributes > {id}
summary: /wc/v3/products/attributes/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Attribute name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: type
in: query
schema:
type: string
description: Type of attribute.
example: <string>
- name: order_by
in: query
schema:
type: string
description: Default sort order.
example: <string>
- name: has_archives
in: query
schema:
type: string
description: Enable/Disable attribute archives.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > attributes > {id}
summary: /wc/v3/products/attributes/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Attribute name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: type
in: query
schema:
type: string
description: Type of attribute.
example: <string>
- name: order_by
in: query
schema:
type: string
description: Default sort order.
example: <string>
- name: has_archives
in: query
schema:
type: string
description: Enable/Disable attribute archives.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > attributes > {id}
summary: /wc/v3/products/attributes/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/attributes/batch:
post:
tags:
- products > attributes > batch
summary: /wc/v3/products/attributes/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Attribute name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
type:
type: string
description: Type of attribute.
example: '["<string>","<string>"]'
order_by:
type: string
description: Default sort order.
example: '["<string>","<string>"]'
has_archives:
type: string
description: Enable/Disable attribute archives.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > attributes > batch
summary: /wc/v3/products/attributes/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Attribute name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: type
in: query
schema:
type: string
description: Type of attribute.
example: <string>
- name: order_by
in: query
schema:
type: string
description: Default sort order.
example: <string>
- name: has_archives
in: query
schema:
type: string
description: Enable/Disable attribute archives.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > attributes > batch
summary: /wc/v3/products/attributes/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Attribute name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: type
in: query
schema:
type: string
description: Type of attribute.
example: <string>
- name: order_by
in: query
schema:
type: string
description: Default sort order.
example: <string>
- name: has_archives
in: query
schema:
type: string
description: Enable/Disable attribute archives.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/attributes:
get:
tags:
- products > attributes
summary: /wc/v3/products/attributes
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > attributes
summary: /wc/v3/products/attributes
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Name for the resource.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
type:
type: string
description: Type of attribute.
example: '["select","select"]'
order_by:
type: string
description: Default sort order.
example: '["menu_order","menu_order"]'
has_archives:
type: string
description: Enable/Disable attribute archives.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/categories/{id}:
get:
tags:
- products > categories > {id}
summary: /wc/v3/products/categories/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > categories > {id}
summary: /wc/v3/products/categories/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Category name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
parent:
type: string
description: The ID for the parent of the resource.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
display:
type: string
description: Category archive display type.
example: '["<string>","<string>"]'
image:
type: string
description: Image data.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > categories > {id}
summary: /wc/v3/products/categories/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Category name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: parent
in: query
schema:
type: string
description: The ID for the parent of the resource.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: display
in: query
schema:
type: string
description: Category archive display type.
example: <string>
- name: image
in: query
schema:
type: string
description: Image data.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > categories > {id}
summary: /wc/v3/products/categories/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Category name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: parent
in: query
schema:
type: string
description: The ID for the parent of the resource.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: display
in: query
schema:
type: string
description: Category archive display type.
example: <string>
- name: image
in: query
schema:
type: string
description: Image data.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > categories > {id}
summary: /wc/v3/products/categories/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/categories/batch:
post:
tags:
- products > categories > batch
summary: /wc/v3/products/categories/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Category name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
parent:
type: string
description: The ID for the parent of the resource.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
display:
type: string
description: Category archive display type.
example: '["<string>","<string>"]'
image:
type: string
description: Image data.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > categories > batch
summary: /wc/v3/products/categories/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Category name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: parent
in: query
schema:
type: string
description: The ID for the parent of the resource.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: display
in: query
schema:
type: string
description: Category archive display type.
example: <string>
- name: image
in: query
schema:
type: string
description: Image data.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > categories > batch
summary: /wc/v3/products/categories/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Category name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: parent
in: query
schema:
type: string
description: The ID for the parent of the resource.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: display
in: query
schema:
type: string
description: Category archive display type.
example: <string>
- name: image
in: query
schema:
type: string
description: Image data.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/categories:
get:
tags:
- products > categories
summary: /wc/v3/products/categories
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: asc
- name: orderby
in: query
schema:
type: string
description: Sort collection by resource attribute.
example: name
- name: hide_empty
in: query
schema:
type: string
description: Whether to hide resources not assigned to any products.
example: <string>
- name: parent
in: query
schema:
type: string
description: Limit result set to resources assigned to a specific parent.
example: <string>
- name: product
in: query
schema:
type: string
description: Limit result set to resources assigned to a specific product.
example: <string>
- name: slug
in: query
schema:
type: string
description: Limit result set to resources with a specific slug.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > categories
summary: /wc/v3/products/categories
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Name for the resource.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
parent:
type: string
description: The ID for the parent of the resource.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
display:
type: string
description: Category archive display type.
example: '["default","default"]'
image:
type: string
description: Image data.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/reviews/{id}:
get:
tags:
- products > reviews > {id}
summary: /wc/v3/products/reviews/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > reviews > {id}
summary: /wc/v3/products/reviews/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
product_id:
type: string
description: >-
Unique identifier for the product that the review belongs
to.
example: <string>
status:
type: string
description: Status of the review.
example: '["<string>","<string>"]'
reviewer:
type: string
description: Reviewer name.
example: <string>
reviewer_email:
type: string
description: Reviewer email.
example: <email>
review:
type: string
description: The content of the review.
example: <string>
rating:
type: string
description: Review rating (0 to 5).
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > reviews > {id}
summary: /wc/v3/products/reviews/:id
requestBody:
content: {}
parameters:
- name: product_id
in: query
schema:
type: string
description: Unique identifier for the product that the review belongs to.
example: <string>
- name: status
in: query
schema:
type: string
description: Status of the review.
example: <string>
- name: reviewer
in: query
schema:
type: string
description: Reviewer name.
example: <string>
- name: reviewer_email
in: query
schema:
type: string
description: Reviewer email.
example: <email>
- name: review
in: query
schema:
type: string
description: The content of the review.
example: <string>
- name: rating
in: query
schema:
type: string
description: Review rating (0 to 5).
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > reviews > {id}
summary: /wc/v3/products/reviews/:id
requestBody:
content: {}
parameters:
- name: product_id
in: query
schema:
type: string
description: Unique identifier for the product that the review belongs to.
example: <string>
- name: status
in: query
schema:
type: string
description: Status of the review.
example: <string>
- name: reviewer
in: query
schema:
type: string
description: Reviewer name.
example: <string>
- name: reviewer_email
in: query
schema:
type: string
description: Reviewer email.
example: <email>
- name: review
in: query
schema:
type: string
description: The content of the review.
example: <string>
- name: rating
in: query
schema:
type: string
description: Review rating (0 to 5).
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > reviews > {id}
summary: /wc/v3/products/reviews/:id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/reviews/batch:
post:
tags:
- products > reviews > batch
summary: /wc/v3/products/reviews/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
product_id:
type: string
description: >-
Unique identifier for the product that the review belongs
to.
example: <string>
status:
type: string
description: Status of the review.
example: '["<string>","<string>"]'
reviewer:
type: string
description: Reviewer name.
example: <string>
reviewer_email:
type: string
description: Reviewer email.
example: <email>
review:
type: string
description: The content of the review.
example: <string>
rating:
type: string
description: Review rating (0 to 5).
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > reviews > batch
summary: /wc/v3/products/reviews/batch
requestBody:
content: {}
parameters:
- name: product_id
in: query
schema:
type: string
description: Unique identifier for the product that the review belongs to.
example: <string>
- name: status
in: query
schema:
type: string
description: Status of the review.
example: <string>
- name: reviewer
in: query
schema:
type: string
description: Reviewer name.
example: <string>
- name: reviewer_email
in: query
schema:
type: string
description: Reviewer email.
example: <email>
- name: review
in: query
schema:
type: string
description: The content of the review.
example: <string>
- name: rating
in: query
schema:
type: string
description: Review rating (0 to 5).
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > reviews > batch
summary: /wc/v3/products/reviews/batch
requestBody:
content: {}
parameters:
- name: product_id
in: query
schema:
type: string
description: Unique identifier for the product that the review belongs to.
example: <string>
- name: status
in: query
schema:
type: string
description: Status of the review.
example: <string>
- name: reviewer
in: query
schema:
type: string
description: Reviewer name.
example: <string>
- name: reviewer_email
in: query
schema:
type: string
description: Reviewer email.
example: <email>
- name: review
in: query
schema:
type: string
description: The content of the review.
example: <string>
- name: rating
in: query
schema:
type: string
description: Review rating (0 to 5).
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/reviews:
get:
tags:
- products > reviews
summary: /wc/v3/products/reviews
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to reviews published before a given ISO8601 compliant
date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific IDs.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date_gmt
- name: reviewer
in: query
schema:
type: string
description: Limit result set to reviews assigned to specific user IDs.
example: <string>
- name: reviewer_exclude
in: query
schema:
type: string
description: Ensure result set excludes reviews assigned to specific user IDs.
example: <string>
- name: reviewer_email
in: query
schema:
type: string
description: Limit result set to that from a specific author email.
example: <email>
- name: product
in: query
schema:
type: string
description: Limit result set to reviews assigned to specific product IDs.
example: <string>
- name: status
in: query
schema:
type: string
description: Limit result set to reviews assigned a specific status.
example: approved
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > reviews
summary: /wc/v3/products/reviews
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
product_id:
type: string
description: Unique identifier for the product.
example: <string>
reviewer:
type: string
description: Name of the reviewer.
example: <string>
reviewer_email:
type: string
description: Email of the reviewer.
example: <string>
review:
type: string
description: Review content.
example: <string>
status:
type: string
description: Status of the review.
example: '["approved","approved"]'
rating:
type: string
description: Review rating (0 to 5).
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/shipping_classes/{id}:
get:
tags:
- products > shipping classes > {id}
summary: /wc/v3/products/shipping_classes/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > shipping classes > {id}
summary: /wc/v3/products/shipping_classes/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Shipping class name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > shipping classes > {id}
summary: /wc/v3/products/shipping_classes/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Shipping class name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > shipping classes > {id}
summary: /wc/v3/products/shipping_classes/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Shipping class name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > shipping classes > {id}
summary: /wc/v3/products/shipping_classes/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/shipping_classes/batch:
post:
tags:
- products > shipping classes > batch
summary: /wc/v3/products/shipping_classes/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Shipping class name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > shipping classes > batch
summary: /wc/v3/products/shipping_classes/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Shipping class name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > shipping classes > batch
summary: /wc/v3/products/shipping_classes/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Shipping class name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/shipping_classes:
get:
tags:
- products > shipping classes
summary: /wc/v3/products/shipping_classes
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: asc
- name: orderby
in: query
schema:
type: string
description: Sort collection by resource attribute.
example: name
- name: hide_empty
in: query
schema:
type: string
description: Whether to hide resources not assigned to any products.
example: <string>
- name: product
in: query
schema:
type: string
description: Limit result set to resources assigned to a specific product.
example: <string>
- name: slug
in: query
schema:
type: string
description: Limit result set to resources with a specific slug.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > shipping classes
summary: /wc/v3/products/shipping_classes
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Name for the resource.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/tags/{id}:
get:
tags:
- products > tags > {id}
summary: /wc/v3/products/tags/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > tags > {id}
summary: /wc/v3/products/tags/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Tag name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > tags > {id}
summary: /wc/v3/products/tags/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Tag name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > tags > {id}
summary: /wc/v3/products/tags/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Tag name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > tags > {id}
summary: /wc/v3/products/tags/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/tags/batch:
post:
tags:
- products > tags > batch
summary: /wc/v3/products/tags/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Tag name.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > tags > batch
summary: /wc/v3/products/tags/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Tag name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > tags > batch
summary: /wc/v3/products/tags/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Tag name.
example: <string>
- name: slug
in: query
schema:
type: string
description: An alphanumeric identifier for the resource unique to its type.
example: <string>
- name: description
in: query
schema:
type: string
description: HTML description of the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/tags:
get:
tags:
- products > tags
summary: /wc/v3/products/tags
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: asc
- name: orderby
in: query
schema:
type: string
description: Sort collection by resource attribute.
example: name
- name: hide_empty
in: query
schema:
type: string
description: Whether to hide resources not assigned to any products.
example: <string>
- name: product
in: query
schema:
type: string
description: Limit result set to resources assigned to a specific product.
example: <string>
- name: slug
in: query
schema:
type: string
description: Limit result set to resources with a specific slug.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > tags
summary: /wc/v3/products/tags
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Name for the resource.
example: <string>
slug:
type: string
description: >-
An alphanumeric identifier for the resource unique to its
type.
example: <string>
description:
type: string
description: HTML description of the resource.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/{id}:
get:
tags:
- products > {id}
summary: /wc/v3/products/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > {id}
summary: /wc/v3/products/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Product name.
example: <string>
slug:
type: string
description: Product slug.
example: <string>
date_created:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
date_created_gmt:
type: string
description: The date the product was created, as GMT.
example: <string>
type:
type: string
description: Product type.
example: '["<string>","<string>"]'
status:
type: string
description: Product status (post status).
example: '["<string>","<string>"]'
featured:
type: string
description: Featured product.
example: <string>
catalog_visibility:
type: string
description: Catalog visibility.
example: '["<string>","<string>"]'
description:
type: string
description: Product description.
example: <string>
short_description:
type: string
description: Product short description.
example: <string>
sku:
type: string
description: Unique identifier.
example: <string>
regular_price:
type: string
description: Product regular price.
example: <string>
sale_price:
type: string
description: Product sale price.
example: <string>
date_on_sale_from:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
date_on_sale_from_gmt:
type: string
description: Start date of sale price, as GMT.
example: <string>
date_on_sale_to:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
date_on_sale_to_gmt:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
virtual:
type: string
description: If the product is virtual.
example: <string>
downloadable:
type: string
description: If the product is downloadable.
example: <string>
downloads:
type: string
description: List of downloadable files.
example: <string>
download_limit:
type: string
description: >-
Number of times downloadable files can be downloaded after
purchase.
example: <string>
download_expiry:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
external_url:
type: string
description: Product external URL. Only for external products.
example: <uri>
button_text:
type: string
description: Product external button text. Only for external products.
example: <string>
tax_status:
type: string
description: Tax status.
example: '["<string>","<string>"]'
tax_class:
type: string
description: Tax class.
example: <string>
manage_stock:
type: string
description: Stock management at product level.
example: <string>
stock_quantity:
type: string
description: Stock quantity.
example: <string>
stock_status:
type: string
description: Controls the stock status of the product.
example: '["<string>","<string>"]'
backorders:
type: string
description: If managing stock, this controls if backorders are allowed.
example: '["<string>","<string>"]'
sold_individually:
type: string
description: Allow one item to be bought in a single order.
example: <string>
weight:
type: string
description: Product weight (kg).
example: <string>
dimensions:
type: string
description: Product dimensions.
example: <string>
shipping_class:
type: string
description: Shipping class slug.
example: <string>
reviews_allowed:
type: string
description: Allow reviews.
example: <string>
upsell_ids:
type: string
description: List of up-sell products IDs.
example: <string>
cross_sell_ids:
type: string
description: List of cross-sell products IDs.
example: <string>
parent_id:
type: string
description: Product parent ID.
example: <string>
purchase_note:
type: string
description: Optional note to send the customer after purchase.
example: <string>
categories:
type: string
description: List of categories.
example: <string>
tags:
type: string
description: List of tags.
example: <string>
images:
type: string
description: List of images.
example: <string>
attributes:
type: string
description: List of attributes.
example: <string>
default_attributes:
type: string
description: Defaults variation attributes.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort products.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > {id}
summary: /wc/v3/products/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Product name.
example: <string>
- name: slug
in: query
schema:
type: string
description: Product slug.
example: <string>
- name: date_created
in: query
schema:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
- name: date_created_gmt
in: query
schema:
type: string
description: The date the product was created, as GMT.
example: <string>
- name: type
in: query
schema:
type: string
description: Product type.
example: <string>
- name: status
in: query
schema:
type: string
description: Product status (post status).
example: <string>
- name: featured
in: query
schema:
type: string
description: Featured product.
example: <string>
- name: catalog_visibility
in: query
schema:
type: string
description: Catalog visibility.
example: <string>
- name: description
in: query
schema:
type: string
description: Product description.
example: <string>
- name: short_description
in: query
schema:
type: string
description: Product short description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Product regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Product sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the product is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the product is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: external_url
in: query
schema:
type: string
description: Product external URL. Only for external products.
example: <uri>
- name: button_text
in: query
schema:
type: string
description: Product external button text. Only for external products.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at product level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: sold_individually
in: query
schema:
type: string
description: Allow one item to be bought in a single order.
example: <string>
- name: weight
in: query
schema:
type: string
description: Product weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Product dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: reviews_allowed
in: query
schema:
type: string
description: Allow reviews.
example: <string>
- name: upsell_ids
in: query
schema:
type: string
description: List of up-sell products IDs.
example: <string>
- name: cross_sell_ids
in: query
schema:
type: string
description: List of cross-sell products IDs.
example: <string>
- name: parent_id
in: query
schema:
type: string
description: Product parent ID.
example: <string>
- name: purchase_note
in: query
schema:
type: string
description: Optional note to send the customer after purchase.
example: <string>
- name: categories
in: query
schema:
type: string
description: List of categories.
example: <string>
- name: tags
in: query
schema:
type: string
description: List of tags.
example: <string>
- name: images
in: query
schema:
type: string
description: List of images.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: default_attributes
in: query
schema:
type: string
description: Defaults variation attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > {id}
summary: /wc/v3/products/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Product name.
example: <string>
- name: slug
in: query
schema:
type: string
description: Product slug.
example: <string>
- name: date_created
in: query
schema:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
- name: date_created_gmt
in: query
schema:
type: string
description: The date the product was created, as GMT.
example: <string>
- name: type
in: query
schema:
type: string
description: Product type.
example: <string>
- name: status
in: query
schema:
type: string
description: Product status (post status).
example: <string>
- name: featured
in: query
schema:
type: string
description: Featured product.
example: <string>
- name: catalog_visibility
in: query
schema:
type: string
description: Catalog visibility.
example: <string>
- name: description
in: query
schema:
type: string
description: Product description.
example: <string>
- name: short_description
in: query
schema:
type: string
description: Product short description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Product regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Product sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the product is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the product is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: external_url
in: query
schema:
type: string
description: Product external URL. Only for external products.
example: <uri>
- name: button_text
in: query
schema:
type: string
description: Product external button text. Only for external products.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at product level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: sold_individually
in: query
schema:
type: string
description: Allow one item to be bought in a single order.
example: <string>
- name: weight
in: query
schema:
type: string
description: Product weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Product dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: reviews_allowed
in: query
schema:
type: string
description: Allow reviews.
example: <string>
- name: upsell_ids
in: query
schema:
type: string
description: List of up-sell products IDs.
example: <string>
- name: cross_sell_ids
in: query
schema:
type: string
description: List of cross-sell products IDs.
example: <string>
- name: parent_id
in: query
schema:
type: string
description: Product parent ID.
example: <string>
- name: purchase_note
in: query
schema:
type: string
description: Optional note to send the customer after purchase.
example: <string>
- name: categories
in: query
schema:
type: string
description: List of categories.
example: <string>
- name: tags
in: query
schema:
type: string
description: List of tags.
example: <string>
- name: images
in: query
schema:
type: string
description: List of images.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: default_attributes
in: query
schema:
type: string
description: Defaults variation attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > {id}
summary: /wc/v3/products/:id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/batch:
post:
tags:
- products > batch
summary: /wc/v3/products/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Product name.
example: <string>
slug:
type: string
description: Product slug.
example: <string>
date_created:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
date_created_gmt:
type: string
description: The date the product was created, as GMT.
example: <string>
type:
type: string
description: Product type.
example: '["<string>","<string>"]'
status:
type: string
description: Product status (post status).
example: '["<string>","<string>"]'
featured:
type: string
description: Featured product.
example: <string>
catalog_visibility:
type: string
description: Catalog visibility.
example: '["<string>","<string>"]'
description:
type: string
description: Product description.
example: <string>
short_description:
type: string
description: Product short description.
example: <string>
sku:
type: string
description: Unique identifier.
example: <string>
regular_price:
type: string
description: Product regular price.
example: <string>
sale_price:
type: string
description: Product sale price.
example: <string>
date_on_sale_from:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
date_on_sale_from_gmt:
type: string
description: Start date of sale price, as GMT.
example: <string>
date_on_sale_to:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
date_on_sale_to_gmt:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
virtual:
type: string
description: If the product is virtual.
example: <string>
downloadable:
type: string
description: If the product is downloadable.
example: <string>
downloads:
type: string
description: List of downloadable files.
example: <string>
download_limit:
type: string
description: >-
Number of times downloadable files can be downloaded after
purchase.
example: <string>
download_expiry:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
external_url:
type: string
description: Product external URL. Only for external products.
example: <uri>
button_text:
type: string
description: Product external button text. Only for external products.
example: <string>
tax_status:
type: string
description: Tax status.
example: '["<string>","<string>"]'
tax_class:
type: string
description: Tax class.
example: <string>
manage_stock:
type: string
description: Stock management at product level.
example: <string>
stock_quantity:
type: string
description: Stock quantity.
example: <string>
stock_status:
type: string
description: Controls the stock status of the product.
example: '["<string>","<string>"]'
backorders:
type: string
description: If managing stock, this controls if backorders are allowed.
example: '["<string>","<string>"]'
sold_individually:
type: string
description: Allow one item to be bought in a single order.
example: <string>
weight:
type: string
description: Product weight (kg).
example: <string>
dimensions:
type: string
description: Product dimensions.
example: <string>
shipping_class:
type: string
description: Shipping class slug.
example: <string>
reviews_allowed:
type: string
description: Allow reviews.
example: <string>
upsell_ids:
type: string
description: List of up-sell products IDs.
example: <string>
cross_sell_ids:
type: string
description: List of cross-sell products IDs.
example: <string>
parent_id:
type: string
description: Product parent ID.
example: <string>
purchase_note:
type: string
description: Optional note to send the customer after purchase.
example: <string>
categories:
type: string
description: List of categories.
example: <string>
tags:
type: string
description: List of tags.
example: <string>
images:
type: string
description: List of images.
example: <string>
attributes:
type: string
description: List of attributes.
example: <string>
default_attributes:
type: string
description: Defaults variation attributes.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort products.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > batch
summary: /wc/v3/products/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Product name.
example: <string>
- name: slug
in: query
schema:
type: string
description: Product slug.
example: <string>
- name: date_created
in: query
schema:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
- name: date_created_gmt
in: query
schema:
type: string
description: The date the product was created, as GMT.
example: <string>
- name: type
in: query
schema:
type: string
description: Product type.
example: <string>
- name: status
in: query
schema:
type: string
description: Product status (post status).
example: <string>
- name: featured
in: query
schema:
type: string
description: Featured product.
example: <string>
- name: catalog_visibility
in: query
schema:
type: string
description: Catalog visibility.
example: <string>
- name: description
in: query
schema:
type: string
description: Product description.
example: <string>
- name: short_description
in: query
schema:
type: string
description: Product short description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Product regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Product sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the product is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the product is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: external_url
in: query
schema:
type: string
description: Product external URL. Only for external products.
example: <uri>
- name: button_text
in: query
schema:
type: string
description: Product external button text. Only for external products.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at product level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: sold_individually
in: query
schema:
type: string
description: Allow one item to be bought in a single order.
example: <string>
- name: weight
in: query
schema:
type: string
description: Product weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Product dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: reviews_allowed
in: query
schema:
type: string
description: Allow reviews.
example: <string>
- name: upsell_ids
in: query
schema:
type: string
description: List of up-sell products IDs.
example: <string>
- name: cross_sell_ids
in: query
schema:
type: string
description: List of cross-sell products IDs.
example: <string>
- name: parent_id
in: query
schema:
type: string
description: Product parent ID.
example: <string>
- name: purchase_note
in: query
schema:
type: string
description: Optional note to send the customer after purchase.
example: <string>
- name: categories
in: query
schema:
type: string
description: List of categories.
example: <string>
- name: tags
in: query
schema:
type: string
description: List of tags.
example: <string>
- name: images
in: query
schema:
type: string
description: List of images.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: default_attributes
in: query
schema:
type: string
description: Defaults variation attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > batch
summary: /wc/v3/products/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Product name.
example: <string>
- name: slug
in: query
schema:
type: string
description: Product slug.
example: <string>
- name: date_created
in: query
schema:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
- name: date_created_gmt
in: query
schema:
type: string
description: The date the product was created, as GMT.
example: <string>
- name: type
in: query
schema:
type: string
description: Product type.
example: <string>
- name: status
in: query
schema:
type: string
description: Product status (post status).
example: <string>
- name: featured
in: query
schema:
type: string
description: Featured product.
example: <string>
- name: catalog_visibility
in: query
schema:
type: string
description: Catalog visibility.
example: <string>
- name: description
in: query
schema:
type: string
description: Product description.
example: <string>
- name: short_description
in: query
schema:
type: string
description: Product short description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Product regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Product sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the product is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the product is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: external_url
in: query
schema:
type: string
description: Product external URL. Only for external products.
example: <uri>
- name: button_text
in: query
schema:
type: string
description: Product external button text. Only for external products.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at product level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: sold_individually
in: query
schema:
type: string
description: Allow one item to be bought in a single order.
example: <string>
- name: weight
in: query
schema:
type: string
description: Product weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Product dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: reviews_allowed
in: query
schema:
type: string
description: Allow reviews.
example: <string>
- name: upsell_ids
in: query
schema:
type: string
description: List of up-sell products IDs.
example: <string>
- name: cross_sell_ids
in: query
schema:
type: string
description: List of cross-sell products IDs.
example: <string>
- name: parent_id
in: query
schema:
type: string
description: Product parent ID.
example: <string>
- name: purchase_note
in: query
schema:
type: string
description: Optional note to send the customer after purchase.
example: <string>
- name: categories
in: query
schema:
type: string
description: List of categories.
example: <string>
- name: tags
in: query
schema:
type: string
description: List of tags.
example: <string>
- name: images
in: query
schema:
type: string
description: List of images.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: default_attributes
in: query
schema:
type: string
description: Defaults variation attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/{product_id}/variations/{id}:
get:
tags:
- products > {product id}/variations > {id}
summary: /wc/v3/products/:product_id/variations/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variation.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > {product id}/variations > {id}
summary: /wc/v3/products/:product_id/variations/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
description:
type: string
description: Variation description.
example: <string>
sku:
type: string
description: Unique identifier.
example: <string>
regular_price:
type: string
description: Variation regular price.
example: <string>
sale_price:
type: string
description: Variation sale price.
example: <string>
date_on_sale_from:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
date_on_sale_from_gmt:
type: string
description: Start date of sale price, as GMT.
example: <string>
date_on_sale_to:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
date_on_sale_to_gmt:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
status:
type: string
description: Variation status.
example: '["<string>","<string>"]'
virtual:
type: string
description: If the variation is virtual.
example: <string>
downloadable:
type: string
description: If the variation is downloadable.
example: <string>
downloads:
type: string
description: List of downloadable files.
example: <string>
download_limit:
type: string
description: >-
Number of times downloadable files can be downloaded after
purchase.
example: <string>
download_expiry:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
tax_status:
type: string
description: Tax status.
example: '["<string>","<string>"]'
tax_class:
type: string
description: Tax class.
example: <string>
manage_stock:
type: string
description: Stock management at variation level.
example: <string>
stock_quantity:
type: string
description: Stock quantity.
example: <string>
stock_status:
type: string
description: Controls the stock status of the product.
example: '["<string>","<string>"]'
backorders:
type: string
description: If managing stock, this controls if backorders are allowed.
example: '["<string>","<string>"]'
weight:
type: string
description: Variation weight (kg).
example: <string>
dimensions:
type: string
description: Variation dimensions.
example: <string>
shipping_class:
type: string
description: Shipping class slug.
example: <string>
image:
type: string
description: Variation image data.
example: <string>
attributes:
type: string
description: List of attributes.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort products.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variation.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > {product id}/variations > {id}
summary: /wc/v3/products/:product_id/variations/:id
requestBody:
content: {}
parameters:
- name: description
in: query
schema:
type: string
description: Variation description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Variation regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Variation sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: status
in: query
schema:
type: string
description: Variation status.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the variation is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the variation is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at variation level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: weight
in: query
schema:
type: string
description: Variation weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Variation dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: image
in: query
schema:
type: string
description: Variation image data.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variation.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > {product id}/variations > {id}
summary: /wc/v3/products/:product_id/variations/:id
requestBody:
content: {}
parameters:
- name: description
in: query
schema:
type: string
description: Variation description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Variation regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Variation sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: status
in: query
schema:
type: string
description: Variation status.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the variation is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the variation is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at variation level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: weight
in: query
schema:
type: string
description: Variation weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Variation dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: image
in: query
schema:
type: string
description: Variation image data.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variation.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- products > {product id}/variations > {id}
summary: /wc/v3/products/:product_id/variations/:id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variation.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/{product_id}/variations/batch:
post:
tags:
- products > {product id}/variations > batch
summary: /wc/v3/products/:product_id/variations/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
description:
type: string
description: Variation description.
example: <string>
sku:
type: string
description: Unique identifier.
example: <string>
regular_price:
type: string
description: Variation regular price.
example: <string>
sale_price:
type: string
description: Variation sale price.
example: <string>
date_on_sale_from:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
date_on_sale_from_gmt:
type: string
description: Start date of sale price, as GMT.
example: <string>
date_on_sale_to:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
date_on_sale_to_gmt:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
status:
type: string
description: Variation status.
example: '["<string>","<string>"]'
virtual:
type: string
description: If the variation is virtual.
example: <string>
downloadable:
type: string
description: If the variation is downloadable.
example: <string>
downloads:
type: string
description: List of downloadable files.
example: <string>
download_limit:
type: string
description: >-
Number of times downloadable files can be downloaded after
purchase.
example: <string>
download_expiry:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
tax_status:
type: string
description: Tax status.
example: '["<string>","<string>"]'
tax_class:
type: string
description: Tax class.
example: <string>
manage_stock:
type: string
description: Stock management at variation level.
example: <string>
stock_quantity:
type: string
description: Stock quantity.
example: <string>
stock_status:
type: string
description: Controls the stock status of the product.
example: '["<string>","<string>"]'
backorders:
type: string
description: If managing stock, this controls if backorders are allowed.
example: '["<string>","<string>"]'
weight:
type: string
description: Variation weight (kg).
example: <string>
dimensions:
type: string
description: Variation dimensions.
example: <string>
shipping_class:
type: string
description: Shipping class slug.
example: <string>
image:
type: string
description: Variation image data.
example: <string>
attributes:
type: string
description: List of attributes.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort products.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- products > {product id}/variations > batch
summary: /wc/v3/products/:product_id/variations/batch
requestBody:
content: {}
parameters:
- name: description
in: query
schema:
type: string
description: Variation description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Variation regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Variation sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: status
in: query
schema:
type: string
description: Variation status.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the variation is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the variation is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at variation level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: weight
in: query
schema:
type: string
description: Variation weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Variation dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: image
in: query
schema:
type: string
description: Variation image data.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- products > {product id}/variations > batch
summary: /wc/v3/products/:product_id/variations/batch
requestBody:
content: {}
parameters:
- name: description
in: query
schema:
type: string
description: Variation description.
example: <string>
- name: sku
in: query
schema:
type: string
description: Unique identifier.
example: <string>
- name: regular_price
in: query
schema:
type: string
description: Variation regular price.
example: <string>
- name: sale_price
in: query
schema:
type: string
description: Variation sale price.
example: <string>
- name: date_on_sale_from
in: query
schema:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_from_gmt
in: query
schema:
type: string
description: Start date of sale price, as GMT.
example: <string>
- name: date_on_sale_to
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: date_on_sale_to_gmt
in: query
schema:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
- name: status
in: query
schema:
type: string
description: Variation status.
example: <string>
- name: virtual
in: query
schema:
type: string
description: If the variation is virtual.
example: <string>
- name: downloadable
in: query
schema:
type: string
description: If the variation is downloadable.
example: <string>
- name: downloads
in: query
schema:
type: string
description: List of downloadable files.
example: <string>
- name: download_limit
in: query
schema:
type: string
description: Number of times downloadable files can be downloaded after purchase.
example: <string>
- name: download_expiry
in: query
schema:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
- name: tax_status
in: query
schema:
type: string
description: Tax status.
example: <string>
- name: tax_class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: manage_stock
in: query
schema:
type: string
description: Stock management at variation level.
example: <string>
- name: stock_quantity
in: query
schema:
type: string
description: Stock quantity.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Controls the stock status of the product.
example: <string>
- name: backorders
in: query
schema:
type: string
description: If managing stock, this controls if backorders are allowed.
example: <string>
- name: weight
in: query
schema:
type: string
description: Variation weight (kg).
example: <string>
- name: dimensions
in: query
schema:
type: string
description: Variation dimensions.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Shipping class slug.
example: <string>
- name: image
in: query
schema:
type: string
description: Variation image data.
example: <string>
- name: attributes
in: query
schema:
type: string
description: List of attributes.
example: <string>
- name: menu_order
in: query
schema:
type: string
description: Menu order, used to custom sort products.
example: <string>
- name: meta_data
in: query
schema:
type: string
description: Meta data.
example: <string>
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products/{product_id}/variations:
get:
tags:
- products > {product id}/variations
summary: /wc/v3/products/:product_id/variations
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to resources published before a given ISO8601
compliant date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date
- name: parent
in: query
schema:
type: string
description: Limit result set to those of particular parent IDs.
example: <string>
- name: parent_exclude
in: query
schema:
type: string
description: >-
Limit result set to all items except those of a particular parent
ID.
example: <string>
- name: slug
in: query
schema:
type: string
description: Limit result set to products with a specific slug.
example: <string>
- name: status
in: query
schema:
type: string
description: Limit result set to products assigned a specific status.
example: any
- name: sku
in: query
schema:
type: string
description: >-
Limit result set to products with specific SKU(s). Use commas to
separate.
example: <string>
- name: on_sale
in: query
schema:
type: string
description: Limit result set to products on sale.
example: <string>
- name: min_price
in: query
schema:
type: string
description: Limit result set to products based on a minimum price.
example: <string>
- name: max_price
in: query
schema:
type: string
description: Limit result set to products based on a maximum price.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Limit result set to products with specified stock status.
example: <string>
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products > {product id}/variations
summary: /wc/v3/products/:product_id/variations
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
description:
type: string
description: Variation description.
example: <string>
sku:
type: string
description: Unique identifier.
example: <string>
regular_price:
type: string
description: Variation regular price.
example: <string>
sale_price:
type: string
description: Variation sale price.
example: <string>
date_on_sale_from:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
date_on_sale_from_gmt:
type: string
description: Start date of sale price, as GMT.
example: <string>
date_on_sale_to:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
date_on_sale_to_gmt:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
status:
type: string
description: Variation status.
example: '["publish","publish"]'
virtual:
type: string
description: If the variation is virtual.
example: <string>
downloadable:
type: string
description: If the variation is downloadable.
example: <string>
downloads:
type: string
description: List of downloadable files.
example: <string>
download_limit:
type: string
description: >-
Number of times downloadable files can be downloaded after
purchase.
example: <string>
download_expiry:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
tax_status:
type: string
description: Tax status.
example: '["taxable","taxable"]'
tax_class:
type: string
description: Tax class.
example: <string>
manage_stock:
type: string
description: Stock management at variation level.
example: <string>
stock_quantity:
type: string
description: Stock quantity.
example: <string>
stock_status:
type: string
description: Controls the stock status of the product.
example: '["instock","instock"]'
backorders:
type: string
description: If managing stock, this controls if backorders are allowed.
example: '["no","no"]'
weight:
type: string
description: Variation weight (kg).
example: <string>
dimensions:
type: string
description: Variation dimensions.
example: <string>
shipping_class:
type: string
description: Shipping class slug.
example: <string>
image:
type: string
description: Variation image data.
example: <string>
attributes:
type: string
description: List of attributes.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort products.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: product_id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the variable product.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/products:
get:
tags:
- products
summary: /wc/v3/products
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to resources published before a given ISO8601
compliant date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date
- name: parent
in: query
schema:
type: string
description: Limit result set to those of particular parent IDs.
example: <string>
- name: parent_exclude
in: query
schema:
type: string
description: >-
Limit result set to all items except those of a particular parent
ID.
example: <string>
- name: slug
in: query
schema:
type: string
description: Limit result set to products with a specific slug.
example: <string>
- name: status
in: query
schema:
type: string
description: Limit result set to products assigned a specific status.
example: any
- name: type
in: query
schema:
type: string
description: Limit result set to products assigned a specific type.
example: <string>
- name: sku
in: query
schema:
type: string
description: >-
Limit result set to products with specific SKU(s). Use commas to
separate.
example: <string>
- name: featured
in: query
schema:
type: string
description: Limit result set to featured products.
example: <string>
- name: category
in: query
schema:
type: string
description: Limit result set to products assigned a specific category ID.
example: <string>
- name: tag
in: query
schema:
type: string
description: Limit result set to products assigned a specific tag ID.
example: <string>
- name: shipping_class
in: query
schema:
type: string
description: Limit result set to products assigned a specific shipping class ID.
example: <string>
- name: attribute
in: query
schema:
type: string
description: >-
Limit result set to products with a specific attribute. Use the
taxonomy name/attribute slug.
example: <string>
- name: attribute_term
in: query
schema:
type: string
description: >-
Limit result set to products with a specific attribute term ID
(required an assigned attribute).
example: <string>
- name: on_sale
in: query
schema:
type: string
description: Limit result set to products on sale.
example: <string>
- name: min_price
in: query
schema:
type: string
description: Limit result set to products based on a minimum price.
example: <string>
- name: max_price
in: query
schema:
type: string
description: Limit result set to products based on a maximum price.
example: <string>
- name: stock_status
in: query
schema:
type: string
description: Limit result set to products with specified stock status.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- products
summary: /wc/v3/products
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Product name.
example: <string>
slug:
type: string
description: Product slug.
example: <string>
date_created:
type: string
description: The date the product was created, in the site's timezone.
example: <string>
date_created_gmt:
type: string
description: The date the product was created, as GMT.
example: <string>
type:
type: string
description: Product type.
example: '["simple","simple"]'
status:
type: string
description: Product status (post status).
example: '["publish","publish"]'
featured:
type: string
description: Featured product.
example: <string>
catalog_visibility:
type: string
description: Catalog visibility.
example: '["visible","visible"]'
description:
type: string
description: Product description.
example: <string>
short_description:
type: string
description: Product short description.
example: <string>
sku:
type: string
description: Unique identifier.
example: <string>
regular_price:
type: string
description: Product regular price.
example: <string>
sale_price:
type: string
description: Product sale price.
example: <string>
date_on_sale_from:
type: string
description: Start date of sale price, in the site's timezone.
example: <string>
date_on_sale_from_gmt:
type: string
description: Start date of sale price, as GMT.
example: <string>
date_on_sale_to:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
date_on_sale_to_gmt:
type: string
description: End date of sale price, in the site's timezone.
example: <string>
virtual:
type: string
description: If the product is virtual.
example: <string>
downloadable:
type: string
description: If the product is downloadable.
example: <string>
downloads:
type: string
description: List of downloadable files.
example: <string>
download_limit:
type: string
description: >-
Number of times downloadable files can be downloaded after
purchase.
example: <string>
download_expiry:
type: string
description: Number of days until access to downloadable files expires.
example: <string>
external_url:
type: string
description: Product external URL. Only for external products.
example: <uri>
button_text:
type: string
description: Product external button text. Only for external products.
example: <string>
tax_status:
type: string
description: Tax status.
example: '["taxable","taxable"]'
tax_class:
type: string
description: Tax class.
example: <string>
manage_stock:
type: string
description: Stock management at product level.
example: <string>
stock_quantity:
type: string
description: Stock quantity.
example: <string>
stock_status:
type: string
description: Controls the stock status of the product.
example: '["instock","instock"]'
backorders:
type: string
description: If managing stock, this controls if backorders are allowed.
example: '["no","no"]'
sold_individually:
type: string
description: Allow one item to be bought in a single order.
example: <string>
weight:
type: string
description: Product weight (kg).
example: <string>
dimensions:
type: string
description: Product dimensions.
example: <string>
shipping_class:
type: string
description: Shipping class slug.
example: <string>
reviews_allowed:
type: string
description: Allow reviews.
example: <string>
upsell_ids:
type: string
description: List of up-sell products IDs.
example: <string>
cross_sell_ids:
type: string
description: List of cross-sell products IDs.
example: <string>
parent_id:
type: string
description: Product parent ID.
example: <string>
purchase_note:
type: string
description: Optional note to send the customer after purchase.
example: <string>
categories:
type: string
description: List of categories.
example: <string>
tags:
type: string
description: List of tags.
example: <string>
images:
type: string
description: List of images.
example: <string>
attributes:
type: string
description: List of attributes.
example: <string>
default_attributes:
type: string
description: Defaults variation attributes.
example: <string>
menu_order:
type: string
description: Menu order, used to custom sort products.
example: <string>
meta_data:
type: string
description: Meta data.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports:
get:
tags:
- reports
summary: /wc/v3/reports
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/sales:
get:
tags:
- reports
summary: /wc/v3/reports/sales
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: period
in: query
schema:
type: string
description: Report period.
example: <string>
- name: date_min
in: query
schema:
type: string
description: >-
Return sales for a specific start date, the date need to be in the
YYYY-MM-DD format.
example: <date>
- name: date_max
in: query
schema:
type: string
description: >-
Return sales for a specific end date, the date need to be in the
YYYY-MM-DD format.
example: <date>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/top_sellers:
get:
tags:
- reports
summary: /wc/v3/reports/top_sellers
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: period
in: query
schema:
type: string
description: Report period.
example: <string>
- name: date_min
in: query
schema:
type: string
description: >-
Return sales for a specific start date, the date need to be in the
YYYY-MM-DD format.
example: <date>
- name: date_max
in: query
schema:
type: string
description: >-
Return sales for a specific end date, the date need to be in the
YYYY-MM-DD format.
example: <date>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/orders/totals:
get:
tags:
- reports
summary: /wc/v3/reports/orders/totals
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/products/totals:
get:
tags:
- reports
summary: /wc/v3/reports/products/totals
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/customers/totals:
get:
tags:
- reports
summary: /wc/v3/reports/customers/totals
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/coupons/totals:
get:
tags:
- reports
summary: /wc/v3/reports/coupons/totals
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/reports/reviews/totals:
get:
tags:
- reports
summary: /wc/v3/reports/reviews/totals
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/settings/batch:
post:
tags:
- settings > batch
summary: /wc/v3/settings/batch
requestBody:
content: {}
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- settings > batch
summary: /wc/v3/settings/batch
requestBody:
content: {}
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- settings > batch
summary: /wc/v3/settings/batch
requestBody:
content: {}
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/settings/{group_id}/batch:
post:
tags:
- settings > {group id} > batch
summary: /wc/v3/settings/:group_id/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
group:
type: string
description: Settings group ID.
example: <string>
value:
type: string
description: Setting value.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- settings > {group id} > batch
summary: /wc/v3/settings/:group_id/batch
requestBody:
content: {}
parameters:
- name: group
in: query
schema:
type: string
description: Settings group ID.
example: <string>
- name: value
in: query
schema:
type: string
description: Setting value.
example: <string>
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- settings > {group id} > batch
summary: /wc/v3/settings/:group_id/batch
requestBody:
content: {}
parameters:
- name: group
in: query
schema:
type: string
description: Settings group ID.
example: <string>
- name: value
in: query
schema:
type: string
description: Setting value.
example: <string>
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/settings/{group_id}/{id}:
get:
tags:
- settings > {group id} > {id}
summary: /wc/v3/settings/:group_id/:id
parameters:
- name: group
in: query
schema:
type: string
description: Settings group ID.
example: <string>
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- settings > {group id} > {id}
summary: /wc/v3/settings/:group_id/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
group:
type: string
description: Settings group ID.
example: <string>
value:
type: string
description: Setting value.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- settings > {group id} > {id}
summary: /wc/v3/settings/:group_id/:id
requestBody:
content: {}
parameters:
- name: group
in: query
schema:
type: string
description: Settings group ID.
example: <string>
- name: value
in: query
schema:
type: string
description: Setting value.
example: <string>
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- settings > {group id} > {id}
summary: /wc/v3/settings/:group_id/:id
requestBody:
content: {}
parameters:
- name: group
in: query
schema:
type: string
description: Settings group ID.
example: <string>
- name: value
in: query
schema:
type: string
description: Setting value.
example: <string>
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/settings/{group_id}:
get:
tags:
- settings > {group id}
summary: /wc/v3/settings/:group_id
parameters:
- name: group
in: query
schema:
type: string
description: Settings group ID.
example: <string>
- name: group_id
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/settings:
get:
tags:
- settings
summary: /wc/v3/settings
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping/zones/{id}/locations:
get:
tags:
- shipping/zones > {id} > locations
summary: /wc/v3/shipping/zones/:id/locations
parameters:
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- shipping/zones > {id} > locations
summary: /wc/v3/shipping/zones/:id/locations
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
code:
type: string
description: Shipping zone location code.
example: <string>
type:
type: string
description: Shipping zone location type.
example: '["<string>","<string>"]'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- shipping/zones > {id} > locations
summary: /wc/v3/shipping/zones/:id/locations
requestBody:
content: {}
parameters:
- name: code
in: query
schema:
type: string
description: Shipping zone location code.
example: <string>
- name: type
in: query
schema:
type: string
description: Shipping zone location type.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- shipping/zones > {id} > locations
summary: /wc/v3/shipping/zones/:id/locations
requestBody:
content: {}
parameters:
- name: code
in: query
schema:
type: string
description: Shipping zone location code.
example: <string>
- name: type
in: query
schema:
type: string
description: Shipping zone location type.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping/zones/{id}:
get:
tags:
- shipping/zones > {id}
summary: /wc/v3/shipping/zones/:id
parameters:
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- shipping/zones > {id}
summary: /wc/v3/shipping/zones/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Shipping zone name.
example: <string>
order:
type: string
description: Shipping zone order.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- shipping/zones > {id}
summary: /wc/v3/shipping/zones/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Shipping zone name.
example: <string>
- name: order
in: query
schema:
type: string
description: Shipping zone order.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- shipping/zones > {id}
summary: /wc/v3/shipping/zones/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Shipping zone name.
example: <string>
- name: order
in: query
schema:
type: string
description: Shipping zone order.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- shipping/zones > {id}
summary: /wc/v3/shipping/zones/:id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping/zones/{zone_id}/methods/{instance_id}:
get:
tags:
- shipping/zones > {zone id}/methods > {instance id}
summary: /wc/v3/shipping/zones/:zone_id/methods/:instance_id
parameters:
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
- name: instance_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the instance.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- shipping/zones > {zone id}/methods > {instance id}
summary: /wc/v3/shipping/zones/:zone_id/methods/:instance_id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
order:
type: string
description: Shipping method sort order.
example: <string>
enabled:
type: string
description: Shipping method enabled status.
example: <string>
settings:
type: string
description: Shipping method settings.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
- name: instance_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the instance.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- shipping/zones > {zone id}/methods > {instance id}
summary: /wc/v3/shipping/zones/:zone_id/methods/:instance_id
requestBody:
content: {}
parameters:
- name: order
in: query
schema:
type: string
description: Shipping method sort order.
example: <string>
- name: enabled
in: query
schema:
type: string
description: Shipping method enabled status.
example: <string>
- name: settings
in: query
schema:
type: string
description: Shipping method settings.
example: <string>
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
- name: instance_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the instance.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- shipping/zones > {zone id}/methods > {instance id}
summary: /wc/v3/shipping/zones/:zone_id/methods/:instance_id
requestBody:
content: {}
parameters:
- name: order
in: query
schema:
type: string
description: Shipping method sort order.
example: <string>
- name: enabled
in: query
schema:
type: string
description: Shipping method enabled status.
example: <string>
- name: settings
in: query
schema:
type: string
description: Shipping method settings.
example: <string>
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
- name: instance_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the instance.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- shipping/zones > {zone id}/methods > {instance id}
summary: /wc/v3/shipping/zones/:zone_id/methods/:instance_id
parameters:
- name: force
in: query
schema:
type: string
description: Whether to bypass trash and force deletion.
example: <string>
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
- name: instance_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the instance.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping/zones/{zone_id}/methods:
get:
tags:
- shipping/zones > {zone id}/methods
summary: /wc/v3/shipping/zones/:zone_id/methods
parameters:
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- shipping/zones > {zone id}/methods
summary: /wc/v3/shipping/zones/:zone_id/methods
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
method_id:
type: string
description: Shipping method ID.
example: <string>
order:
type: string
description: Shipping method sort order.
example: <string>
enabled:
type: string
description: Shipping method enabled status.
example: <string>
settings:
type: string
description: Shipping method settings.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: zone_id
in: path
schema:
type: string
required: true
description: (Required) Unique ID for the zone.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping/zones:
get:
tags:
- shipping/zones
summary: /wc/v3/shipping/zones
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- shipping/zones
summary: /wc/v3/shipping/zones
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Shipping zone name.
example: <string>
order:
type: string
description: Shipping zone order.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/taxes/classes:
get:
tags:
- taxes > classes
summary: /wc/v3/taxes/classes
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- taxes > classes
summary: /wc/v3/taxes/classes
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Tax class name.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/taxes/classes/{slug}:
delete:
tags:
- taxes > classes
summary: /wc/v3/taxes/classes/:slug
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: slug
in: path
schema:
type: string
required: true
description: (Required) Unique slug for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/taxes/{id}:
get:
tags:
- taxes > {id}
summary: /wc/v3/taxes/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- taxes > {id}
summary: /wc/v3/taxes/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
country:
type: string
description: Country ISO 3166 code.
example: <string>
state:
type: string
description: State code.
example: <string>
postcode:
type: string
description: Postcode / ZIP.
example: <string>
city:
type: string
description: City name.
example: <string>
rate:
type: string
description: Tax rate.
example: <string>
name:
type: string
description: Tax rate name.
example: <string>
priority:
type: string
description: Tax priority.
example: <string>
compound:
type: string
description: Whether or not this is a compound rate.
example: <string>
shipping:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
order:
type: string
description: Indicates the order that will appear in queries.
example: <string>
class:
type: string
description: Tax class.
example: '["<string>","<string>"]'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- taxes > {id}
summary: /wc/v3/taxes/:id
requestBody:
content: {}
parameters:
- name: country
in: query
schema:
type: string
description: Country ISO 3166 code.
example: <string>
- name: state
in: query
schema:
type: string
description: State code.
example: <string>
- name: postcode
in: query
schema:
type: string
description: Postcode / ZIP.
example: <string>
- name: city
in: query
schema:
type: string
description: City name.
example: <string>
- name: rate
in: query
schema:
type: string
description: Tax rate.
example: <string>
- name: name
in: query
schema:
type: string
description: Tax rate name.
example: <string>
- name: priority
in: query
schema:
type: string
description: Tax priority.
example: <string>
- name: compound
in: query
schema:
type: string
description: Whether or not this is a compound rate.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
- name: order
in: query
schema:
type: string
description: Indicates the order that will appear in queries.
example: <string>
- name: class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- taxes > {id}
summary: /wc/v3/taxes/:id
requestBody:
content: {}
parameters:
- name: country
in: query
schema:
type: string
description: Country ISO 3166 code.
example: <string>
- name: state
in: query
schema:
type: string
description: State code.
example: <string>
- name: postcode
in: query
schema:
type: string
description: Postcode / ZIP.
example: <string>
- name: city
in: query
schema:
type: string
description: City name.
example: <string>
- name: rate
in: query
schema:
type: string
description: Tax rate.
example: <string>
- name: name
in: query
schema:
type: string
description: Tax rate name.
example: <string>
- name: priority
in: query
schema:
type: string
description: Tax priority.
example: <string>
- name: compound
in: query
schema:
type: string
description: Whether or not this is a compound rate.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
- name: order
in: query
schema:
type: string
description: Indicates the order that will appear in queries.
example: <string>
- name: class
in: query
schema:
type: string
description: Tax class.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- taxes > {id}
summary: /wc/v3/taxes/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/taxes/batch:
post:
tags:
- taxes > batch
summary: /wc/v3/taxes/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
country:
type: string
description: Country ISO 3166 code.
example: <string>
state:
type: string
description: State code.
example: <string>
postcode:
type: string
description: Postcode / ZIP.
example: <string>
city:
type: string
description: City name.
example: <string>
rate:
type: string
description: Tax rate.
example: <string>
name:
type: string
description: Tax rate name.
example: <string>
priority:
type: string
description: Tax priority.
example: <string>
compound:
type: string
description: Whether or not this is a compound rate.
example: <string>
shipping:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
order:
type: string
description: Indicates the order that will appear in queries.
example: <string>
class:
type: string
description: Tax class.
example: '["<string>","<string>"]'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- taxes > batch
summary: /wc/v3/taxes/batch
requestBody:
content: {}
parameters:
- name: country
in: query
schema:
type: string
description: Country ISO 3166 code.
example: <string>
- name: state
in: query
schema:
type: string
description: State code.
example: <string>
- name: postcode
in: query
schema:
type: string
description: Postcode / ZIP.
example: <string>
- name: city
in: query
schema:
type: string
description: City name.
example: <string>
- name: rate
in: query
schema:
type: string
description: Tax rate.
example: <string>
- name: name
in: query
schema:
type: string
description: Tax rate name.
example: <string>
- name: priority
in: query
schema:
type: string
description: Tax priority.
example: <string>
- name: compound
in: query
schema:
type: string
description: Whether or not this is a compound rate.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
- name: order
in: query
schema:
type: string
description: Indicates the order that will appear in queries.
example: <string>
- name: class
in: query
schema:
type: string
description: Tax class.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- taxes > batch
summary: /wc/v3/taxes/batch
requestBody:
content: {}
parameters:
- name: country
in: query
schema:
type: string
description: Country ISO 3166 code.
example: <string>
- name: state
in: query
schema:
type: string
description: State code.
example: <string>
- name: postcode
in: query
schema:
type: string
description: Postcode / ZIP.
example: <string>
- name: city
in: query
schema:
type: string
description: City name.
example: <string>
- name: rate
in: query
schema:
type: string
description: Tax rate.
example: <string>
- name: name
in: query
schema:
type: string
description: Tax rate name.
example: <string>
- name: priority
in: query
schema:
type: string
description: Tax priority.
example: <string>
- name: compound
in: query
schema:
type: string
description: Whether or not this is a compound rate.
example: <string>
- name: shipping
in: query
schema:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
- name: order
in: query
schema:
type: string
description: Indicates the order that will appear in queries.
example: <string>
- name: class
in: query
schema:
type: string
description: Tax class.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/taxes:
get:
tags:
- taxes
summary: /wc/v3/taxes
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: asc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: order
- name: class
in: query
schema:
type: string
description: Sort by tax class.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- taxes
summary: /wc/v3/taxes
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
country:
type: string
description: Country ISO 3166 code.
example: <string>
state:
type: string
description: State code.
example: <string>
postcode:
type: string
description: Postcode / ZIP.
example: <string>
city:
type: string
description: City name.
example: <string>
rate:
type: string
description: Tax rate.
example: <string>
name:
type: string
description: Tax rate name.
example: <string>
priority:
type: string
description: Tax priority.
example: <string>
compound:
type: string
description: Whether or not this is a compound rate.
example: <string>
shipping:
type: string
description: Whether or not this tax rate also gets applied to shipping.
example: <string>
order:
type: string
description: Indicates the order that will appear in queries.
example: <string>
class:
type: string
description: Tax class.
example: '["standard","standard"]'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/webhooks/{id}:
get:
tags:
- webhooks > {id}
summary: /wc/v3/webhooks/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- webhooks > {id}
summary: /wc/v3/webhooks/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: A friendly name for the webhook.
example: <string>
status:
type: string
description: Webhook status.
example: '["<string>","<string>"]'
topic:
type: string
description: Webhook topic.
example: <string>
secret:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook
and provided in the request headers. This will default to a
MD5 hash from the current user's ID|username if not
provided.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- webhooks > {id}
summary: /wc/v3/webhooks/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: A friendly name for the webhook.
example: <string>
- name: status
in: query
schema:
type: string
description: Webhook status.
example: <string>
- name: topic
in: query
schema:
type: string
description: Webhook topic.
example: <string>
- name: secret
in: query
schema:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook and
provided in the request headers. This will default to a MD5 hash
from the current user's ID|username if not provided.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- webhooks > {id}
summary: /wc/v3/webhooks/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: A friendly name for the webhook.
example: <string>
- name: status
in: query
schema:
type: string
description: Webhook status.
example: <string>
- name: topic
in: query
schema:
type: string
description: Webhook topic.
example: <string>
- name: secret
in: query
schema:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook and
provided in the request headers. This will default to a MD5 hash
from the current user's ID|username if not provided.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
delete:
tags:
- webhooks > {id}
summary: /wc/v3/webhooks/:id
parameters:
- name: force
in: query
schema:
type: string
description: Required to be true, as resource does not support trashing.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/webhooks/batch:
post:
tags:
- webhooks > batch
summary: /wc/v3/webhooks/batch
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: A friendly name for the webhook.
example: <string>
status:
type: string
description: Webhook status.
example: '["<string>","<string>"]'
topic:
type: string
description: Webhook topic.
example: <string>
secret:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook
and provided in the request headers. This will default to a
MD5 hash from the current user's ID|username if not
provided.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- webhooks > batch
summary: /wc/v3/webhooks/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: A friendly name for the webhook.
example: <string>
- name: status
in: query
schema:
type: string
description: Webhook status.
example: <string>
- name: topic
in: query
schema:
type: string
description: Webhook topic.
example: <string>
- name: secret
in: query
schema:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook and
provided in the request headers. This will default to a MD5 hash
from the current user's ID|username if not provided.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- webhooks > batch
summary: /wc/v3/webhooks/batch
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: A friendly name for the webhook.
example: <string>
- name: status
in: query
schema:
type: string
description: Webhook status.
example: <string>
- name: topic
in: query
schema:
type: string
description: Webhook topic.
example: <string>
- name: secret
in: query
schema:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook and
provided in the request headers. This will default to a MD5 hash
from the current user's ID|username if not provided.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/webhooks:
get:
tags:
- webhooks
summary: /wc/v3/webhooks
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: page
in: query
schema:
type: string
description: Current page of the collection.
example: <string>
- name: per_page
in: query
schema:
type: string
description: Maximum number of items to be returned in result set.
example: <string>
- name: search
in: query
schema:
type: string
description: Limit results to those matching a string.
example: <string>
- name: after
in: query
schema:
type: string
description: >-
Limit response to resources published after a given ISO8601
compliant date.
example: <dateTime>
- name: before
in: query
schema:
type: string
description: >-
Limit response to resources published before a given ISO8601
compliant date.
example: <dateTime>
- name: exclude
in: query
schema:
type: string
description: Ensure result set excludes specific IDs.
example: <string>
- name: include
in: query
schema:
type: string
description: Limit result set to specific ids.
example: <string>
- name: offset
in: query
schema:
type: string
description: Offset the result set by a specific number of items.
example: <string>
- name: order
in: query
schema:
type: string
description: Order sort attribute ascending or descending.
example: desc
- name: orderby
in: query
schema:
type: string
description: Sort collection by object attribute.
example: date
- name: status
in: query
schema:
type: string
description: Limit result set to webhooks assigned a specific status.
example: all
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- webhooks
summary: /wc/v3/webhooks
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
topic:
type: string
description: Webhook topic.
example: <string>
delivery_url:
type: string
description: Webhook delivery URL.
example: <string>
name:
type: string
description: A friendly name for the webhook.
example: <string>
status:
type: string
description: Webhook status.
example: '["active","active"]'
secret:
type: string
description: >-
Secret key used to generate a hash of the delivered webhook
and provided in the request headers. This will default to a
MD5 hash from the current user's ID|username if not
provided.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/system_status/tools/{id}:
get:
tags:
- system status > tools > {id}
summary: /wc/v3/system_status/tools/:id
parameters:
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- system status > tools > {id}
summary: /wc/v3/system_status/tools/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Tool name.
example: <string>
action:
type: string
description: What running the tool will do.
example: <string>
description:
type: string
description: Tool description.
example: <string>
success:
type: string
description: Did the tool run successfully?
example: <string>
message:
type: string
description: Tool return message.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) A unique identifier for the tool.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- system status > tools > {id}
summary: /wc/v3/system_status/tools/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Tool name.
example: <string>
- name: action
in: query
schema:
type: string
description: What running the tool will do.
example: <string>
- name: description
in: query
schema:
type: string
description: Tool description.
example: <string>
- name: success
in: query
schema:
type: string
description: Did the tool run successfully?
example: <string>
- name: message
in: query
schema:
type: string
description: Tool return message.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) A unique identifier for the tool.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- system status > tools > {id}
summary: /wc/v3/system_status/tools/:id
requestBody:
content: {}
parameters:
- name: name
in: query
schema:
type: string
description: Tool name.
example: <string>
- name: action
in: query
schema:
type: string
description: What running the tool will do.
example: <string>
- name: description
in: query
schema:
type: string
description: Tool description.
example: <string>
- name: success
in: query
schema:
type: string
description: Did the tool run successfully?
example: <string>
- name: message
in: query
schema:
type: string
description: Tool return message.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) A unique identifier for the tool.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/system_status/tools:
get:
tags:
- system status > tools
summary: /wc/v3/system_status/tools
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/system_status:
get:
tags:
- system status
summary: /wc/v3/system_status
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping_methods:
get:
tags:
- shipping methods
summary: /wc/v3/shipping_methods
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/shipping_methods/{id}:
get:
tags:
- shipping methods
summary: /wc/v3/shipping_methods/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/payment_gateways/{id}:
get:
tags:
- payment gateways > {id}
summary: /wc/v3/payment_gateways/:id
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
post:
tags:
- payment gateways > {id}
summary: /wc/v3/payment_gateways/:id
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description: Payment gateway title on checkout.
example: <string>
description:
type: string
description: Payment gateway description on checkout.
example: <string>
order:
type: string
description: Payment gateway sort order.
example: <string>
enabled:
type: string
description: Payment gateway enabled status.
example: <string>
settings:
type: string
description: Payment gateway settings.
example: <string>
parameters:
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
put:
tags:
- payment gateways > {id}
summary: /wc/v3/payment_gateways/:id
requestBody:
content: {}
parameters:
- name: title
in: query
schema:
type: string
description: Payment gateway title on checkout.
example: <string>
- name: description
in: query
schema:
type: string
description: Payment gateway description on checkout.
example: <string>
- name: order
in: query
schema:
type: string
description: Payment gateway sort order.
example: <string>
- name: enabled
in: query
schema:
type: string
description: Payment gateway enabled status.
example: <string>
- name: settings
in: query
schema:
type: string
description: Payment gateway settings.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
patch:
tags:
- payment gateways > {id}
summary: /wc/v3/payment_gateways/:id
requestBody:
content: {}
parameters:
- name: title
in: query
schema:
type: string
description: Payment gateway title on checkout.
example: <string>
- name: description
in: query
schema:
type: string
description: Payment gateway description on checkout.
example: <string>
- name: order
in: query
schema:
type: string
description: Payment gateway sort order.
example: <string>
- name: enabled
in: query
schema:
type: string
description: Payment gateway enabled status.
example: <string>
- name: settings
in: query
schema:
type: string
description: Payment gateway settings.
example: <string>
- name: id
in: path
schema:
type: string
required: true
description: (Required) Unique identifier for the resource.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/payment_gateways:
get:
tags:
- payment gateways
summary: /wc/v3/payment_gateways
parameters:
- name: context
in: query
schema:
type: string
description: >-
Scope under which the request is made; determines fields present in
response.
example: view
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/continents:
get:
tags:
- data > continents
summary: /wc/v3/data/continents
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/continents/{location}:
get:
tags:
- data > continents
summary: /wc/v3/data/continents/:location
parameters:
- name: continent
in: query
schema:
type: string
description: 2 character continent code.
example: <string>
- name: location
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/countries:
get:
tags:
- data > countries
summary: /wc/v3/data/countries
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/countries/{location}:
get:
tags:
- data > countries
summary: /wc/v3/data/countries/:location
parameters:
- name: location
in: path
schema:
type: string
required: true
description: (Required) ISO3166 alpha-2 country code.
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/currencies:
get:
tags:
- data > currencies
summary: /wc/v3/data/currencies
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/currencies/current:
get:
tags:
- data > currencies
summary: /wc/v3/data/currencies/current
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data/currencies/{currency}:
get:
tags:
- data > currencies
summary: /wc/v3/data/currencies/:currency
parameters:
- name: location
in: query
schema:
type: string
description: ISO4217 currency code.
example: <string>
- name: currency
in: path
schema:
type: string
required: true
description: '(Required) '
example: <string>
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
/wc/v3/data:
get:
tags:
- data
summary: /wc/v3/data
responses:
'200':
description: OK
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'400':
description: Bad Request
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
'404':
description: Not Found
headers:
Content-Type:
schema:
type: string
example: text/plain
content:
text/plain:
schema:
type: string
example: ''
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment