14486 lines
475 KiB
YAML
Executable file
14486 lines
475 KiB
YAML
Executable file
openapi: 3.0.0
|
|
info:
|
|
title: wc/v3
|
|
description: OpenAPI documented, based on generated OpenAPI document of the namespace wc/v3 with some manual fixes.
|
|
version: "1"
|
|
servers:
|
|
- url: https://www.software-creation.nl/wp-json/wc/v3
|
|
- url: http://localhost/wp-json/wc/v3
|
|
security:
|
|
- basicAuth: []
|
|
paths:
|
|
/:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: namespace
|
|
in: query
|
|
description: ""
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: context
|
|
in: query
|
|
description: ""
|
|
required: false
|
|
schema:
|
|
type: string
|
|
/coupons:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
- name: modified_after
|
|
in: query
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
- name: modified_before
|
|
in: query
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
- name: dates_are_gmt
|
|
in: query
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- id
|
|
- include
|
|
- title
|
|
- slug
|
|
- modified
|
|
- name: code
|
|
in: query
|
|
description: Limit result set to resources with a specific code.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to resources with a specific code.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_coupon
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
amount:
|
|
type: string
|
|
description: The amount of discount. Should always be numeric, even if setting a percentage.
|
|
discount_type:
|
|
type: string
|
|
description: Determines the type of discount that will be applied.
|
|
enum:
|
|
- percent
|
|
- fixed_cart
|
|
- fixed_product
|
|
description:
|
|
type: string
|
|
description: Coupon description.
|
|
date_expires:
|
|
type: string
|
|
description: The date the coupon expires, in the site's timezone.
|
|
date_expires_gmt:
|
|
type: string
|
|
description: The date the coupon expires, as GMT.
|
|
individual_use:
|
|
type: boolean
|
|
description: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
|
|
product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon can be used on.
|
|
excluded_product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon cannot be used on.
|
|
usage_limit:
|
|
type: integer
|
|
description: How many times the coupon can be used in total.
|
|
usage_limit_per_user:
|
|
type: integer
|
|
description: How many times the coupon can be used per customer.
|
|
limit_usage_to_x_items:
|
|
type: integer
|
|
description: Max number of items in the cart the coupon can be applied to.
|
|
free_shipping:
|
|
type: boolean
|
|
description: If true and if the free shipping method requires a coupon, this coupon will enable free shipping.
|
|
product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon applies to.
|
|
excluded_product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon does not apply to.
|
|
exclude_sale_items:
|
|
type: boolean
|
|
description: If true, this coupon will not be applied to items that have sale prices.
|
|
minimum_amount:
|
|
type: string
|
|
description: Minimum order amount that needs to be in the cart before coupon applies.
|
|
maximum_amount:
|
|
type: string
|
|
description: Maximum order amount allowed when using the coupon.
|
|
email_restrictions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of email addresses that can use this coupon.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
/coupons/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_coupon
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
amount:
|
|
type: string
|
|
description: The amount of discount. Should always be numeric, even if setting a percentage.
|
|
discount_type:
|
|
type: string
|
|
description: Determines the type of discount that will be applied.
|
|
enum:
|
|
- percent
|
|
- fixed_cart
|
|
- fixed_product
|
|
description:
|
|
type: string
|
|
description: Coupon description.
|
|
date_expires:
|
|
type: string
|
|
description: The date the coupon expires, in the site's timezone.
|
|
date_expires_gmt:
|
|
type: string
|
|
description: The date the coupon expires, as GMT.
|
|
individual_use:
|
|
type: boolean
|
|
description: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
|
|
product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon can be used on.
|
|
excluded_product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon cannot be used on.
|
|
usage_limit:
|
|
type: integer
|
|
description: How many times the coupon can be used in total.
|
|
usage_limit_per_user:
|
|
type: integer
|
|
description: How many times the coupon can be used per customer.
|
|
limit_usage_to_x_items:
|
|
type: integer
|
|
description: Max number of items in the cart the coupon can be applied to.
|
|
free_shipping:
|
|
type: boolean
|
|
description: If true and if the free shipping method requires a coupon, this coupon will enable free shipping.
|
|
product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon applies to.
|
|
excluded_product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon does not apply to.
|
|
exclude_sale_items:
|
|
type: boolean
|
|
description: If true, this coupon will not be applied to items that have sale prices.
|
|
minimum_amount:
|
|
type: string
|
|
description: Minimum order amount that needs to be in the cart before coupon applies.
|
|
maximum_amount:
|
|
type: string
|
|
description: Maximum order amount allowed when using the coupon.
|
|
email_restrictions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of email addresses that can use this coupon.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_coupon
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
amount:
|
|
type: string
|
|
description: The amount of discount. Should always be numeric, even if setting a percentage.
|
|
discount_type:
|
|
type: string
|
|
description: Determines the type of discount that will be applied.
|
|
enum:
|
|
- percent
|
|
- fixed_cart
|
|
- fixed_product
|
|
description:
|
|
type: string
|
|
description: Coupon description.
|
|
date_expires:
|
|
type: string
|
|
description: The date the coupon expires, in the site's timezone.
|
|
date_expires_gmt:
|
|
type: string
|
|
description: The date the coupon expires, as GMT.
|
|
individual_use:
|
|
type: boolean
|
|
description: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
|
|
product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon can be used on.
|
|
excluded_product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon cannot be used on.
|
|
usage_limit:
|
|
type: integer
|
|
description: How many times the coupon can be used in total.
|
|
usage_limit_per_user:
|
|
type: integer
|
|
description: How many times the coupon can be used per customer.
|
|
limit_usage_to_x_items:
|
|
type: integer
|
|
description: Max number of items in the cart the coupon can be applied to.
|
|
free_shipping:
|
|
type: boolean
|
|
description: If true and if the free shipping method requires a coupon, this coupon will enable free shipping.
|
|
product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon applies to.
|
|
excluded_product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon does not apply to.
|
|
exclude_sale_items:
|
|
type: boolean
|
|
description: If true, this coupon will not be applied to items that have sale prices.
|
|
minimum_amount:
|
|
type: string
|
|
description: Minimum order amount that needs to be in the cart before coupon applies.
|
|
maximum_amount:
|
|
type: string
|
|
description: Maximum order amount allowed when using the coupon.
|
|
email_restrictions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of email addresses that can use this coupon.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_coupon
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
amount:
|
|
type: string
|
|
description: The amount of discount. Should always be numeric, even if setting a percentage.
|
|
discount_type:
|
|
type: string
|
|
description: Determines the type of discount that will be applied.
|
|
enum:
|
|
- percent
|
|
- fixed_cart
|
|
- fixed_product
|
|
description:
|
|
type: string
|
|
description: Coupon description.
|
|
date_expires:
|
|
type: string
|
|
description: The date the coupon expires, in the site's timezone.
|
|
date_expires_gmt:
|
|
type: string
|
|
description: The date the coupon expires, as GMT.
|
|
individual_use:
|
|
type: boolean
|
|
description: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
|
|
product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon can be used on.
|
|
excluded_product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon cannot be used on.
|
|
usage_limit:
|
|
type: integer
|
|
description: How many times the coupon can be used in total.
|
|
usage_limit_per_user:
|
|
type: integer
|
|
description: How many times the coupon can be used per customer.
|
|
limit_usage_to_x_items:
|
|
type: integer
|
|
description: Max number of items in the cart the coupon can be applied to.
|
|
free_shipping:
|
|
type: boolean
|
|
description: If true and if the free shipping method requires a coupon, this coupon will enable free shipping.
|
|
product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon applies to.
|
|
excluded_product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon does not apply to.
|
|
exclude_sale_items:
|
|
type: boolean
|
|
description: If true, this coupon will not be applied to items that have sale prices.
|
|
minimum_amount:
|
|
type: string
|
|
description: Minimum order amount that needs to be in the cart before coupon applies.
|
|
maximum_amount:
|
|
type: string
|
|
description: Maximum order amount allowed when using the coupon.
|
|
email_restrictions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of email addresses that can use this coupon.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_coupon"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/customers/{customer_id}/downloads:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/customer_download"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: customer_id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/customers:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific IDs.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- id
|
|
- include
|
|
- name
|
|
- registered_date
|
|
- name: email
|
|
in: query
|
|
description: Limit result set to resources with a specific email.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: email
|
|
description: Limit result set to resources with a specific email.
|
|
- name: role
|
|
in: query
|
|
description: Limit result set to resources with a specific role.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to resources with a specific role.
|
|
enum:
|
|
- all
|
|
- administrator
|
|
- editor
|
|
- author
|
|
- contributor
|
|
- subscriber
|
|
- customer
|
|
- shop_manager
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: customer
|
|
properties:
|
|
email:
|
|
type: string
|
|
description: New user email address.
|
|
first_name:
|
|
type: string
|
|
description: Customer first name.
|
|
last_name:
|
|
type: string
|
|
description: Customer last name.
|
|
username:
|
|
type: string
|
|
description: New user username.
|
|
password:
|
|
type: string
|
|
description: New user password.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of billing address data.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of shipping address data.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
/customers/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: customer
|
|
properties:
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: The email address for the customer.
|
|
first_name:
|
|
type: string
|
|
description: Customer first name.
|
|
last_name:
|
|
type: string
|
|
description: Customer last name.
|
|
username:
|
|
type: string
|
|
description: Customer login name.
|
|
password:
|
|
type: string
|
|
description: Customer password.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of billing address data.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of shipping address data.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: customer
|
|
properties:
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: The email address for the customer.
|
|
first_name:
|
|
type: string
|
|
description: Customer first name.
|
|
last_name:
|
|
type: string
|
|
description: Customer last name.
|
|
username:
|
|
type: string
|
|
description: Customer login name.
|
|
password:
|
|
type: string
|
|
description: Customer password.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of billing address data.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of shipping address data.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: customer
|
|
properties:
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: The email address for the customer.
|
|
first_name:
|
|
type: string
|
|
description: Customer first name.
|
|
last_name:
|
|
type: string
|
|
description: Customer last name.
|
|
username:
|
|
type: string
|
|
description: Customer login name.
|
|
password:
|
|
type: string
|
|
description: Customer password.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of billing address data.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of shipping address data.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/customer"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
- name: reassign
|
|
in: query
|
|
description: ID to reassign posts to.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: ID to reassign posts to.
|
|
/orders/{order_id}/notes:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/order_note"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: type
|
|
in: query
|
|
description: Limit result to customers or internal notes.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result to customers or internal notes.
|
|
enum:
|
|
- any
|
|
- customer
|
|
- internal
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/order_note"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: order_note
|
|
properties:
|
|
note:
|
|
type: string
|
|
description: Order note content.
|
|
customer_note:
|
|
type: boolean
|
|
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.
|
|
added_by_user:
|
|
type: boolean
|
|
description: If true, this note will be attributed to the current user. If false, the note will be attributed to the system.
|
|
parameters:
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
/orders/{order_id}/notes/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/order_note"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/order_note"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/orders/{order_id}/refunds:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shop_order_refund"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
- name: modified_after
|
|
in: query
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
- name: modified_before
|
|
in: query
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
- name: dates_are_gmt
|
|
in: query
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- id
|
|
- include
|
|
- title
|
|
- slug
|
|
- modified
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to those of particular parent IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to those of particular parent IDs.
|
|
- name: parent_exclude
|
|
in: query
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
- name: dp
|
|
in: query
|
|
description: Number of decimal points to use in each resource.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Number of decimal points to use in each resource.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order_refund"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_order_refund
|
|
properties:
|
|
amount:
|
|
type: string
|
|
description: Refund amount.
|
|
reason:
|
|
type: string
|
|
description: Reason for refund.
|
|
refunded_by:
|
|
type: integer
|
|
description: User ID of user who created the refund.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
api_refund:
|
|
type: boolean
|
|
description: When true, the payment gateway API is used to generate the refund.
|
|
api_restock:
|
|
type: boolean
|
|
description: When true, refunded items are restocked.
|
|
parameters:
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
/orders/{order_id}/refunds/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order_refund"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order_refund"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: order_id
|
|
in: path
|
|
description: The order ID.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: The order ID.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/orders:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
- name: modified_after
|
|
in: query
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
- name: modified_before
|
|
in: query
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
- name: dates_are_gmt
|
|
in: query
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- id
|
|
- include
|
|
- title
|
|
- slug
|
|
- modified
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to those of particular parent IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to those of particular parent IDs.
|
|
- name: parent_exclude
|
|
in: query
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
- name: status
|
|
in: query
|
|
description: Limit result set to orders which have specific statuses.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- any
|
|
- trash
|
|
- pending
|
|
- processing
|
|
- on-hold
|
|
- completed
|
|
- cancelled
|
|
- refunded
|
|
- failed
|
|
description: Limit result set to orders which have specific statuses.
|
|
- name: customer
|
|
in: query
|
|
description: Limit result set to orders assigned a specific customer.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to orders assigned a specific customer.
|
|
- name: product
|
|
in: query
|
|
description: Limit result set to orders assigned a specific product.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to orders assigned a specific product.
|
|
- name: dp
|
|
in: query
|
|
description: Number of decimal points to use in each resource.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Number of decimal points to use in each resource.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_order
|
|
properties:
|
|
parent_id:
|
|
type: integer
|
|
description: Parent order ID.
|
|
status:
|
|
type: string
|
|
description: Order status.
|
|
enum:
|
|
- pending
|
|
- processing
|
|
- on-hold
|
|
- completed
|
|
- cancelled
|
|
- refunded
|
|
- failed
|
|
currency:
|
|
type: string
|
|
description: Currency the order was created with, in ISO format.
|
|
enum:
|
|
- AED
|
|
- AFN
|
|
- ALL
|
|
- AMD
|
|
- ANG
|
|
- AOA
|
|
- ARS
|
|
- AUD
|
|
- AWG
|
|
- AZN
|
|
- BAM
|
|
- BBD
|
|
- BDT
|
|
- BGN
|
|
- BHD
|
|
- BIF
|
|
- BMD
|
|
- BND
|
|
- BOB
|
|
- BRL
|
|
- BSD
|
|
- BTC
|
|
- BTN
|
|
- BWP
|
|
- BYR
|
|
- BYN
|
|
- BZD
|
|
- CAD
|
|
- CDF
|
|
- CHF
|
|
- CLP
|
|
- CNY
|
|
- COP
|
|
- CRC
|
|
- CUC
|
|
- CUP
|
|
- CVE
|
|
- CZK
|
|
- DJF
|
|
- DKK
|
|
- DOP
|
|
- DZD
|
|
- EGP
|
|
- ERN
|
|
- ETB
|
|
- EUR
|
|
- FJD
|
|
- FKP
|
|
- GBP
|
|
- GEL
|
|
- GGP
|
|
- GHS
|
|
- GIP
|
|
- GMD
|
|
- GNF
|
|
- GTQ
|
|
- GYD
|
|
- HKD
|
|
- HNL
|
|
- HRK
|
|
- HTG
|
|
- HUF
|
|
- IDR
|
|
- ILS
|
|
- IMP
|
|
- INR
|
|
- IQD
|
|
- IRR
|
|
- IRT
|
|
- ISK
|
|
- JEP
|
|
- JMD
|
|
- JOD
|
|
- JPY
|
|
- KES
|
|
- KGS
|
|
- KHR
|
|
- KMF
|
|
- KPW
|
|
- KRW
|
|
- KWD
|
|
- KYD
|
|
- KZT
|
|
- LAK
|
|
- LBP
|
|
- LKR
|
|
- LRD
|
|
- LSL
|
|
- LYD
|
|
- MAD
|
|
- MDL
|
|
- MGA
|
|
- MKD
|
|
- MMK
|
|
- MNT
|
|
- MOP
|
|
- MRU
|
|
- MUR
|
|
- MVR
|
|
- MWK
|
|
- MXN
|
|
- MYR
|
|
- MZN
|
|
- NAD
|
|
- NGN
|
|
- NIO
|
|
- NOK
|
|
- NPR
|
|
- NZD
|
|
- OMR
|
|
- PAB
|
|
- PEN
|
|
- PGK
|
|
- PHP
|
|
- PKR
|
|
- PLN
|
|
- PRB
|
|
- PYG
|
|
- QAR
|
|
- RON
|
|
- RSD
|
|
- RUB
|
|
- RWF
|
|
- SAR
|
|
- SBD
|
|
- SCR
|
|
- SDG
|
|
- SEK
|
|
- SGD
|
|
- SHP
|
|
- SLL
|
|
- SOS
|
|
- SRD
|
|
- SSP
|
|
- STN
|
|
- SYP
|
|
- SZL
|
|
- THB
|
|
- TJS
|
|
- TMT
|
|
- TND
|
|
- TOP
|
|
- TRY
|
|
- TTD
|
|
- TWD
|
|
- TZS
|
|
- UAH
|
|
- UGX
|
|
- USD
|
|
- UYU
|
|
- UZS
|
|
- VEF
|
|
- VES
|
|
- VND
|
|
- VUV
|
|
- WST
|
|
- XAF
|
|
- XCD
|
|
- XOF
|
|
- XPF
|
|
- YER
|
|
- ZAR
|
|
- ZMW
|
|
customer_id:
|
|
type: integer
|
|
description: User ID who owns the order. 0 for guests.
|
|
customer_note:
|
|
type: string
|
|
description: Note left by customer during checkout.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: Billing address.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
description: Shipping address.
|
|
payment_method:
|
|
type: string
|
|
description: Payment method ID.
|
|
payment_method_title:
|
|
type: string
|
|
description: Payment method title.
|
|
transaction_id:
|
|
type: string
|
|
description: Unique transaction ID.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
line_items:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
parent_name:
|
|
type: string
|
|
description: Parent product name if the product is a variation.
|
|
product_id:
|
|
type: string
|
|
description: Product ID.
|
|
variation_id:
|
|
type: integer
|
|
description: Variation ID, if applicable.
|
|
quantity:
|
|
type: integer
|
|
description: Quantity ordered.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of product.
|
|
subtotal:
|
|
type: string
|
|
description: Line subtotal (before discounts).
|
|
subtotal_tax:
|
|
type: string
|
|
description: Line subtotal tax (before discounts).
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
display_key:
|
|
type: string
|
|
description: Meta key for UI display.
|
|
display_value:
|
|
type: string
|
|
description: Meta value for UI display.
|
|
description: Meta data.
|
|
sku:
|
|
type: string
|
|
description: Product SKU.
|
|
price:
|
|
type: number
|
|
description: Product price.
|
|
description: Line items data.
|
|
shipping_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
method_title:
|
|
type: string
|
|
description: Shipping method name.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
instance_id:
|
|
type: string
|
|
description: Shipping instance ID.
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Shipping lines data.
|
|
fee_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Fee name.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of fee.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status of fee.
|
|
enum:
|
|
- taxable
|
|
- none
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Fee lines data.
|
|
coupon_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
discount:
|
|
type: string
|
|
description: Discount total.
|
|
discount_tax:
|
|
type: string
|
|
description: Discount total tax.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Coupons line data.
|
|
set_paid:
|
|
type: boolean
|
|
description: Define if the order is paid. It will set the status to processing and reduce stock items.
|
|
/orders/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_order
|
|
properties:
|
|
parent_id:
|
|
type: integer
|
|
description: Parent order ID.
|
|
status:
|
|
type: string
|
|
description: Order status.
|
|
enum:
|
|
- pending
|
|
- processing
|
|
- on-hold
|
|
- completed
|
|
- cancelled
|
|
- refunded
|
|
- failed
|
|
currency:
|
|
type: string
|
|
description: Currency the order was created with, in ISO format.
|
|
enum:
|
|
- AED
|
|
- AFN
|
|
- ALL
|
|
- AMD
|
|
- ANG
|
|
- AOA
|
|
- ARS
|
|
- AUD
|
|
- AWG
|
|
- AZN
|
|
- BAM
|
|
- BBD
|
|
- BDT
|
|
- BGN
|
|
- BHD
|
|
- BIF
|
|
- BMD
|
|
- BND
|
|
- BOB
|
|
- BRL
|
|
- BSD
|
|
- BTC
|
|
- BTN
|
|
- BWP
|
|
- BYR
|
|
- BYN
|
|
- BZD
|
|
- CAD
|
|
- CDF
|
|
- CHF
|
|
- CLP
|
|
- CNY
|
|
- COP
|
|
- CRC
|
|
- CUC
|
|
- CUP
|
|
- CVE
|
|
- CZK
|
|
- DJF
|
|
- DKK
|
|
- DOP
|
|
- DZD
|
|
- EGP
|
|
- ERN
|
|
- ETB
|
|
- EUR
|
|
- FJD
|
|
- FKP
|
|
- GBP
|
|
- GEL
|
|
- GGP
|
|
- GHS
|
|
- GIP
|
|
- GMD
|
|
- GNF
|
|
- GTQ
|
|
- GYD
|
|
- HKD
|
|
- HNL
|
|
- HRK
|
|
- HTG
|
|
- HUF
|
|
- IDR
|
|
- ILS
|
|
- IMP
|
|
- INR
|
|
- IQD
|
|
- IRR
|
|
- IRT
|
|
- ISK
|
|
- JEP
|
|
- JMD
|
|
- JOD
|
|
- JPY
|
|
- KES
|
|
- KGS
|
|
- KHR
|
|
- KMF
|
|
- KPW
|
|
- KRW
|
|
- KWD
|
|
- KYD
|
|
- KZT
|
|
- LAK
|
|
- LBP
|
|
- LKR
|
|
- LRD
|
|
- LSL
|
|
- LYD
|
|
- MAD
|
|
- MDL
|
|
- MGA
|
|
- MKD
|
|
- MMK
|
|
- MNT
|
|
- MOP
|
|
- MRU
|
|
- MUR
|
|
- MVR
|
|
- MWK
|
|
- MXN
|
|
- MYR
|
|
- MZN
|
|
- NAD
|
|
- NGN
|
|
- NIO
|
|
- NOK
|
|
- NPR
|
|
- NZD
|
|
- OMR
|
|
- PAB
|
|
- PEN
|
|
- PGK
|
|
- PHP
|
|
- PKR
|
|
- PLN
|
|
- PRB
|
|
- PYG
|
|
- QAR
|
|
- RON
|
|
- RSD
|
|
- RUB
|
|
- RWF
|
|
- SAR
|
|
- SBD
|
|
- SCR
|
|
- SDG
|
|
- SEK
|
|
- SGD
|
|
- SHP
|
|
- SLL
|
|
- SOS
|
|
- SRD
|
|
- SSP
|
|
- STN
|
|
- SYP
|
|
- SZL
|
|
- THB
|
|
- TJS
|
|
- TMT
|
|
- TND
|
|
- TOP
|
|
- TRY
|
|
- TTD
|
|
- TWD
|
|
- TZS
|
|
- UAH
|
|
- UGX
|
|
- USD
|
|
- UYU
|
|
- UZS
|
|
- VEF
|
|
- VES
|
|
- VND
|
|
- VUV
|
|
- WST
|
|
- XAF
|
|
- XCD
|
|
- XOF
|
|
- XPF
|
|
- YER
|
|
- ZAR
|
|
- ZMW
|
|
customer_id:
|
|
type: integer
|
|
description: User ID who owns the order. 0 for guests.
|
|
customer_note:
|
|
type: string
|
|
description: Note left by customer during checkout.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: Billing address.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
description: Shipping address.
|
|
payment_method:
|
|
type: string
|
|
description: Payment method ID.
|
|
payment_method_title:
|
|
type: string
|
|
description: Payment method title.
|
|
transaction_id:
|
|
type: string
|
|
description: Unique transaction ID.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
line_items:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
parent_name:
|
|
type: string
|
|
description: Parent product name if the product is a variation.
|
|
product_id:
|
|
type: string
|
|
description: Product ID.
|
|
variation_id:
|
|
type: integer
|
|
description: Variation ID, if applicable.
|
|
quantity:
|
|
type: integer
|
|
description: Quantity ordered.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of product.
|
|
subtotal:
|
|
type: string
|
|
description: Line subtotal (before discounts).
|
|
subtotal_tax:
|
|
type: string
|
|
description: Line subtotal tax (before discounts).
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
display_key:
|
|
type: string
|
|
description: Meta key for UI display.
|
|
display_value:
|
|
type: string
|
|
description: Meta value for UI display.
|
|
description: Meta data.
|
|
sku:
|
|
type: string
|
|
description: Product SKU.
|
|
price:
|
|
type: number
|
|
description: Product price.
|
|
description: Line items data.
|
|
shipping_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
method_title:
|
|
type: string
|
|
description: Shipping method name.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
instance_id:
|
|
type: string
|
|
description: Shipping instance ID.
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Shipping lines data.
|
|
fee_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Fee name.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of fee.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status of fee.
|
|
enum:
|
|
- taxable
|
|
- none
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Fee lines data.
|
|
coupon_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
discount:
|
|
type: string
|
|
description: Discount total.
|
|
discount_tax:
|
|
type: string
|
|
description: Discount total tax.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Coupons line data.
|
|
set_paid:
|
|
type: boolean
|
|
description: Define if the order is paid. It will set the status to processing and reduce stock items.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_order
|
|
properties:
|
|
parent_id:
|
|
type: integer
|
|
description: Parent order ID.
|
|
status:
|
|
type: string
|
|
description: Order status.
|
|
enum:
|
|
- pending
|
|
- processing
|
|
- on-hold
|
|
- completed
|
|
- cancelled
|
|
- refunded
|
|
- failed
|
|
currency:
|
|
type: string
|
|
description: Currency the order was created with, in ISO format.
|
|
enum:
|
|
- AED
|
|
- AFN
|
|
- ALL
|
|
- AMD
|
|
- ANG
|
|
- AOA
|
|
- ARS
|
|
- AUD
|
|
- AWG
|
|
- AZN
|
|
- BAM
|
|
- BBD
|
|
- BDT
|
|
- BGN
|
|
- BHD
|
|
- BIF
|
|
- BMD
|
|
- BND
|
|
- BOB
|
|
- BRL
|
|
- BSD
|
|
- BTC
|
|
- BTN
|
|
- BWP
|
|
- BYR
|
|
- BYN
|
|
- BZD
|
|
- CAD
|
|
- CDF
|
|
- CHF
|
|
- CLP
|
|
- CNY
|
|
- COP
|
|
- CRC
|
|
- CUC
|
|
- CUP
|
|
- CVE
|
|
- CZK
|
|
- DJF
|
|
- DKK
|
|
- DOP
|
|
- DZD
|
|
- EGP
|
|
- ERN
|
|
- ETB
|
|
- EUR
|
|
- FJD
|
|
- FKP
|
|
- GBP
|
|
- GEL
|
|
- GGP
|
|
- GHS
|
|
- GIP
|
|
- GMD
|
|
- GNF
|
|
- GTQ
|
|
- GYD
|
|
- HKD
|
|
- HNL
|
|
- HRK
|
|
- HTG
|
|
- HUF
|
|
- IDR
|
|
- ILS
|
|
- IMP
|
|
- INR
|
|
- IQD
|
|
- IRR
|
|
- IRT
|
|
- ISK
|
|
- JEP
|
|
- JMD
|
|
- JOD
|
|
- JPY
|
|
- KES
|
|
- KGS
|
|
- KHR
|
|
- KMF
|
|
- KPW
|
|
- KRW
|
|
- KWD
|
|
- KYD
|
|
- KZT
|
|
- LAK
|
|
- LBP
|
|
- LKR
|
|
- LRD
|
|
- LSL
|
|
- LYD
|
|
- MAD
|
|
- MDL
|
|
- MGA
|
|
- MKD
|
|
- MMK
|
|
- MNT
|
|
- MOP
|
|
- MRU
|
|
- MUR
|
|
- MVR
|
|
- MWK
|
|
- MXN
|
|
- MYR
|
|
- MZN
|
|
- NAD
|
|
- NGN
|
|
- NIO
|
|
- NOK
|
|
- NPR
|
|
- NZD
|
|
- OMR
|
|
- PAB
|
|
- PEN
|
|
- PGK
|
|
- PHP
|
|
- PKR
|
|
- PLN
|
|
- PRB
|
|
- PYG
|
|
- QAR
|
|
- RON
|
|
- RSD
|
|
- RUB
|
|
- RWF
|
|
- SAR
|
|
- SBD
|
|
- SCR
|
|
- SDG
|
|
- SEK
|
|
- SGD
|
|
- SHP
|
|
- SLL
|
|
- SOS
|
|
- SRD
|
|
- SSP
|
|
- STN
|
|
- SYP
|
|
- SZL
|
|
- THB
|
|
- TJS
|
|
- TMT
|
|
- TND
|
|
- TOP
|
|
- TRY
|
|
- TTD
|
|
- TWD
|
|
- TZS
|
|
- UAH
|
|
- UGX
|
|
- USD
|
|
- UYU
|
|
- UZS
|
|
- VEF
|
|
- VES
|
|
- VND
|
|
- VUV
|
|
- WST
|
|
- XAF
|
|
- XCD
|
|
- XOF
|
|
- XPF
|
|
- YER
|
|
- ZAR
|
|
- ZMW
|
|
customer_id:
|
|
type: integer
|
|
description: User ID who owns the order. 0 for guests.
|
|
customer_note:
|
|
type: string
|
|
description: Note left by customer during checkout.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: Billing address.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
description: Shipping address.
|
|
payment_method:
|
|
type: string
|
|
description: Payment method ID.
|
|
payment_method_title:
|
|
type: string
|
|
description: Payment method title.
|
|
transaction_id:
|
|
type: string
|
|
description: Unique transaction ID.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
line_items:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
parent_name:
|
|
type: string
|
|
description: Parent product name if the product is a variation.
|
|
product_id:
|
|
type: string
|
|
description: Product ID.
|
|
variation_id:
|
|
type: integer
|
|
description: Variation ID, if applicable.
|
|
quantity:
|
|
type: integer
|
|
description: Quantity ordered.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of product.
|
|
subtotal:
|
|
type: string
|
|
description: Line subtotal (before discounts).
|
|
subtotal_tax:
|
|
type: string
|
|
description: Line subtotal tax (before discounts).
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
display_key:
|
|
type: string
|
|
description: Meta key for UI display.
|
|
display_value:
|
|
type: string
|
|
description: Meta value for UI display.
|
|
description: Meta data.
|
|
sku:
|
|
type: string
|
|
description: Product SKU.
|
|
price:
|
|
type: number
|
|
description: Product price.
|
|
description: Line items data.
|
|
shipping_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
method_title:
|
|
type: string
|
|
description: Shipping method name.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
instance_id:
|
|
type: string
|
|
description: Shipping instance ID.
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Shipping lines data.
|
|
fee_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Fee name.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of fee.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status of fee.
|
|
enum:
|
|
- taxable
|
|
- none
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Fee lines data.
|
|
coupon_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
discount:
|
|
type: string
|
|
description: Discount total.
|
|
discount_tax:
|
|
type: string
|
|
description: Discount total tax.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Coupons line data.
|
|
set_paid:
|
|
type: boolean
|
|
description: Define if the order is paid. It will set the status to processing and reduce stock items.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shop_order
|
|
properties:
|
|
parent_id:
|
|
type: integer
|
|
description: Parent order ID.
|
|
status:
|
|
type: string
|
|
description: Order status.
|
|
enum:
|
|
- pending
|
|
- processing
|
|
- on-hold
|
|
- completed
|
|
- cancelled
|
|
- refunded
|
|
- failed
|
|
currency:
|
|
type: string
|
|
description: Currency the order was created with, in ISO format.
|
|
enum:
|
|
- AED
|
|
- AFN
|
|
- ALL
|
|
- AMD
|
|
- ANG
|
|
- AOA
|
|
- ARS
|
|
- AUD
|
|
- AWG
|
|
- AZN
|
|
- BAM
|
|
- BBD
|
|
- BDT
|
|
- BGN
|
|
- BHD
|
|
- BIF
|
|
- BMD
|
|
- BND
|
|
- BOB
|
|
- BRL
|
|
- BSD
|
|
- BTC
|
|
- BTN
|
|
- BWP
|
|
- BYR
|
|
- BYN
|
|
- BZD
|
|
- CAD
|
|
- CDF
|
|
- CHF
|
|
- CLP
|
|
- CNY
|
|
- COP
|
|
- CRC
|
|
- CUC
|
|
- CUP
|
|
- CVE
|
|
- CZK
|
|
- DJF
|
|
- DKK
|
|
- DOP
|
|
- DZD
|
|
- EGP
|
|
- ERN
|
|
- ETB
|
|
- EUR
|
|
- FJD
|
|
- FKP
|
|
- GBP
|
|
- GEL
|
|
- GGP
|
|
- GHS
|
|
- GIP
|
|
- GMD
|
|
- GNF
|
|
- GTQ
|
|
- GYD
|
|
- HKD
|
|
- HNL
|
|
- HRK
|
|
- HTG
|
|
- HUF
|
|
- IDR
|
|
- ILS
|
|
- IMP
|
|
- INR
|
|
- IQD
|
|
- IRR
|
|
- IRT
|
|
- ISK
|
|
- JEP
|
|
- JMD
|
|
- JOD
|
|
- JPY
|
|
- KES
|
|
- KGS
|
|
- KHR
|
|
- KMF
|
|
- KPW
|
|
- KRW
|
|
- KWD
|
|
- KYD
|
|
- KZT
|
|
- LAK
|
|
- LBP
|
|
- LKR
|
|
- LRD
|
|
- LSL
|
|
- LYD
|
|
- MAD
|
|
- MDL
|
|
- MGA
|
|
- MKD
|
|
- MMK
|
|
- MNT
|
|
- MOP
|
|
- MRU
|
|
- MUR
|
|
- MVR
|
|
- MWK
|
|
- MXN
|
|
- MYR
|
|
- MZN
|
|
- NAD
|
|
- NGN
|
|
- NIO
|
|
- NOK
|
|
- NPR
|
|
- NZD
|
|
- OMR
|
|
- PAB
|
|
- PEN
|
|
- PGK
|
|
- PHP
|
|
- PKR
|
|
- PLN
|
|
- PRB
|
|
- PYG
|
|
- QAR
|
|
- RON
|
|
- RSD
|
|
- RUB
|
|
- RWF
|
|
- SAR
|
|
- SBD
|
|
- SCR
|
|
- SDG
|
|
- SEK
|
|
- SGD
|
|
- SHP
|
|
- SLL
|
|
- SOS
|
|
- SRD
|
|
- SSP
|
|
- STN
|
|
- SYP
|
|
- SZL
|
|
- THB
|
|
- TJS
|
|
- TMT
|
|
- TND
|
|
- TOP
|
|
- TRY
|
|
- TTD
|
|
- TWD
|
|
- TZS
|
|
- UAH
|
|
- UGX
|
|
- USD
|
|
- UYU
|
|
- UZS
|
|
- VEF
|
|
- VES
|
|
- VND
|
|
- VUV
|
|
- WST
|
|
- XAF
|
|
- XCD
|
|
- XOF
|
|
- XPF
|
|
- YER
|
|
- ZAR
|
|
- ZMW
|
|
customer_id:
|
|
type: integer
|
|
description: User ID who owns the order. 0 for guests.
|
|
customer_note:
|
|
type: string
|
|
description: Note left by customer during checkout.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: Billing address.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
description: Shipping address.
|
|
payment_method:
|
|
type: string
|
|
description: Payment method ID.
|
|
payment_method_title:
|
|
type: string
|
|
description: Payment method title.
|
|
transaction_id:
|
|
type: string
|
|
description: Unique transaction ID.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
line_items:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
parent_name:
|
|
type: string
|
|
description: Parent product name if the product is a variation.
|
|
product_id:
|
|
type: string
|
|
description: Product ID.
|
|
variation_id:
|
|
type: integer
|
|
description: Variation ID, if applicable.
|
|
quantity:
|
|
type: integer
|
|
description: Quantity ordered.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of product.
|
|
subtotal:
|
|
type: string
|
|
description: Line subtotal (before discounts).
|
|
subtotal_tax:
|
|
type: string
|
|
description: Line subtotal tax (before discounts).
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
display_key:
|
|
type: string
|
|
description: Meta key for UI display.
|
|
display_value:
|
|
type: string
|
|
description: Meta value for UI display.
|
|
description: Meta data.
|
|
sku:
|
|
type: string
|
|
description: Product SKU.
|
|
price:
|
|
type: number
|
|
description: Product price.
|
|
description: Line items data.
|
|
shipping_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
method_title:
|
|
type: string
|
|
description: Shipping method name.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
instance_id:
|
|
type: string
|
|
description: Shipping instance ID.
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Shipping lines data.
|
|
fee_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Fee name.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of fee.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status of fee.
|
|
enum:
|
|
- taxable
|
|
- none
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Fee lines data.
|
|
coupon_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
discount:
|
|
type: string
|
|
description: Discount total.
|
|
discount_tax:
|
|
type: string
|
|
description: Discount total tax.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Coupons line data.
|
|
set_paid:
|
|
type: boolean
|
|
description: Define if the order is paid. It will set the status to processing and reduce stock items.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shop_order"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/products/attributes/{attribute_id}/terms:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by resource attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by resource attribute.
|
|
enum:
|
|
- id
|
|
- include
|
|
- name
|
|
- slug
|
|
- term_group
|
|
- description
|
|
- count
|
|
- name: hide_empty
|
|
in: query
|
|
description: Whether to hide resources not assigned to any products.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to hide resources not assigned to any products.
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
- name: product
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific product.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific product.
|
|
- name: slug
|
|
in: query
|
|
description: Limit result set to resources with a specific slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to resources with a specific slug.
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute_term
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name for the resource.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
/products/attributes/{attribute_id}/terms/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute_term
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Term name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute_term
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Term name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute_term
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Term name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute_term"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: attribute_id
|
|
in: path
|
|
description: Unique identifier for the attribute of the terms.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the attribute of the terms.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/products/attributes:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name for the resource.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
type:
|
|
type: string
|
|
description: Type of attribute.
|
|
enum:
|
|
- select
|
|
order_by:
|
|
type: string
|
|
description: Default sort order.
|
|
enum:
|
|
- menu_order
|
|
- name
|
|
- name_num
|
|
- id
|
|
has_archives:
|
|
type: boolean
|
|
description: Enable/Disable attribute archives.
|
|
/products/attributes/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
type:
|
|
type: string
|
|
description: Type of attribute.
|
|
enum:
|
|
- select
|
|
order_by:
|
|
type: string
|
|
description: Default sort order.
|
|
enum:
|
|
- menu_order
|
|
- name
|
|
- name_num
|
|
- id
|
|
has_archives:
|
|
type: boolean
|
|
description: Enable/Disable attribute archives.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
type:
|
|
type: string
|
|
description: Type of attribute.
|
|
enum:
|
|
- select
|
|
order_by:
|
|
type: string
|
|
description: Default sort order.
|
|
enum:
|
|
- menu_order
|
|
- name
|
|
- name_num
|
|
- id
|
|
has_archives:
|
|
type: boolean
|
|
description: Enable/Disable attribute archives.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_attribute
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
type:
|
|
type: string
|
|
description: Type of attribute.
|
|
enum:
|
|
- select
|
|
order_by:
|
|
type: string
|
|
description: Default sort order.
|
|
enum:
|
|
- menu_order
|
|
- name
|
|
- name_num
|
|
- id
|
|
has_archives:
|
|
type: boolean
|
|
description: Enable/Disable attribute archives.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_attribute"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/products/categories:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by resource attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by resource attribute.
|
|
enum:
|
|
- id
|
|
- include
|
|
- name
|
|
- slug
|
|
- term_group
|
|
- description
|
|
- count
|
|
- name: hide_empty
|
|
in: query
|
|
description: Whether to hide resources not assigned to any products.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to hide resources not assigned to any products.
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
- name: product
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific product.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific product.
|
|
- name: slug
|
|
in: query
|
|
description: Limit result set to resources with a specific slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to resources with a specific slug.
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_cat
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name for the resource.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
parent:
|
|
type: integer
|
|
description: The ID for the parent of the resource.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
display:
|
|
type: string
|
|
description: Category archive display type.
|
|
enum:
|
|
- default
|
|
- products
|
|
- subcategories
|
|
- both
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Image data.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
/products/categories/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_cat
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
parent:
|
|
type: integer
|
|
description: The ID for the parent of the resource.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
display:
|
|
type: string
|
|
description: Category archive display type.
|
|
enum:
|
|
- default
|
|
- products
|
|
- subcategories
|
|
- both
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Image data.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_cat
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
parent:
|
|
type: integer
|
|
description: The ID for the parent of the resource.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
display:
|
|
type: string
|
|
description: Category archive display type.
|
|
enum:
|
|
- default
|
|
- products
|
|
- subcategories
|
|
- both
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Image data.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_cat
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
parent:
|
|
type: integer
|
|
description: The ID for the parent of the resource.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
display:
|
|
type: string
|
|
description: Category archive display type.
|
|
enum:
|
|
- default
|
|
- products
|
|
- subcategories
|
|
- both
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Image data.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_cat"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/products/reviews:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to reviews published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to reviews published before a given ISO8601 compliant date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific IDs.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- date_gmt
|
|
- id
|
|
- include
|
|
- product
|
|
- name: reviewer
|
|
in: query
|
|
description: Limit result set to reviews assigned to specific user IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to reviews assigned to specific user IDs.
|
|
- name: reviewer_exclude
|
|
in: query
|
|
description: Ensure result set excludes reviews assigned to specific user IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes reviews assigned to specific user IDs.
|
|
- name: reviewer_email
|
|
in: query
|
|
description: Limit result set to that from a specific author email.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: email
|
|
description: Limit result set to that from a specific author email.
|
|
- name: product
|
|
in: query
|
|
description: Limit result set to reviews assigned to specific product IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to reviews assigned to specific product IDs.
|
|
- name: status
|
|
in: query
|
|
description: Limit result set to reviews assigned a specific status.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to reviews assigned a specific status.
|
|
enum:
|
|
- all
|
|
- hold
|
|
- approved
|
|
- spam
|
|
- trash
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_review
|
|
properties:
|
|
product_id:
|
|
type: integer
|
|
description: Unique identifier for the product.
|
|
status:
|
|
type: string
|
|
description: Status of the review.
|
|
enum:
|
|
- approved
|
|
- hold
|
|
- spam
|
|
- unspam
|
|
- trash
|
|
- untrash
|
|
reviewer:
|
|
type: string
|
|
description: Name of the reviewer.
|
|
reviewer_email:
|
|
type: string
|
|
description: Email of the reviewer.
|
|
review:
|
|
type: string
|
|
description: Review content.
|
|
rating:
|
|
type: integer
|
|
description: Review rating (0 to 5).
|
|
/products/reviews/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_review
|
|
properties:
|
|
product_id:
|
|
type: integer
|
|
description: Unique identifier for the product that the review belongs to.
|
|
status:
|
|
type: string
|
|
description: Status of the review.
|
|
enum:
|
|
- approved
|
|
- hold
|
|
- spam
|
|
- unspam
|
|
- trash
|
|
- untrash
|
|
reviewer:
|
|
type: string
|
|
description: Reviewer name.
|
|
reviewer_email:
|
|
type: string
|
|
format: email
|
|
description: Reviewer email.
|
|
review:
|
|
type: string
|
|
description: The content of the review.
|
|
rating:
|
|
type: integer
|
|
description: Review rating (0 to 5).
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_review
|
|
properties:
|
|
product_id:
|
|
type: integer
|
|
description: Unique identifier for the product that the review belongs to.
|
|
status:
|
|
type: string
|
|
description: Status of the review.
|
|
enum:
|
|
- approved
|
|
- hold
|
|
- spam
|
|
- unspam
|
|
- trash
|
|
- untrash
|
|
reviewer:
|
|
type: string
|
|
description: Reviewer name.
|
|
reviewer_email:
|
|
type: string
|
|
format: email
|
|
description: Reviewer email.
|
|
review:
|
|
type: string
|
|
description: The content of the review.
|
|
rating:
|
|
type: integer
|
|
description: Review rating (0 to 5).
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_review
|
|
properties:
|
|
product_id:
|
|
type: integer
|
|
description: Unique identifier for the product that the review belongs to.
|
|
status:
|
|
type: string
|
|
description: Status of the review.
|
|
enum:
|
|
- approved
|
|
- hold
|
|
- spam
|
|
- unspam
|
|
- trash
|
|
- untrash
|
|
reviewer:
|
|
type: string
|
|
description: Reviewer name.
|
|
reviewer_email:
|
|
type: string
|
|
format: email
|
|
description: Reviewer email.
|
|
review:
|
|
type: string
|
|
description: The content of the review.
|
|
rating:
|
|
type: integer
|
|
description: Review rating (0 to 5).
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_review"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/products/shipping_classes:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by resource attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by resource attribute.
|
|
enum:
|
|
- id
|
|
- include
|
|
- name
|
|
- slug
|
|
- term_group
|
|
- description
|
|
- count
|
|
- name: hide_empty
|
|
in: query
|
|
description: Whether to hide resources not assigned to any products.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to hide resources not assigned to any products.
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
- name: product
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific product.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific product.
|
|
- name: slug
|
|
in: query
|
|
description: Limit result set to resources with a specific slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to resources with a specific slug.
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_shipping_class
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name for the resource.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
/products/shipping_classes/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_shipping_class
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping class name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_shipping_class
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping class name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_shipping_class
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping class name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_shipping_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/products/tags:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by resource attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by resource attribute.
|
|
enum:
|
|
- id
|
|
- include
|
|
- name
|
|
- slug
|
|
- term_group
|
|
- description
|
|
- count
|
|
- name: hide_empty
|
|
in: query
|
|
description: Whether to hide resources not assigned to any products.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to hide resources not assigned to any products.
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.
|
|
- name: product
|
|
in: query
|
|
description: Limit result set to resources assigned to a specific product.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Limit result set to resources assigned to a specific product.
|
|
- name: slug
|
|
in: query
|
|
description: Limit result set to resources with a specific slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to resources with a specific slug.
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_tag
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name for the resource.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
/products/tags/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_tag
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_tag
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_tag
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_tag"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/products:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
- name: modified_after
|
|
in: query
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
- name: modified_before
|
|
in: query
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
- name: dates_are_gmt
|
|
in: query
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- id
|
|
- include
|
|
- title
|
|
- slug
|
|
- modified
|
|
- menu_order
|
|
- price
|
|
- popularity
|
|
- rating
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to those of particular parent IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to those of particular parent IDs.
|
|
- name: parent_exclude
|
|
in: query
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
- name: slug
|
|
in: query
|
|
description: Limit result set to products with a specific slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with a specific slug.
|
|
- name: status
|
|
in: query
|
|
description: Limit result set to products assigned a specific status.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products assigned a specific status.
|
|
enum:
|
|
- any
|
|
- future
|
|
- trash
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- name: type
|
|
in: query
|
|
description: Limit result set to products assigned a specific type.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products assigned a specific type.
|
|
enum:
|
|
- simple
|
|
- grouped
|
|
- external
|
|
- variable
|
|
- name: sku
|
|
in: query
|
|
description: Limit result set to products with specific SKU(s). Use commas to separate.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with specific SKU(s). Use commas to separate.
|
|
- name: featured
|
|
in: query
|
|
description: Limit result set to featured products.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Limit result set to featured products.
|
|
- name: category
|
|
in: query
|
|
description: Limit result set to products assigned a specific category ID.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products assigned a specific category ID.
|
|
- name: tag
|
|
in: query
|
|
description: Limit result set to products assigned a specific tag ID.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products assigned a specific tag ID.
|
|
- name: shipping_class
|
|
in: query
|
|
description: Limit result set to products assigned a specific shipping class ID.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products assigned a specific shipping class ID.
|
|
- name: attribute
|
|
in: query
|
|
description: Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.
|
|
- name: attribute_term
|
|
in: query
|
|
description: Limit result set to products with a specific attribute term ID (required an assigned attribute).
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with a specific attribute term ID (required an assigned attribute).
|
|
- name: on_sale
|
|
in: query
|
|
description: Limit result set to products on sale.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Limit result set to products on sale.
|
|
- name: min_price
|
|
in: query
|
|
description: Limit result set to products based on a minimum price.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products based on a minimum price.
|
|
- name: max_price
|
|
in: query
|
|
description: Limit result set to products based on a maximum price.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products based on a maximum price.
|
|
- name: stock_status
|
|
in: query
|
|
description: Limit result set to products with specified stock status.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with specified stock status.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
slug:
|
|
type: string
|
|
description: Product slug.
|
|
date_created:
|
|
type: string
|
|
description: The date the product was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the product was created, as GMT.
|
|
type:
|
|
type: string
|
|
description: Product type.
|
|
enum:
|
|
- simple
|
|
- grouped
|
|
- external
|
|
- variable
|
|
status:
|
|
type: string
|
|
description: Product status (post status).
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- future
|
|
featured:
|
|
type: boolean
|
|
description: Featured product.
|
|
catalog_visibility:
|
|
type: string
|
|
description: Catalog visibility.
|
|
enum:
|
|
- visible
|
|
- catalog
|
|
- search
|
|
- hidden
|
|
description:
|
|
type: string
|
|
description: Product description.
|
|
short_description:
|
|
type: string
|
|
description: Product short description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Product regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Product sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
virtual:
|
|
type: boolean
|
|
description: If the product is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the product is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
external_url:
|
|
type: string
|
|
format: uri
|
|
description: Product external URL. Only for external products.
|
|
button_text:
|
|
type: string
|
|
description: Product external button text. Only for external products.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at product level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the product.
|
|
sold_individually:
|
|
type: boolean
|
|
description: Allow one item to be bought in a single order.
|
|
weight:
|
|
type: string
|
|
description: Product weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Product length (cm).
|
|
width:
|
|
type: string
|
|
description: Product width (cm).
|
|
height:
|
|
type: string
|
|
description: Product height (cm).
|
|
description: Product dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
reviews_allowed:
|
|
type: boolean
|
|
description: Allow reviews.
|
|
upsell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of up-sell products IDs.
|
|
cross_sell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of cross-sell products IDs.
|
|
parent_id:
|
|
type: integer
|
|
description: Product parent ID.
|
|
purchase_note:
|
|
type: string
|
|
description: Optional note to send the customer after purchase.
|
|
categories:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Category ID.
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: Category slug.
|
|
description: List of categories.
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tag ID.
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: Tag slug.
|
|
description: List of tags.
|
|
images:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: List of images.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
position:
|
|
type: integer
|
|
description: Attribute position.
|
|
visible:
|
|
type: boolean
|
|
description: Define if the attribute is visible on the "Additional information" tab in the product's page.
|
|
variation:
|
|
type: boolean
|
|
description: Define if the attribute can be used as variation.
|
|
options:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of available term names of the attribute.
|
|
description: List of attributes.
|
|
default_attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: Defaults variation attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
/products/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
slug:
|
|
type: string
|
|
description: Product slug.
|
|
date_created:
|
|
type: string
|
|
description: The date the product was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the product was created, as GMT.
|
|
type:
|
|
type: string
|
|
description: Product type.
|
|
enum:
|
|
- simple
|
|
- grouped
|
|
- external
|
|
- variable
|
|
status:
|
|
type: string
|
|
description: Product status (post status).
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- future
|
|
featured:
|
|
type: boolean
|
|
description: Featured product.
|
|
catalog_visibility:
|
|
type: string
|
|
description: Catalog visibility.
|
|
enum:
|
|
- visible
|
|
- catalog
|
|
- search
|
|
- hidden
|
|
description:
|
|
type: string
|
|
description: Product description.
|
|
short_description:
|
|
type: string
|
|
description: Product short description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Product regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Product sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
virtual:
|
|
type: boolean
|
|
description: If the product is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the product is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
external_url:
|
|
type: string
|
|
format: uri
|
|
description: Product external URL. Only for external products.
|
|
button_text:
|
|
type: string
|
|
description: Product external button text. Only for external products.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at product level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the product.
|
|
sold_individually:
|
|
type: boolean
|
|
description: Allow one item to be bought in a single order.
|
|
weight:
|
|
type: string
|
|
description: Product weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Product length (cm).
|
|
width:
|
|
type: string
|
|
description: Product width (cm).
|
|
height:
|
|
type: string
|
|
description: Product height (cm).
|
|
description: Product dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
reviews_allowed:
|
|
type: boolean
|
|
description: Allow reviews.
|
|
upsell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of up-sell products IDs.
|
|
cross_sell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of cross-sell products IDs.
|
|
parent_id:
|
|
type: integer
|
|
description: Product parent ID.
|
|
purchase_note:
|
|
type: string
|
|
description: Optional note to send the customer after purchase.
|
|
categories:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Category ID.
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: Category slug.
|
|
description: List of categories.
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tag ID.
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: Tag slug.
|
|
description: List of tags.
|
|
images:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: List of images.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
position:
|
|
type: integer
|
|
description: Attribute position.
|
|
visible:
|
|
type: boolean
|
|
description: Define if the attribute is visible on the "Additional information" tab in the product's page.
|
|
variation:
|
|
type: boolean
|
|
description: Define if the attribute can be used as variation.
|
|
options:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of available term names of the attribute.
|
|
description: List of attributes.
|
|
default_attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: Defaults variation attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
slug:
|
|
type: string
|
|
description: Product slug.
|
|
date_created:
|
|
type: string
|
|
description: The date the product was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the product was created, as GMT.
|
|
type:
|
|
type: string
|
|
description: Product type.
|
|
enum:
|
|
- simple
|
|
- grouped
|
|
- external
|
|
- variable
|
|
status:
|
|
type: string
|
|
description: Product status (post status).
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- future
|
|
featured:
|
|
type: boolean
|
|
description: Featured product.
|
|
catalog_visibility:
|
|
type: string
|
|
description: Catalog visibility.
|
|
enum:
|
|
- visible
|
|
- catalog
|
|
- search
|
|
- hidden
|
|
description:
|
|
type: string
|
|
description: Product description.
|
|
short_description:
|
|
type: string
|
|
description: Product short description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Product regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Product sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
virtual:
|
|
type: boolean
|
|
description: If the product is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the product is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
external_url:
|
|
type: string
|
|
format: uri
|
|
description: Product external URL. Only for external products.
|
|
button_text:
|
|
type: string
|
|
description: Product external button text. Only for external products.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at product level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the product.
|
|
sold_individually:
|
|
type: boolean
|
|
description: Allow one item to be bought in a single order.
|
|
weight:
|
|
type: string
|
|
description: Product weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Product length (cm).
|
|
width:
|
|
type: string
|
|
description: Product width (cm).
|
|
height:
|
|
type: string
|
|
description: Product height (cm).
|
|
description: Product dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
reviews_allowed:
|
|
type: boolean
|
|
description: Allow reviews.
|
|
upsell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of up-sell products IDs.
|
|
cross_sell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of cross-sell products IDs.
|
|
parent_id:
|
|
type: integer
|
|
description: Product parent ID.
|
|
purchase_note:
|
|
type: string
|
|
description: Optional note to send the customer after purchase.
|
|
categories:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Category ID.
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: Category slug.
|
|
description: List of categories.
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tag ID.
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: Tag slug.
|
|
description: List of tags.
|
|
images:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: List of images.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
position:
|
|
type: integer
|
|
description: Attribute position.
|
|
visible:
|
|
type: boolean
|
|
description: Define if the attribute is visible on the "Additional information" tab in the product's page.
|
|
variation:
|
|
type: boolean
|
|
description: Define if the attribute can be used as variation.
|
|
options:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of available term names of the attribute.
|
|
description: List of attributes.
|
|
default_attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: Defaults variation attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
slug:
|
|
type: string
|
|
description: Product slug.
|
|
date_created:
|
|
type: string
|
|
description: The date the product was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the product was created, as GMT.
|
|
type:
|
|
type: string
|
|
description: Product type.
|
|
enum:
|
|
- simple
|
|
- grouped
|
|
- external
|
|
- variable
|
|
status:
|
|
type: string
|
|
description: Product status (post status).
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- future
|
|
featured:
|
|
type: boolean
|
|
description: Featured product.
|
|
catalog_visibility:
|
|
type: string
|
|
description: Catalog visibility.
|
|
enum:
|
|
- visible
|
|
- catalog
|
|
- search
|
|
- hidden
|
|
description:
|
|
type: string
|
|
description: Product description.
|
|
short_description:
|
|
type: string
|
|
description: Product short description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Product regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Product sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
virtual:
|
|
type: boolean
|
|
description: If the product is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the product is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
external_url:
|
|
type: string
|
|
format: uri
|
|
description: Product external URL. Only for external products.
|
|
button_text:
|
|
type: string
|
|
description: Product external button text. Only for external products.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at product level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the product.
|
|
sold_individually:
|
|
type: boolean
|
|
description: Allow one item to be bought in a single order.
|
|
weight:
|
|
type: string
|
|
description: Product weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Product length (cm).
|
|
width:
|
|
type: string
|
|
description: Product width (cm).
|
|
height:
|
|
type: string
|
|
description: Product height (cm).
|
|
description: Product dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
reviews_allowed:
|
|
type: boolean
|
|
description: Allow reviews.
|
|
upsell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of up-sell products IDs.
|
|
cross_sell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of cross-sell products IDs.
|
|
parent_id:
|
|
type: integer
|
|
description: Product parent ID.
|
|
purchase_note:
|
|
type: string
|
|
description: Optional note to send the customer after purchase.
|
|
categories:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Category ID.
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: Category slug.
|
|
description: List of categories.
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tag ID.
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: Tag slug.
|
|
description: List of tags.
|
|
images:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: List of images.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
position:
|
|
type: integer
|
|
description: Attribute position.
|
|
visible:
|
|
type: boolean
|
|
description: Define if the attribute is visible on the "Additional information" tab in the product's page.
|
|
variation:
|
|
type: boolean
|
|
description: Define if the attribute can be used as variation.
|
|
options:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of available term names of the attribute.
|
|
description: List of attributes.
|
|
default_attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: Defaults variation attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/products/{product_id}/variations:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
- name: modified_after
|
|
in: query
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified after a given ISO8601 compliant date.
|
|
- name: modified_before
|
|
in: query
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources modified before a given ISO8601 compliant date.
|
|
- name: dates_are_gmt
|
|
in: query
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to consider GMT post dates when limiting response by published or modified date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- id
|
|
- include
|
|
- title
|
|
- slug
|
|
- modified
|
|
- menu_order
|
|
- name: parent
|
|
in: query
|
|
description: Limit result set to those of particular parent IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to those of particular parent IDs.
|
|
- name: parent_exclude
|
|
in: query
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to all items except those of a particular parent ID.
|
|
- name: slug
|
|
in: query
|
|
description: Limit result set to products with a specific slug.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with a specific slug.
|
|
- name: status
|
|
in: query
|
|
description: Limit result set to products assigned a specific status.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products assigned a specific status.
|
|
enum:
|
|
- any
|
|
- future
|
|
- trash
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- name: sku
|
|
in: query
|
|
description: Limit result set to products with specific SKU(s). Use commas to separate.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with specific SKU(s). Use commas to separate.
|
|
- name: on_sale
|
|
in: query
|
|
description: Limit result set to products on sale.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Limit result set to products on sale.
|
|
- name: min_price
|
|
in: query
|
|
description: Limit result set to products based on a minimum price.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products based on a minimum price.
|
|
- name: max_price
|
|
in: query
|
|
description: Limit result set to products based on a maximum price.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products based on a maximum price.
|
|
- name: stock_status
|
|
in: query
|
|
description: Limit result set to products with specified stock status.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to products with specified stock status.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_variation
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: Variation description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Variation regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Variation sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
status:
|
|
type: string
|
|
description: Variation status.
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
virtual:
|
|
type: boolean
|
|
description: If the variation is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the variation is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at variation level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the variation.
|
|
weight:
|
|
type: string
|
|
description: Variation weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Variation length (cm).
|
|
width:
|
|
type: string
|
|
description: Variation width (cm).
|
|
height:
|
|
type: string
|
|
description: Variation height (cm).
|
|
description: Variation dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Variation image data.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: List of attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
/products/{product_id}/variations/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the variation.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variation.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_variation
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: Variation description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Variation regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Variation sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
status:
|
|
type: string
|
|
description: Variation status.
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
virtual:
|
|
type: boolean
|
|
description: If the variation is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the variation is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at variation level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the variation.
|
|
weight:
|
|
type: string
|
|
description: Variation weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Variation length (cm).
|
|
width:
|
|
type: string
|
|
description: Variation width (cm).
|
|
height:
|
|
type: string
|
|
description: Variation height (cm).
|
|
description: Variation dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Variation image data.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: List of attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the variation.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variation.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_variation
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: Variation description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Variation regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Variation sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
status:
|
|
type: string
|
|
description: Variation status.
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
virtual:
|
|
type: boolean
|
|
description: If the variation is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the variation is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at variation level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the variation.
|
|
weight:
|
|
type: string
|
|
description: Variation weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Variation length (cm).
|
|
width:
|
|
type: string
|
|
description: Variation width (cm).
|
|
height:
|
|
type: string
|
|
description: Variation height (cm).
|
|
description: Variation dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Variation image data.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: List of attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the variation.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variation.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: product_variation
|
|
properties:
|
|
description:
|
|
type: string
|
|
description: Variation description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
regular_price:
|
|
type: string
|
|
description: Variation regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Variation sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
status:
|
|
type: string
|
|
description: Variation status.
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
virtual:
|
|
type: boolean
|
|
description: If the variation is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the variation is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at variation level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the variation.
|
|
weight:
|
|
type: string
|
|
description: Variation weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Variation length (cm).
|
|
width:
|
|
type: string
|
|
description: Variation width (cm).
|
|
height:
|
|
type: string
|
|
description: Variation height (cm).
|
|
description: Variation dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Variation image data.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: List of attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the variation.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variation.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/product_variation"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: product_id
|
|
in: path
|
|
description: Unique identifier for the variable product.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variable product.
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the variation.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the variation.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/reports/sales:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/sales_report"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- name: period
|
|
in: query
|
|
description: Report period.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Report period.
|
|
enum:
|
|
- week
|
|
- month
|
|
- last_month
|
|
- year
|
|
- name: date_min
|
|
in: query
|
|
description: Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: date
|
|
description: Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
|
|
- name: date_max
|
|
in: query
|
|
description: Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: date
|
|
description: Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.
|
|
/reports/top_sellers:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/top_sellers_report"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- name: period
|
|
in: query
|
|
description: Report period.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Report period.
|
|
enum:
|
|
- week
|
|
- month
|
|
- last_month
|
|
- year
|
|
- name: date_min
|
|
in: query
|
|
description: Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: date
|
|
description: Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
|
|
- name: date_max
|
|
in: query
|
|
description: Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: date
|
|
description: Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.
|
|
/reports/orders/totals:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/report_order_total"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/reports/products/totals:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/report_product_total"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/reports/customers/totals:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/report_customer_total"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/reports/coupons/totals:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/report_coupon_total"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/reports/reviews/totals:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/report_review_total"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/reports:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/report"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/shipping/zones:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters: []
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping zone name.
|
|
order:
|
|
type: integer
|
|
description: Shipping zone order.
|
|
/shipping/zones/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping zone name.
|
|
order:
|
|
type: integer
|
|
description: Shipping zone order.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping zone name.
|
|
order:
|
|
type: integer
|
|
description: Shipping zone order.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Shipping zone name.
|
|
order:
|
|
type: integer
|
|
description: Shipping zone order.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/shipping/zones/{id}/locations:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shipping_zone_location"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_location"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_location
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Shipping zone location code.
|
|
type:
|
|
type: string
|
|
description: Shipping zone location type.
|
|
enum:
|
|
- postcode
|
|
- state
|
|
- country
|
|
- continent
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_location"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_location
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Shipping zone location code.
|
|
type:
|
|
type: string
|
|
description: Shipping zone location type.
|
|
enum:
|
|
- postcode
|
|
- state
|
|
- country
|
|
- continent
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_location"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_location
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Shipping zone location code.
|
|
type:
|
|
type: string
|
|
description: Shipping zone location type.
|
|
enum:
|
|
- postcode
|
|
- state
|
|
- country
|
|
- continent
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique ID for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the resource.
|
|
/shipping/zones/{zone_id}/methods:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_method
|
|
properties:
|
|
order:
|
|
type: integer
|
|
description: Shipping method sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Shipping method enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
- class
|
|
- order
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Shipping method settings.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
/shipping/zones/{zone_id}/methods/{instance_id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
- name: instance_id
|
|
in: path
|
|
description: Unique ID for the instance.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the instance.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_method
|
|
properties:
|
|
order:
|
|
type: integer
|
|
description: Shipping method sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Shipping method enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
- class
|
|
- order
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Shipping method settings.
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
- name: instance_id
|
|
in: path
|
|
description: Unique ID for the instance.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the instance.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_method
|
|
properties:
|
|
order:
|
|
type: integer
|
|
description: Shipping method sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Shipping method enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
- class
|
|
- order
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Shipping method settings.
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
- name: instance_id
|
|
in: path
|
|
description: Unique ID for the instance.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the instance.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: shipping_zone_method
|
|
properties:
|
|
order:
|
|
type: integer
|
|
description: Shipping method sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Shipping method enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
- class
|
|
- order
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Shipping method settings.
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
- name: instance_id
|
|
in: path
|
|
description: Unique ID for the instance.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the instance.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_zone_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: zone_id
|
|
in: path
|
|
description: Unique ID for the zone.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the zone.
|
|
- name: instance_id
|
|
in: path
|
|
description: Unique ID for the instance.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique ID for the instance.
|
|
- name: force
|
|
in: query
|
|
description: Whether to bypass trash and force deletion.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Whether to bypass trash and force deletion.
|
|
/taxes/classes:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/tax_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: tax_class
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tax class name.
|
|
/taxes/classes/{slug}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: slug
|
|
in: path
|
|
description: Unique slug for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique slug for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax_class"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: slug
|
|
in: path
|
|
description: Unique slug for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique slug for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/taxes:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- id
|
|
- order
|
|
- priority
|
|
- name: class
|
|
in: query
|
|
description: Sort by tax class.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort by tax class.
|
|
enum:
|
|
- standard
|
|
- reduced-rate
|
|
- zero-rate
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: tax
|
|
properties:
|
|
country:
|
|
type: string
|
|
description: Country ISO 3166 code.
|
|
state:
|
|
type: string
|
|
description: State code.
|
|
postcode:
|
|
type: string
|
|
description: Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.
|
|
city:
|
|
type: string
|
|
description: City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.
|
|
rate:
|
|
type: string
|
|
description: Tax rate.
|
|
name:
|
|
type: string
|
|
description: Tax rate name.
|
|
priority:
|
|
type: integer
|
|
description: Tax priority.
|
|
compound:
|
|
type: boolean
|
|
description: Whether or not this is a compound rate.
|
|
shipping:
|
|
type: boolean
|
|
description: Whether or not this tax rate also gets applied to shipping.
|
|
order:
|
|
type: integer
|
|
description: Indicates the order that will appear in queries.
|
|
class:
|
|
type: string
|
|
description: Tax class.
|
|
enum:
|
|
- standard
|
|
- reduced-rate
|
|
- zero-rate
|
|
postcodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of postcodes / ZIPs. Introduced in WooCommerce 5.3.
|
|
cities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of city names. Introduced in WooCommerce 5.3.
|
|
/taxes/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: tax
|
|
properties:
|
|
country:
|
|
type: string
|
|
description: Country ISO 3166 code.
|
|
state:
|
|
type: string
|
|
description: State code.
|
|
postcode:
|
|
type: string
|
|
description: Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.
|
|
city:
|
|
type: string
|
|
description: City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.
|
|
rate:
|
|
type: string
|
|
description: Tax rate.
|
|
name:
|
|
type: string
|
|
description: Tax rate name.
|
|
priority:
|
|
type: integer
|
|
description: Tax priority.
|
|
compound:
|
|
type: boolean
|
|
description: Whether or not this is a compound rate.
|
|
shipping:
|
|
type: boolean
|
|
description: Whether or not this tax rate also gets applied to shipping.
|
|
order:
|
|
type: integer
|
|
description: Indicates the order that will appear in queries.
|
|
class:
|
|
type: string
|
|
description: Tax class.
|
|
enum:
|
|
- standard
|
|
- reduced-rate
|
|
- zero-rate
|
|
postcodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of postcodes / ZIPs. Introduced in WooCommerce 5.3.
|
|
cities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of city names. Introduced in WooCommerce 5.3.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: tax
|
|
properties:
|
|
country:
|
|
type: string
|
|
description: Country ISO 3166 code.
|
|
state:
|
|
type: string
|
|
description: State code.
|
|
postcode:
|
|
type: string
|
|
description: Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.
|
|
city:
|
|
type: string
|
|
description: City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.
|
|
rate:
|
|
type: string
|
|
description: Tax rate.
|
|
name:
|
|
type: string
|
|
description: Tax rate name.
|
|
priority:
|
|
type: integer
|
|
description: Tax priority.
|
|
compound:
|
|
type: boolean
|
|
description: Whether or not this is a compound rate.
|
|
shipping:
|
|
type: boolean
|
|
description: Whether or not this tax rate also gets applied to shipping.
|
|
order:
|
|
type: integer
|
|
description: Indicates the order that will appear in queries.
|
|
class:
|
|
type: string
|
|
description: Tax class.
|
|
enum:
|
|
- standard
|
|
- reduced-rate
|
|
- zero-rate
|
|
postcodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of postcodes / ZIPs. Introduced in WooCommerce 5.3.
|
|
cities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of city names. Introduced in WooCommerce 5.3.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: tax
|
|
properties:
|
|
country:
|
|
type: string
|
|
description: Country ISO 3166 code.
|
|
state:
|
|
type: string
|
|
description: State code.
|
|
postcode:
|
|
type: string
|
|
description: Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.
|
|
city:
|
|
type: string
|
|
description: City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.
|
|
rate:
|
|
type: string
|
|
description: Tax rate.
|
|
name:
|
|
type: string
|
|
description: Tax rate name.
|
|
priority:
|
|
type: integer
|
|
description: Tax priority.
|
|
compound:
|
|
type: boolean
|
|
description: Whether or not this is a compound rate.
|
|
shipping:
|
|
type: boolean
|
|
description: Whether or not this tax rate also gets applied to shipping.
|
|
order:
|
|
type: integer
|
|
description: Indicates the order that will appear in queries.
|
|
class:
|
|
type: string
|
|
description: Tax class.
|
|
enum:
|
|
- standard
|
|
- reduced-rate
|
|
- zero-rate
|
|
postcodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of postcodes / ZIPs. Introduced in WooCommerce 5.3.
|
|
cities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of city names. Introduced in WooCommerce 5.3.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/tax"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/webhooks:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
- name: page
|
|
in: query
|
|
description: Current page of the collection.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Current page of the collection.
|
|
- name: per_page
|
|
in: query
|
|
description: Maximum number of items to be returned in result set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Maximum number of items to be returned in result set.
|
|
- name: search
|
|
in: query
|
|
description: Limit results to those matching a string.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit results to those matching a string.
|
|
- name: after
|
|
in: query
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published after a given ISO8601 compliant date.
|
|
- name: before
|
|
in: query
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
format: string
|
|
description: Limit response to resources published before a given ISO8601 compliant date.
|
|
- name: exclude
|
|
in: query
|
|
description: Ensure result set excludes specific IDs.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Ensure result set excludes specific IDs.
|
|
- name: include
|
|
in: query
|
|
description: Limit result set to specific ids.
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Limit result set to specific ids.
|
|
- name: offset
|
|
in: query
|
|
description: Offset the result set by a specific number of items.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
description: Offset the result set by a specific number of items.
|
|
- name: order
|
|
in: query
|
|
description: Order sort attribute ascending or descending.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Order sort attribute ascending or descending.
|
|
enum:
|
|
- asc
|
|
- desc
|
|
- name: orderby
|
|
in: query
|
|
description: Sort collection by object attribute.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Sort collection by object attribute.
|
|
enum:
|
|
- date
|
|
- id
|
|
- title
|
|
- name: status
|
|
in: query
|
|
description: Limit result set to webhooks assigned a specific status.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Limit result set to webhooks assigned a specific status.
|
|
enum:
|
|
- all
|
|
- active
|
|
- paused
|
|
- disabled
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: webhook
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: A friendly name for the webhook.
|
|
status:
|
|
type: string
|
|
description: Webhook status.
|
|
enum:
|
|
- active
|
|
- paused
|
|
- disabled
|
|
topic:
|
|
type: string
|
|
description: Webhook topic.
|
|
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.
|
|
delivery_url:
|
|
type: string
|
|
description: Webhook delivery URL.
|
|
/webhooks/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: webhook
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: A friendly name for the webhook.
|
|
status:
|
|
type: string
|
|
description: Webhook status.
|
|
enum:
|
|
- active
|
|
- paused
|
|
- disabled
|
|
topic:
|
|
type: string
|
|
description: Webhook topic.
|
|
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.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: webhook
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: A friendly name for the webhook.
|
|
status:
|
|
type: string
|
|
description: Webhook status.
|
|
enum:
|
|
- active
|
|
- paused
|
|
- disabled
|
|
topic:
|
|
type: string
|
|
description: Webhook topic.
|
|
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.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: webhook
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: A friendly name for the webhook.
|
|
status:
|
|
type: string
|
|
description: Webhook status.
|
|
enum:
|
|
- active
|
|
- paused
|
|
- disabled
|
|
topic:
|
|
type: string
|
|
description: Webhook topic.
|
|
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.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
delete:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/webhook"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
- name: force
|
|
in: query
|
|
description: Required to be true, as resource does not support trashing.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
description: Required to be true, as resource does not support trashing.
|
|
/system_status:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/system_status"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/system_status/tools:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/system_status_tool"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
/system_status/tools/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/system_status_tool"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/system_status_tool"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: system_status_tool
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tool name.
|
|
action:
|
|
type: string
|
|
description: What running the tool will do.
|
|
description:
|
|
type: string
|
|
description: Tool description.
|
|
success:
|
|
type: boolean
|
|
description: Did the tool run successfully?
|
|
message:
|
|
type: string
|
|
description: Tool return message.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: A unique identifier for the tool.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: A unique identifier for the tool.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/system_status_tool"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: system_status_tool
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tool name.
|
|
action:
|
|
type: string
|
|
description: What running the tool will do.
|
|
description:
|
|
type: string
|
|
description: Tool description.
|
|
success:
|
|
type: boolean
|
|
description: Did the tool run successfully?
|
|
message:
|
|
type: string
|
|
description: Tool return message.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: A unique identifier for the tool.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: A unique identifier for the tool.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/system_status_tool"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: system_status_tool
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Tool name.
|
|
action:
|
|
type: string
|
|
description: What running the tool will do.
|
|
description:
|
|
type: string
|
|
description: Tool description.
|
|
success:
|
|
type: boolean
|
|
description: Did the tool run successfully?
|
|
message:
|
|
type: string
|
|
description: Tool return message.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: A unique identifier for the tool.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: A unique identifier for the tool.
|
|
/shipping_methods:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/shipping_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/shipping_methods/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/shipping_method"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
/payment_gateways:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/payment_gateway"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
/payment_gateways/{id}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/payment_gateway"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
- name: context
|
|
in: query
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
description: Scope under which the request is made; determines fields present in response.
|
|
enum:
|
|
- view
|
|
- edit
|
|
post:
|
|
security:
|
|
- basicAuth: []
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/payment_gateway"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: payment_gateway
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Payment gateway title on checkout.
|
|
description:
|
|
type: string
|
|
description: Payment gateway description on checkout.
|
|
order:
|
|
type: integer
|
|
description: Payment gateway sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Payment gateway enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Payment gateway settings.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
put:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/payment_gateway"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: payment_gateway
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Payment gateway title on checkout.
|
|
description:
|
|
type: string
|
|
description: Payment gateway description on checkout.
|
|
order:
|
|
type: integer
|
|
description: Payment gateway sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Payment gateway enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Payment gateway settings.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
patch:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/payment_gateway"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
title: payment_gateway
|
|
properties:
|
|
title:
|
|
type: string
|
|
description: Payment gateway title on checkout.
|
|
description:
|
|
type: string
|
|
description: Payment gateway description on checkout.
|
|
order:
|
|
type: integer
|
|
description: Payment gateway sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Payment gateway enabled status.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Payment gateway settings.
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Unique identifier for the resource.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
/data:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/data_index"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters: []
|
|
/data/continents:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/data_continents"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters: []
|
|
/data/continents/{location}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/data_continents"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: location
|
|
in: path
|
|
description: 2 character continent code.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: 2 character continent code.
|
|
/data/countries:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/data_countries"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters: []
|
|
/data/countries/{location}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/data_countries"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: location
|
|
in: path
|
|
description: ISO3166 alpha-2 country code.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: ISO3166 alpha-2 country code.
|
|
/data/currencies:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/data_currencies"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters: []
|
|
/data/currencies/current:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/data_currencies"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters: []
|
|
/data/currencies/{currency}:
|
|
get:
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/data_currencies"
|
|
"400":
|
|
description: Bad Request
|
|
"404":
|
|
description: Not Found
|
|
parameters:
|
|
- name: currency
|
|
in: path
|
|
description: ISO4217 currency code.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: ISO4217 currency code.
|
|
components:
|
|
securitySchemes:
|
|
basicAuth:
|
|
type: http
|
|
scheme: basic
|
|
description: Wordpress username and password. Tip, use generated application password
|
|
schemas:
|
|
shop_coupon:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the object.
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
amount:
|
|
type: string
|
|
description: The amount of discount. Should always be numeric, even if setting a percentage.
|
|
date_created:
|
|
type: string
|
|
description: The date the coupon was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the coupon was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the coupon was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the coupon was last modified, as GMT.
|
|
discount_type:
|
|
type: string
|
|
description: Determines the type of discount that will be applied.
|
|
enum:
|
|
- percent
|
|
- fixed_cart
|
|
- fixed_product
|
|
description:
|
|
type: string
|
|
description: Coupon description.
|
|
date_expires:
|
|
type: string
|
|
description: The date the coupon expires, in the site's timezone.
|
|
date_expires_gmt:
|
|
type: string
|
|
description: The date the coupon expires, as GMT.
|
|
usage_count:
|
|
type: integer
|
|
description: Number of times the coupon has been used already.
|
|
individual_use:
|
|
type: boolean
|
|
description: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
|
|
product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon can be used on.
|
|
excluded_product_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of product IDs the coupon cannot be used on.
|
|
usage_limit:
|
|
type: integer
|
|
description: How many times the coupon can be used in total.
|
|
usage_limit_per_user:
|
|
type: integer
|
|
description: How many times the coupon can be used per customer.
|
|
limit_usage_to_x_items:
|
|
type: integer
|
|
description: Max number of items in the cart the coupon can be applied to.
|
|
free_shipping:
|
|
type: boolean
|
|
description: If true and if the free shipping method requires a coupon, this coupon will enable free shipping.
|
|
product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon applies to.
|
|
excluded_product_categories:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of category IDs the coupon does not apply to.
|
|
exclude_sale_items:
|
|
type: boolean
|
|
description: If true, this coupon will not be applied to items that have sale prices.
|
|
minimum_amount:
|
|
type: string
|
|
description: Minimum order amount that needs to be in the cart before coupon applies.
|
|
maximum_amount:
|
|
type: string
|
|
description: Maximum order amount allowed when using the coupon.
|
|
email_restrictions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of email addresses that can use this coupon.
|
|
used_by:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of user IDs (or guest email addresses) that have used the coupon.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
customer_download:
|
|
type: object
|
|
properties:
|
|
download_id:
|
|
type: string
|
|
description: Download ID.
|
|
download_url:
|
|
type: string
|
|
description: Download file URL.
|
|
product_id:
|
|
type: integer
|
|
description: Downloadable product ID.
|
|
product_name:
|
|
type: string
|
|
description: Product name.
|
|
download_name:
|
|
type: string
|
|
description: Downloadable file name.
|
|
order_id:
|
|
type: integer
|
|
description: Order ID.
|
|
order_key:
|
|
type: string
|
|
description: Order key.
|
|
downloads_remaining:
|
|
type: string
|
|
description: Number of downloads remaining.
|
|
access_expires:
|
|
type: string
|
|
description: The date when download access expires, in the site's timezone.
|
|
access_expires_gmt:
|
|
type: string
|
|
description: The date when download access expires, as GMT.
|
|
file:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: File details.
|
|
customer:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
date_created:
|
|
type: string
|
|
description: The date the customer was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the customer was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the customer was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the customer was last modified, as GMT.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: The email address for the customer.
|
|
first_name:
|
|
type: string
|
|
description: Customer first name.
|
|
last_name:
|
|
type: string
|
|
description: Customer last name.
|
|
role:
|
|
type: string
|
|
description: Customer role.
|
|
username:
|
|
type: string
|
|
description: Customer login name.
|
|
password:
|
|
type: string
|
|
description: Customer password.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of billing address data.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: ISO code of the country.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: List of shipping address data.
|
|
is_paying_customer:
|
|
type: boolean
|
|
description: Is the customer a paying customer?
|
|
avatar_url:
|
|
type: string
|
|
description: Avatar URL.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
order_note:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
author:
|
|
type: string
|
|
description: Order note author.
|
|
date_created:
|
|
type: string
|
|
description: The date the order note was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the order note was created, as GMT.
|
|
note:
|
|
type: string
|
|
description: Order note content.
|
|
customer_note:
|
|
type: boolean
|
|
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.
|
|
added_by_user:
|
|
type: boolean
|
|
description: If true, this note will be attributed to the current user. If false, the note will be attributed to the system.
|
|
shop_order_refund:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
date_created:
|
|
type: string
|
|
description: The date the order refund was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the order refund was created, as GMT.
|
|
amount:
|
|
type: string
|
|
description: Refund amount.
|
|
reason:
|
|
type: string
|
|
description: Reason for refund.
|
|
refunded_by:
|
|
type: integer
|
|
description: User ID of user who created the refund.
|
|
refunded_payment:
|
|
type: boolean
|
|
description: If the payment was refunded via the API.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
line_items:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
product_id:
|
|
type: string
|
|
description: Product ID.
|
|
variation_id:
|
|
type: integer
|
|
description: Variation ID, if applicable.
|
|
quantity:
|
|
type: integer
|
|
description: Quantity ordered.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of product.
|
|
subtotal:
|
|
type: string
|
|
description: Line subtotal (before discounts).
|
|
subtotal_tax:
|
|
type: string
|
|
description: Line subtotal tax (before discounts).
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
refund_total:
|
|
type: number
|
|
description: Amount that will be refunded for this tax.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
sku:
|
|
type: string
|
|
description: Product SKU.
|
|
price:
|
|
type: number
|
|
description: Product price.
|
|
refund_total:
|
|
type: number
|
|
description: Amount that will be refunded for this line item (excluding taxes).
|
|
description: Line items data.
|
|
api_refund:
|
|
type: boolean
|
|
description: When true, the payment gateway API is used to generate the refund.
|
|
api_restock:
|
|
type: boolean
|
|
description: When true, refunded items are restocked.
|
|
shop_order:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
parent_id:
|
|
type: integer
|
|
description: Parent order ID.
|
|
number:
|
|
type: string
|
|
description: Order number.
|
|
order_key:
|
|
type: string
|
|
description: Order key.
|
|
created_via:
|
|
type: string
|
|
description: Shows where the order was created.
|
|
version:
|
|
type: integer
|
|
description: Version of WooCommerce which last updated the order.
|
|
status:
|
|
type: string
|
|
description: Order status.
|
|
enum:
|
|
- pending
|
|
- processing
|
|
- on-hold
|
|
- completed
|
|
- cancelled
|
|
- refunded
|
|
- failed
|
|
currency:
|
|
type: string
|
|
description: Currency the order was created with, in ISO format.
|
|
enum:
|
|
- AED
|
|
- AFN
|
|
- ALL
|
|
- AMD
|
|
- ANG
|
|
- AOA
|
|
- ARS
|
|
- AUD
|
|
- AWG
|
|
- AZN
|
|
- BAM
|
|
- BBD
|
|
- BDT
|
|
- BGN
|
|
- BHD
|
|
- BIF
|
|
- BMD
|
|
- BND
|
|
- BOB
|
|
- BRL
|
|
- BSD
|
|
- BTC
|
|
- BTN
|
|
- BWP
|
|
- BYR
|
|
- BYN
|
|
- BZD
|
|
- CAD
|
|
- CDF
|
|
- CHF
|
|
- CLP
|
|
- CNY
|
|
- COP
|
|
- CRC
|
|
- CUC
|
|
- CUP
|
|
- CVE
|
|
- CZK
|
|
- DJF
|
|
- DKK
|
|
- DOP
|
|
- DZD
|
|
- EGP
|
|
- ERN
|
|
- ETB
|
|
- EUR
|
|
- FJD
|
|
- FKP
|
|
- GBP
|
|
- GEL
|
|
- GGP
|
|
- GHS
|
|
- GIP
|
|
- GMD
|
|
- GNF
|
|
- GTQ
|
|
- GYD
|
|
- HKD
|
|
- HNL
|
|
- HRK
|
|
- HTG
|
|
- HUF
|
|
- IDR
|
|
- ILS
|
|
- IMP
|
|
- INR
|
|
- IQD
|
|
- IRR
|
|
- IRT
|
|
- ISK
|
|
- JEP
|
|
- JMD
|
|
- JOD
|
|
- JPY
|
|
- KES
|
|
- KGS
|
|
- KHR
|
|
- KMF
|
|
- KPW
|
|
- KRW
|
|
- KWD
|
|
- KYD
|
|
- KZT
|
|
- LAK
|
|
- LBP
|
|
- LKR
|
|
- LRD
|
|
- LSL
|
|
- LYD
|
|
- MAD
|
|
- MDL
|
|
- MGA
|
|
- MKD
|
|
- MMK
|
|
- MNT
|
|
- MOP
|
|
- MRU
|
|
- MUR
|
|
- MVR
|
|
- MWK
|
|
- MXN
|
|
- MYR
|
|
- MZN
|
|
- NAD
|
|
- NGN
|
|
- NIO
|
|
- NOK
|
|
- NPR
|
|
- NZD
|
|
- OMR
|
|
- PAB
|
|
- PEN
|
|
- PGK
|
|
- PHP
|
|
- PKR
|
|
- PLN
|
|
- PRB
|
|
- PYG
|
|
- QAR
|
|
- RON
|
|
- RSD
|
|
- RUB
|
|
- RWF
|
|
- SAR
|
|
- SBD
|
|
- SCR
|
|
- SDG
|
|
- SEK
|
|
- SGD
|
|
- SHP
|
|
- SLL
|
|
- SOS
|
|
- SRD
|
|
- SSP
|
|
- STN
|
|
- SYP
|
|
- SZL
|
|
- THB
|
|
- TJS
|
|
- TMT
|
|
- TND
|
|
- TOP
|
|
- TRY
|
|
- TTD
|
|
- TWD
|
|
- TZS
|
|
- UAH
|
|
- UGX
|
|
- USD
|
|
- UYU
|
|
- UZS
|
|
- VEF
|
|
- VES
|
|
- VND
|
|
- VUV
|
|
- WST
|
|
- XAF
|
|
- XCD
|
|
- XOF
|
|
- XPF
|
|
- YER
|
|
- ZAR
|
|
- ZMW
|
|
date_created:
|
|
type: string
|
|
description: The date the order was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the order was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the order was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the order was last modified, as GMT.
|
|
discount_total:
|
|
type: string
|
|
description: Total discount amount for the order.
|
|
discount_tax:
|
|
type: string
|
|
description: Total discount tax amount for the order.
|
|
shipping_total:
|
|
type: string
|
|
description: Total shipping amount for the order.
|
|
shipping_tax:
|
|
type: string
|
|
description: Total shipping tax amount for the order.
|
|
cart_tax:
|
|
type: string
|
|
description: Sum of line item taxes only.
|
|
total:
|
|
type: string
|
|
description: Grand total.
|
|
total_tax:
|
|
type: string
|
|
description: Sum of all taxes.
|
|
prices_include_tax:
|
|
type: boolean
|
|
description: True the prices included tax during checkout.
|
|
customer_id:
|
|
type: integer
|
|
description: User ID who owns the order. 0 for guests.
|
|
customer_ip_address:
|
|
type: string
|
|
description: Customer's IP address.
|
|
customer_user_agent:
|
|
type: string
|
|
description: User agent of the customer.
|
|
customer_note:
|
|
type: string
|
|
description: Note left by customer during checkout.
|
|
billing:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
email:
|
|
type: string
|
|
format: email
|
|
description: Email address.
|
|
phone:
|
|
type: string
|
|
description: Phone number.
|
|
description: Billing address.
|
|
shipping:
|
|
type: object
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
description: First name.
|
|
last_name:
|
|
type: string
|
|
description: Last name.
|
|
company:
|
|
type: string
|
|
description: Company name.
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
city:
|
|
type: string
|
|
description: City name.
|
|
state:
|
|
type: string
|
|
description: ISO code or name of the state, province or district.
|
|
postcode:
|
|
type: string
|
|
description: Postal code.
|
|
country:
|
|
type: string
|
|
description: Country code in ISO 3166-1 alpha-2 format.
|
|
description: Shipping address.
|
|
payment_method:
|
|
type: string
|
|
description: Payment method ID.
|
|
payment_method_title:
|
|
type: string
|
|
description: Payment method title.
|
|
transaction_id:
|
|
type: string
|
|
description: Unique transaction ID.
|
|
date_paid:
|
|
type: string
|
|
description: The date the order was paid, in the site's timezone.
|
|
date_paid_gmt:
|
|
type: string
|
|
description: The date the order was paid, as GMT.
|
|
date_completed:
|
|
type: string
|
|
description: The date the order was completed, in the site's timezone.
|
|
date_completed_gmt:
|
|
type: string
|
|
description: The date the order was completed, as GMT.
|
|
cart_hash:
|
|
type: string
|
|
description: MD5 hash of cart items to ensure orders are not modified.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
line_items:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
parent_name:
|
|
type: string
|
|
description: Parent product name if the product is a variation.
|
|
product_id:
|
|
type: string
|
|
description: Product ID.
|
|
variation_id:
|
|
type: integer
|
|
description: Variation ID, if applicable.
|
|
quantity:
|
|
type: integer
|
|
description: Quantity ordered.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of product.
|
|
subtotal:
|
|
type: string
|
|
description: Line subtotal (before discounts).
|
|
subtotal_tax:
|
|
type: string
|
|
description: Line subtotal tax (before discounts).
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
display_key:
|
|
type: string
|
|
description: Meta key for UI display.
|
|
display_value:
|
|
type: string
|
|
description: Meta value for UI display.
|
|
description: Meta data.
|
|
sku:
|
|
type: string
|
|
description: Product SKU.
|
|
price:
|
|
type: number
|
|
description: Product price.
|
|
description: Line items data.
|
|
tax_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
rate_code:
|
|
type: string
|
|
description: Tax rate code.
|
|
rate_id:
|
|
type: string
|
|
description: Tax rate ID.
|
|
label:
|
|
type: string
|
|
description: Tax rate label.
|
|
compound:
|
|
type: boolean
|
|
description: Show if is a compound tax rate.
|
|
tax_total:
|
|
type: string
|
|
description: Tax total (not including shipping taxes).
|
|
shipping_tax_total:
|
|
type: string
|
|
description: Shipping tax total.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Tax lines data.
|
|
shipping_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
method_title:
|
|
type: string
|
|
description: Shipping method name.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
instance_id:
|
|
type: string
|
|
description: Shipping instance ID.
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Shipping lines data.
|
|
fee_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
name:
|
|
type: string
|
|
description: Fee name.
|
|
tax_class:
|
|
type: string
|
|
description: Tax class of fee.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status of fee.
|
|
enum:
|
|
- taxable
|
|
- none
|
|
total:
|
|
type: string
|
|
description: Line total (after discounts).
|
|
total_tax:
|
|
type: string
|
|
description: Line total tax (after discounts).
|
|
taxes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tax rate ID.
|
|
total:
|
|
type: string
|
|
description: Tax total.
|
|
subtotal:
|
|
type: string
|
|
description: Tax subtotal.
|
|
description: Line taxes.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Fee lines data.
|
|
coupon_lines:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Item ID.
|
|
code:
|
|
type: string
|
|
description: Coupon code.
|
|
discount:
|
|
type: string
|
|
description: Discount total.
|
|
discount_tax:
|
|
type: string
|
|
description: Discount total tax.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
description: Coupons line data.
|
|
refunds:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Refund ID.
|
|
reason:
|
|
type: string
|
|
description: Refund reason.
|
|
total:
|
|
type: string
|
|
description: Refund total.
|
|
description: List of refunds.
|
|
set_paid:
|
|
type: boolean
|
|
description: Define if the order is paid. It will set the status to processing and reduce stock items.
|
|
product_attribute_term:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Term name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
count:
|
|
type: integer
|
|
description: Number of published products for the resource.
|
|
product_attribute:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
type:
|
|
type: string
|
|
description: Type of attribute.
|
|
enum:
|
|
- select
|
|
order_by:
|
|
type: string
|
|
description: Default sort order.
|
|
enum:
|
|
- menu_order
|
|
- name
|
|
- name_num
|
|
- id
|
|
has_archives:
|
|
type: boolean
|
|
description: Enable/Disable attribute archives.
|
|
product_cat:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
parent:
|
|
type: integer
|
|
description: The ID for the parent of the resource.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
display:
|
|
type: string
|
|
description: Category archive display type.
|
|
enum:
|
|
- default
|
|
- products
|
|
- subcategories
|
|
- both
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Image data.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort the resource.
|
|
count:
|
|
type: integer
|
|
description: Number of published products for the resource.
|
|
product_review:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
date_created:
|
|
type: string
|
|
description: The date the review was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the review was created, as GMT.
|
|
product_id:
|
|
type: integer
|
|
description: Unique identifier for the product that the review belongs to.
|
|
status:
|
|
type: string
|
|
description: Status of the review.
|
|
enum:
|
|
- approved
|
|
- hold
|
|
- spam
|
|
- unspam
|
|
- trash
|
|
- untrash
|
|
reviewer:
|
|
type: string
|
|
description: Reviewer name.
|
|
reviewer_email:
|
|
type: string
|
|
format: email
|
|
description: Reviewer email.
|
|
review:
|
|
type: string
|
|
description: The content of the review.
|
|
rating:
|
|
type: integer
|
|
description: Review rating (0 to 5).
|
|
verified:
|
|
type: boolean
|
|
description: Shows if the reviewer bought the product or not.
|
|
reviewer_avatar_urls:
|
|
type: object
|
|
properties:
|
|
"24":
|
|
type: string
|
|
format: uri
|
|
description: Avatar URL with image size of 24 pixels.
|
|
"48":
|
|
type: string
|
|
format: uri
|
|
description: Avatar URL with image size of 48 pixels.
|
|
"96":
|
|
type: string
|
|
format: uri
|
|
description: Avatar URL with image size of 96 pixels.
|
|
description: Avatar URLs for the object reviewer.
|
|
product_shipping_class:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Shipping class name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
count:
|
|
type: integer
|
|
description: Number of published products for the resource.
|
|
product_tag:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource unique to its type.
|
|
description:
|
|
type: string
|
|
description: HTML description of the resource.
|
|
count:
|
|
type: integer
|
|
description: Number of published products for the resource.
|
|
product:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
slug:
|
|
type: string
|
|
description: Product slug.
|
|
permalink:
|
|
type: string
|
|
format: uri
|
|
description: Product URL.
|
|
date_created:
|
|
type: string
|
|
description: The date the product was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the product was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the product was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the product was last modified, as GMT.
|
|
type:
|
|
type: string
|
|
description: Product type.
|
|
enum:
|
|
- simple
|
|
- grouped
|
|
- external
|
|
- variable
|
|
status:
|
|
type: string
|
|
description: Product status (post status).
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
- future
|
|
featured:
|
|
type: boolean
|
|
description: Featured product.
|
|
catalog_visibility:
|
|
type: string
|
|
description: Catalog visibility.
|
|
enum:
|
|
- visible
|
|
- catalog
|
|
- search
|
|
- hidden
|
|
description:
|
|
type: string
|
|
description: Product description.
|
|
short_description:
|
|
type: string
|
|
description: Product short description.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
price:
|
|
type: string
|
|
description: Current product price.
|
|
regular_price:
|
|
type: string
|
|
description: Product regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Product sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
price_html:
|
|
type: string
|
|
description: Price formatted in HTML.
|
|
on_sale:
|
|
type: boolean
|
|
description: Shows if the product is on sale.
|
|
purchasable:
|
|
type: boolean
|
|
description: Shows if the product can be bought.
|
|
total_sales:
|
|
type: integer
|
|
description: Amount of sales.
|
|
virtual:
|
|
type: boolean
|
|
description: If the product is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the product is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
external_url:
|
|
type: string
|
|
format: uri
|
|
description: Product external URL. Only for external products.
|
|
button_text:
|
|
type: string
|
|
description: Product external button text. Only for external products.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at product level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
backorders_allowed:
|
|
type: boolean
|
|
description: Shows if backorders are allowed.
|
|
backordered:
|
|
type: boolean
|
|
description: Shows if the product is on backordered.
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the product.
|
|
sold_individually:
|
|
type: boolean
|
|
description: Allow one item to be bought in a single order.
|
|
weight:
|
|
type: string
|
|
description: Product weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Product length (cm).
|
|
width:
|
|
type: string
|
|
description: Product width (cm).
|
|
height:
|
|
type: string
|
|
description: Product height (cm).
|
|
description: Product dimensions.
|
|
shipping_required:
|
|
type: boolean
|
|
description: Shows if the product need to be shipped.
|
|
shipping_taxable:
|
|
type: boolean
|
|
description: Shows whether or not the product shipping is taxable.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
shipping_class_id:
|
|
type: string
|
|
description: Shipping class ID.
|
|
reviews_allowed:
|
|
type: boolean
|
|
description: Allow reviews.
|
|
average_rating:
|
|
type: string
|
|
description: Reviews average rating.
|
|
rating_count:
|
|
type: integer
|
|
description: Amount of reviews that the product have.
|
|
related_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of related products IDs.
|
|
upsell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of up-sell products IDs.
|
|
cross_sell_ids:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of cross-sell products IDs.
|
|
parent_id:
|
|
type: integer
|
|
description: Product parent ID.
|
|
purchase_note:
|
|
type: string
|
|
description: Optional note to send the customer after purchase.
|
|
categories:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Category ID.
|
|
name:
|
|
type: string
|
|
description: Category name.
|
|
slug:
|
|
type: string
|
|
description: Category slug.
|
|
description: List of categories.
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Tag ID.
|
|
name:
|
|
type: string
|
|
description: Tag name.
|
|
slug:
|
|
type: string
|
|
description: Tag slug.
|
|
description: List of tags.
|
|
images:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: List of images.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
position:
|
|
type: integer
|
|
description: Attribute position.
|
|
visible:
|
|
type: boolean
|
|
description: Define if the attribute is visible on the "Additional information" tab in the product's page.
|
|
variation:
|
|
type: boolean
|
|
description: Define if the attribute can be used as variation.
|
|
options:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of available term names of the attribute.
|
|
description: List of attributes.
|
|
default_attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: Defaults variation attributes.
|
|
variations:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of variations IDs.
|
|
grouped_products:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: List of grouped products ID.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
product_variation:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
date_created:
|
|
type: string
|
|
description: The date the variation was created, in the site's timezone.
|
|
date_modified:
|
|
type: string
|
|
description: The date the variation was last modified, in the site's timezone.
|
|
description:
|
|
type: string
|
|
description: Variation description.
|
|
permalink:
|
|
type: string
|
|
format: uri
|
|
description: Variation URL.
|
|
sku:
|
|
type: string
|
|
description: Unique identifier.
|
|
price:
|
|
type: string
|
|
description: Current variation price.
|
|
regular_price:
|
|
type: string
|
|
description: Variation regular price.
|
|
sale_price:
|
|
type: string
|
|
description: Variation sale price.
|
|
date_on_sale_from:
|
|
type: string
|
|
description: Start date of sale price, in the site's timezone.
|
|
date_on_sale_from_gmt:
|
|
type: string
|
|
description: Start date of sale price, as GMT.
|
|
date_on_sale_to:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
date_on_sale_to_gmt:
|
|
type: string
|
|
description: End date of sale price, in the site's timezone.
|
|
on_sale:
|
|
type: boolean
|
|
description: Shows if the variation is on sale.
|
|
status:
|
|
type: string
|
|
description: Variation status.
|
|
enum:
|
|
- draft
|
|
- pending
|
|
- private
|
|
- publish
|
|
purchasable:
|
|
type: boolean
|
|
description: Shows if the variation can be bought.
|
|
virtual:
|
|
type: boolean
|
|
description: If the variation is virtual.
|
|
downloadable:
|
|
type: boolean
|
|
description: If the variation is downloadable.
|
|
downloads:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: File ID.
|
|
name:
|
|
type: string
|
|
description: File name.
|
|
file:
|
|
type: string
|
|
description: File URL.
|
|
description: List of downloadable files.
|
|
download_limit:
|
|
type: integer
|
|
description: Number of times downloadable files can be downloaded after purchase.
|
|
download_expiry:
|
|
type: integer
|
|
description: Number of days until access to downloadable files expires.
|
|
tax_status:
|
|
type: string
|
|
description: Tax status.
|
|
enum:
|
|
- taxable
|
|
- shipping
|
|
- none
|
|
tax_class:
|
|
type: string
|
|
description: Tax class.
|
|
manage_stock:
|
|
type: boolean
|
|
description: Stock management at variation level.
|
|
stock_quantity:
|
|
type: integer
|
|
description: Stock quantity.
|
|
stock_status:
|
|
type: string
|
|
description: Controls the stock status of the product.
|
|
enum:
|
|
- instock
|
|
- outofstock
|
|
- onbackorder
|
|
backorders:
|
|
type: string
|
|
description: If managing stock, this controls if backorders are allowed.
|
|
enum:
|
|
- "no"
|
|
- notify
|
|
- "yes"
|
|
backorders_allowed:
|
|
type: boolean
|
|
description: Shows if backorders are allowed.
|
|
backordered:
|
|
type: boolean
|
|
description: Shows if the variation is on backordered.
|
|
low_stock_amount:
|
|
type: integer
|
|
description: Low Stock amount for the variation.
|
|
weight:
|
|
type: string
|
|
description: Variation weight (kg).
|
|
dimensions:
|
|
type: object
|
|
properties:
|
|
length:
|
|
type: string
|
|
description: Variation length (cm).
|
|
width:
|
|
type: string
|
|
description: Variation width (cm).
|
|
height:
|
|
type: string
|
|
description: Variation height (cm).
|
|
description: Variation dimensions.
|
|
shipping_class:
|
|
type: string
|
|
description: Shipping class slug.
|
|
shipping_class_id:
|
|
type: string
|
|
description: Shipping class ID.
|
|
image:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Image ID.
|
|
date_created:
|
|
type: string
|
|
description: The date the image was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the image was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the image was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the image was last modified, as GMT.
|
|
src:
|
|
type: string
|
|
format: uri
|
|
description: Image URL.
|
|
name:
|
|
type: string
|
|
description: Image name.
|
|
alt:
|
|
type: string
|
|
description: Image alternative text.
|
|
description: Variation image data.
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Attribute ID.
|
|
name:
|
|
type: string
|
|
description: Attribute name.
|
|
option:
|
|
type: string
|
|
description: Selected attribute term name.
|
|
description: List of attributes.
|
|
menu_order:
|
|
type: integer
|
|
description: Menu order, used to custom sort products.
|
|
meta_data:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Meta ID.
|
|
key:
|
|
type: string
|
|
description: Meta key.
|
|
value:
|
|
type: string
|
|
description: Meta value.
|
|
description: Meta data.
|
|
sales_report:
|
|
type: object
|
|
properties:
|
|
total_sales:
|
|
type: string
|
|
description: Gross sales in the period.
|
|
net_sales:
|
|
type: string
|
|
description: Net sales in the period.
|
|
average_sales:
|
|
type: string
|
|
description: Average net daily sales.
|
|
total_orders:
|
|
type: integer
|
|
description: Total of orders placed.
|
|
total_items:
|
|
type: integer
|
|
description: Total of items purchased.
|
|
total_tax:
|
|
type: string
|
|
description: Total charged for taxes.
|
|
total_shipping:
|
|
type: string
|
|
description: Total charged for shipping.
|
|
total_refunds:
|
|
type: integer
|
|
description: Total of refunded orders.
|
|
total_discount:
|
|
type: integer
|
|
description: Total of coupons used.
|
|
totals_grouped_by:
|
|
type: string
|
|
description: Group type.
|
|
totals:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
description: Totals.
|
|
top_sellers_report:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Product name.
|
|
product_id:
|
|
type: integer
|
|
description: Product ID.
|
|
quantity:
|
|
type: integer
|
|
description: Total number of purchases.
|
|
report_order_total:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Order status name.
|
|
total:
|
|
type: string
|
|
description: Amount of orders.
|
|
report_product_total:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Product type name.
|
|
total:
|
|
type: string
|
|
description: Amount of products.
|
|
report_customer_total:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Customer type name.
|
|
total:
|
|
type: string
|
|
description: Amount of customers.
|
|
report_coupon_total:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Coupon type name.
|
|
total:
|
|
type: string
|
|
description: Amount of coupons.
|
|
report_review_total:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Review type name.
|
|
total:
|
|
type: string
|
|
description: Amount of reviews.
|
|
report:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: An alphanumeric identifier for the resource.
|
|
description:
|
|
type: string
|
|
description: A human-readable description of the resource.
|
|
setting_group:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier that can be used to link settings together.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
parent_id:
|
|
type: string
|
|
description: ID of parent grouping.
|
|
sub_groups:
|
|
type: string
|
|
description: IDs for settings sub groups.
|
|
setting:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
group_id:
|
|
type: string
|
|
description: An identifier for the group this setting belongs to.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
options:
|
|
type: object
|
|
description: Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.
|
|
shipping_zone:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Shipping zone name.
|
|
order:
|
|
type: integer
|
|
description: Shipping zone order.
|
|
shipping_zone_location:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: Shipping zone location code.
|
|
type:
|
|
type: string
|
|
description: Shipping zone location type.
|
|
enum:
|
|
- postcode
|
|
- state
|
|
- country
|
|
- continent
|
|
shipping_zone_method:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Shipping method instance ID.
|
|
instance_id:
|
|
type: integer
|
|
description: Shipping method instance ID.
|
|
title:
|
|
type: string
|
|
description: Shipping method customer facing title.
|
|
order:
|
|
type: integer
|
|
description: Shipping method sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Shipping method enabled status.
|
|
method_id:
|
|
type: string
|
|
description: Shipping method ID.
|
|
method_title:
|
|
type: string
|
|
description: Shipping method title.
|
|
method_description:
|
|
type: string
|
|
description: Shipping method description.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
- class
|
|
- order
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Shipping method settings.
|
|
tax_class:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: Tax class name.
|
|
required:
|
|
- name
|
|
tax:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
country:
|
|
type: string
|
|
description: Country ISO 3166 code.
|
|
state:
|
|
type: string
|
|
description: State code.
|
|
postcode:
|
|
type: string
|
|
description: Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.
|
|
city:
|
|
type: string
|
|
description: City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.
|
|
rate:
|
|
type: string
|
|
description: Tax rate.
|
|
name:
|
|
type: string
|
|
description: Tax rate name.
|
|
priority:
|
|
type: integer
|
|
description: Tax priority.
|
|
compound:
|
|
type: boolean
|
|
description: Whether or not this is a compound rate.
|
|
shipping:
|
|
type: boolean
|
|
description: Whether or not this tax rate also gets applied to shipping.
|
|
order:
|
|
type: integer
|
|
description: Indicates the order that will appear in queries.
|
|
class:
|
|
type: string
|
|
description: Tax class.
|
|
enum:
|
|
- standard
|
|
- reduced-rate
|
|
- zero-rate
|
|
postcodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of postcodes / ZIPs. Introduced in WooCommerce 5.3.
|
|
cities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: List of city names. Introduced in WooCommerce 5.3.
|
|
webhook:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: Unique identifier for the resource.
|
|
name:
|
|
type: string
|
|
description: A friendly name for the webhook.
|
|
status:
|
|
type: string
|
|
description: Webhook status.
|
|
enum:
|
|
- active
|
|
- paused
|
|
- disabled
|
|
topic:
|
|
type: string
|
|
description: Webhook topic.
|
|
resource:
|
|
type: string
|
|
description: Webhook resource.
|
|
event:
|
|
type: string
|
|
description: Webhook event.
|
|
hooks:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: WooCommerce action names associated with the webhook.
|
|
delivery_url:
|
|
type: string
|
|
format: uri
|
|
description: The URL where the webhook payload is delivered.
|
|
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.
|
|
date_created:
|
|
type: string
|
|
description: The date the webhook was created, in the site's timezone.
|
|
date_created_gmt:
|
|
type: string
|
|
description: The date the webhook was created, as GMT.
|
|
date_modified:
|
|
type: string
|
|
description: The date the webhook was last modified, in the site's timezone.
|
|
date_modified_gmt:
|
|
type: string
|
|
description: The date the webhook was last modified, as GMT.
|
|
system_status:
|
|
type: object
|
|
properties:
|
|
environment:
|
|
type: object
|
|
properties:
|
|
home_url:
|
|
type: string
|
|
format: uri
|
|
description: Home URL.
|
|
site_url:
|
|
type: string
|
|
format: uri
|
|
description: Site URL.
|
|
version:
|
|
type: string
|
|
description: WooCommerce version.
|
|
log_directory:
|
|
type: string
|
|
description: Log directory.
|
|
log_directory_writable:
|
|
type: boolean
|
|
description: Is log directory writable?
|
|
wp_version:
|
|
type: string
|
|
description: WordPress version.
|
|
wp_multisite:
|
|
type: boolean
|
|
description: Is WordPress multisite?
|
|
wp_memory_limit:
|
|
type: integer
|
|
description: WordPress memory limit.
|
|
wp_debug_mode:
|
|
type: boolean
|
|
description: Is WordPress debug mode active?
|
|
wp_cron:
|
|
type: boolean
|
|
description: Are WordPress cron jobs enabled?
|
|
language:
|
|
type: string
|
|
description: WordPress language.
|
|
server_info:
|
|
type: string
|
|
description: Server info.
|
|
php_version:
|
|
type: string
|
|
description: PHP version.
|
|
php_post_max_size:
|
|
type: integer
|
|
description: PHP post max size.
|
|
php_max_execution_time:
|
|
type: integer
|
|
description: PHP max execution time.
|
|
php_max_input_vars:
|
|
type: integer
|
|
description: PHP max input vars.
|
|
curl_version:
|
|
type: string
|
|
description: cURL version.
|
|
suhosin_installed:
|
|
type: boolean
|
|
description: Is SUHOSIN installed?
|
|
max_upload_size:
|
|
type: integer
|
|
description: Max upload size.
|
|
mysql_version:
|
|
type: string
|
|
description: MySQL version.
|
|
mysql_version_string:
|
|
type: string
|
|
description: MySQL version string.
|
|
default_timezone:
|
|
type: string
|
|
description: Default timezone.
|
|
fsockopen_or_curl_enabled:
|
|
type: boolean
|
|
description: Is fsockopen/cURL enabled?
|
|
soapclient_enabled:
|
|
type: boolean
|
|
description: Is SoapClient class enabled?
|
|
domdocument_enabled:
|
|
type: boolean
|
|
description: Is DomDocument class enabled?
|
|
gzip_enabled:
|
|
type: boolean
|
|
description: Is GZip enabled?
|
|
mbstring_enabled:
|
|
type: boolean
|
|
description: Is mbstring enabled?
|
|
remote_post_successful:
|
|
type: boolean
|
|
description: Remote POST successful?
|
|
remote_post_response:
|
|
type: string
|
|
description: Remote POST response.
|
|
remote_get_successful:
|
|
type: boolean
|
|
description: Remote GET successful?
|
|
remote_get_response:
|
|
type: string
|
|
description: Remote GET response.
|
|
description: Environment.
|
|
database:
|
|
type: object
|
|
properties:
|
|
wc_database_version:
|
|
type: string
|
|
description: WC database version.
|
|
database_prefix:
|
|
type: string
|
|
description: Database prefix.
|
|
maxmind_geoip_database:
|
|
type: string
|
|
description: MaxMind GeoIP database.
|
|
database_tables:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Database tables.
|
|
description: Database.
|
|
active_plugins:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Active plugins.
|
|
inactive_plugins:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Inactive plugins.
|
|
dropins_mu_plugins:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Dropins & MU plugins.
|
|
theme:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Theme name.
|
|
version:
|
|
type: string
|
|
description: Theme version.
|
|
version_latest:
|
|
type: string
|
|
description: Latest version of theme.
|
|
author_url:
|
|
type: string
|
|
format: uri
|
|
description: Theme author URL.
|
|
is_child_theme:
|
|
type: boolean
|
|
description: Is this theme a child theme?
|
|
has_woocommerce_support:
|
|
type: boolean
|
|
description: Does the theme declare WooCommerce support?
|
|
has_woocommerce_file:
|
|
type: boolean
|
|
description: Does the theme have a woocommerce.php file?
|
|
has_outdated_templates:
|
|
type: boolean
|
|
description: Does this theme have outdated templates?
|
|
overrides:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Template overrides.
|
|
parent_name:
|
|
type: string
|
|
description: Parent theme name.
|
|
parent_version:
|
|
type: string
|
|
description: Parent theme version.
|
|
parent_author_url:
|
|
type: string
|
|
format: uri
|
|
description: Parent theme author URL.
|
|
description: Theme.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
api_enabled:
|
|
type: boolean
|
|
description: REST API enabled?
|
|
force_ssl:
|
|
type: boolean
|
|
description: SSL forced?
|
|
currency:
|
|
type: string
|
|
description: Currency.
|
|
currency_symbol:
|
|
type: string
|
|
description: Currency symbol.
|
|
currency_position:
|
|
type: string
|
|
description: Currency position.
|
|
thousand_separator:
|
|
type: string
|
|
description: Thousand separator.
|
|
decimal_separator:
|
|
type: string
|
|
description: Decimal separator.
|
|
number_of_decimals:
|
|
type: integer
|
|
description: Number of decimals.
|
|
geolocation_enabled:
|
|
type: boolean
|
|
description: Geolocation enabled?
|
|
taxonomies:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Taxonomy terms for product/order statuses.
|
|
product_visibility_terms:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Terms in the product visibility taxonomy.
|
|
description: Settings.
|
|
security:
|
|
type: object
|
|
properties:
|
|
secure_connection:
|
|
type: boolean
|
|
description: Is the connection to your store secure?
|
|
hide_errors:
|
|
type: boolean
|
|
description: Hide errors from visitors?
|
|
description: Security.
|
|
pages:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: WooCommerce pages.
|
|
post_type_counts:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Total post count.
|
|
system_status_tool:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the tool.
|
|
name:
|
|
type: string
|
|
description: Tool name.
|
|
action:
|
|
type: string
|
|
description: What running the tool will do.
|
|
description:
|
|
type: string
|
|
description: Tool description.
|
|
success:
|
|
type: boolean
|
|
description: Did the tool run successfully?
|
|
message:
|
|
type: string
|
|
description: Tool return message.
|
|
shipping_method:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Method ID.
|
|
title:
|
|
type: string
|
|
description: Shipping method title.
|
|
description:
|
|
type: string
|
|
description: Shipping method description.
|
|
payment_gateway:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Payment gateway ID.
|
|
title:
|
|
type: string
|
|
description: Payment gateway title on checkout.
|
|
description:
|
|
type: string
|
|
description: Payment gateway description on checkout.
|
|
order:
|
|
type: integer
|
|
description: Payment gateway sort order.
|
|
enabled:
|
|
type: boolean
|
|
description: Payment gateway enabled status.
|
|
method_title:
|
|
type: string
|
|
description: Payment gateway method title.
|
|
method_description:
|
|
type: string
|
|
description: Payment gateway method description.
|
|
method_supports:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Supported features for this payment gateway.
|
|
settings:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: A unique identifier for the setting.
|
|
label:
|
|
type: string
|
|
description: A human readable label for the setting used in interfaces.
|
|
description:
|
|
type: string
|
|
description: A human readable description for the setting used in interfaces.
|
|
type:
|
|
type: string
|
|
description: Type of setting.
|
|
enum:
|
|
- text
|
|
- email
|
|
- number
|
|
- color
|
|
- password
|
|
- textarea
|
|
- select
|
|
- multiselect
|
|
- radio
|
|
- image_width
|
|
- checkbox
|
|
value:
|
|
type: string
|
|
description: Setting value.
|
|
default:
|
|
type: string
|
|
description: Default value for the setting.
|
|
tip:
|
|
type: string
|
|
description: Additional help text shown to the user about the setting.
|
|
placeholder:
|
|
type: string
|
|
description: Placeholder text to be displayed in text inputs.
|
|
description: Payment gateway settings.
|
|
data_index:
|
|
type: object
|
|
properties:
|
|
slug:
|
|
type: string
|
|
description: Data resource ID.
|
|
description:
|
|
type: string
|
|
description: Data resource description.
|
|
data_continents:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: 2 character continent code.
|
|
name:
|
|
type: string
|
|
description: Full name of continent.
|
|
countries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: ISO3166 alpha-2 country code.
|
|
currency_code:
|
|
type: string
|
|
description: Default ISO4127 alpha-3 currency code for the country.
|
|
currency_pos:
|
|
type: string
|
|
description: Currency symbol position for this country.
|
|
decimal_sep:
|
|
type: string
|
|
description: Decimal separator for displayed prices for this country.
|
|
dimension_unit:
|
|
type: string
|
|
description: The unit lengths are defined in for this country.
|
|
name:
|
|
type: string
|
|
description: Full name of country.
|
|
num_decimals:
|
|
type: integer
|
|
description: Number of decimal points shown in displayed prices for this country.
|
|
states:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: State code.
|
|
name:
|
|
type: string
|
|
description: Full name of state.
|
|
description: List of states in this country.
|
|
thousand_sep:
|
|
type: string
|
|
description: Thousands separator for displayed prices in this country.
|
|
weight_unit:
|
|
type: string
|
|
description: The unit weights are defined in for this country.
|
|
description: List of countries on this continent.
|
|
data_countries:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: ISO3166 alpha-2 country code.
|
|
name:
|
|
type: string
|
|
description: Full name of country.
|
|
states:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: State code.
|
|
name:
|
|
type: string
|
|
description: Full name of state.
|
|
description: List of states in this country.
|
|
data_currencies:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: string
|
|
description: ISO4217 currency code.
|
|
name:
|
|
type: string
|
|
description: Full name of currency.
|
|
symbol:
|
|
type: string
|
|
description: Currency symbol.
|