From 6cb00aed0e78a2bd5632fa2906ffb58eb31429f6 Mon Sep 17 00:00:00 2001 From: Nestor Soriano Date: Wed, 12 May 2021 09:04:05 +0200 Subject: [PATCH] Update to add the new 'dates_are_gmt' parameter introduced in #28132. --- source/includes/wp-api-v1/_coupons.md | 29 +++++++-------- source/includes/wp-api-v1/_order-refunds.md | 29 +++++++-------- source/includes/wp-api-v1/_orders.md | 35 ++++++++++--------- source/includes/wp-api-v1/_products.md | 1 + source/includes/wp-api-v1/_webhooks.md | 31 ++++++++-------- source/includes/wp-api-v2/_coupons.md | 29 +++++++-------- source/includes/wp-api-v2/_order-refunds.md | 1 + source/includes/wp-api-v2/_orders.md | 1 + .../includes/wp-api-v2/_product-variations.md | 1 + source/includes/wp-api-v2/_products.md | 1 + source/includes/wp-api-v2/_webhooks.md | 29 +++++++-------- source/includes/wp-api-v3/_coupons.md | 29 +++++++-------- source/includes/wp-api-v3/_order-refunds.md | 1 + source/includes/wp-api-v3/_orders.md | 1 + source/includes/wp-api-v3/_product-reviews.md | 1 + .../includes/wp-api-v3/_product-variations.md | 1 + source/includes/wp-api-v3/_products.md | 1 + source/includes/wp-api-v3/_webhooks.md | 29 +++++++-------- 18 files changed, 134 insertions(+), 116 deletions(-) diff --git a/source/includes/wp-api-v1/_coupons.md b/source/includes/wp-api-v1/_coupons.md index 05111202..85d7e7b4 100644 --- a/source/includes/wp-api-v1/_coupons.md +++ b/source/includes/wp-api-v1/_coupons.md @@ -365,20 +365,21 @@ woocommerce.get("coupons").parsed_response #### Available parameters #### -| Parameter | Type | Description | -|------------|---------|---------------------------------------------------------------------------------------------------------------| -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | -| `page` | integer | Current page of the collection. | -| `per_page` | integer | Maximum number of items to be returned in result set. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | string | Ensure result set excludes specific ids. | -| `include` | string | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | -| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | -| `code` | string | Limit result set to resources with a specific code. | +| Parameter | Type | Description | +|-----------------|---------|---------------------------------------------------------------------------------------------------------------| +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | +| `page` | integer | Current page of the collection. | +| `per_page` | integer | Maximum number of items to be returned in result set. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | string | Ensure result set excludes specific ids. | +| `include` | string | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | +| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | +| `code` | string | Limit result set to resources with a specific code. | ## Update a coupon ## diff --git a/source/includes/wp-api-v1/_order-refunds.md b/source/includes/wp-api-v1/_order-refunds.md index 722caea4..ab4db40d 100644 --- a/source/includes/wp-api-v1/_order-refunds.md +++ b/source/includes/wp-api-v1/_order-refunds.md @@ -311,20 +311,21 @@ woocommerce.get("orders/116/refunds").parsed_response #### Available parameters #### -| Parameter | Type | Description | -|------------|---------|---------------------------------------------------------------------------------------------------------------| -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | -| `page` | integer | Current page of the collection. | -| `per_page` | integer | Maximum number of items to be returned in result set. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | string | Ensure result set excludes specific ids. | -| `include` | string | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | -| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | -| `dp` | string | Number of decimal points to use in each resource. | +| Parameter | Type | Description | +|-----------------|---------|---------------------------------------------------------------------------------------------------------------| +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | +| `page` | integer | Current page of the collection. | +| `per_page` | integer | Maximum number of items to be returned in result set. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | string | Ensure result set excludes specific ids. | +| `include` | string | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | +| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | +| `dp` | string | Number of decimal points to use in each resource. | ## Delete a refund ## diff --git a/source/includes/wp-api-v1/_orders.md b/source/includes/wp-api-v1/_orders.md index 537a8544..6068f009 100644 --- a/source/includes/wp-api-v1/_orders.md +++ b/source/includes/wp-api-v1/_orders.md @@ -1023,23 +1023,24 @@ woocommerce.get("orders").parsed_response #### Available parameters #### -| Parameter | Type | Description | -|------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | -| `page` | integer | Current page of the collection. | -| `per_page` | integer | Maximum number of items to be returned in result set. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | string | Ensure result set excludes specific ids. | -| `include` | string | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | -| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | -| `status` | string | Limit result set to orders assigned a specific status. Default is `any`. Options (plugins may add new status): `any`, `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded` and `failed`. | -| `customer` | string | Limit result set to orders assigned a specific customer. | -| `product` | string | Limit result set to orders assigned a specific product. | -| `dp` | string | Number of decimal points to use in each resource. | +| Parameter | Type | Description | +|-----------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | +| `page` | integer | Current page of the collection. | +| `per_page` | integer | Maximum number of items to be returned in result set. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | string | Ensure result set excludes specific ids. | +| `include` | string | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | +| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | +| `status` | string | Limit result set to orders assigned a specific status. Default is `any`. Options (plugins may add new status): `any`, `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded` and `failed`. | +| `customer` | string | Limit result set to orders assigned a specific customer. | +| `product` | string | Limit result set to orders assigned a specific product. | +| `dp` | string | Number of decimal points to use in each resource. | ## Update an Order ## diff --git a/source/includes/wp-api-v1/_products.md b/source/includes/wp-api-v1/_products.md index f19caf14..af89d02d 100644 --- a/source/includes/wp-api-v1/_products.md +++ b/source/includes/wp-api-v1/_products.md @@ -1913,6 +1913,7 @@ woocommerce.get("products").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | string | Ensure result set excludes specific ids. | | `include` | string | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v1/_webhooks.md b/source/includes/wp-api-v1/_webhooks.md index e184870a..a0851eca 100644 --- a/source/includes/wp-api-v1/_webhooks.md +++ b/source/includes/wp-api-v1/_webhooks.md @@ -387,21 +387,22 @@ woocommerce.get("webhooks").parsed_response #### Available parameters #### -| Parameter | Type | Description | -|------------|---------|-------------------------------------------------------------------------------------------------------------------------------| -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | -| `page` | integer | Current page of the collection. | -| `per_page` | integer | Maximum number of items to be returned in result set. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | string | Ensure result set excludes specific ids. | -| `include` | string | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | -| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | -| `slug` | string | Limit result set to posts with a specific slug. | -| `status` | string | Limit result set to webhooks assigned a specific status. Default is `all`. Options: `all`, `active`, `paused` and `disabled`. | +| Parameter | Type | Description | +|-----------------|---------|-------------------------------------------------------------------------------------------------------------------------------| +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. | +| `page` | integer | Current page of the collection. | +| `per_page` | integer | Maximum number of items to be returned in result set. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | string | Ensure result set excludes specific ids. | +| `include` | string | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | +| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. | +| `slug` | string | Limit result set to posts with a specific slug. | +| `status` | string | Limit result set to webhooks assigned a specific status. Default is `all`. Options: `all`, `active`, `paused` and `disabled`. | ## Update a webhook ## diff --git a/source/includes/wp-api-v2/_coupons.md b/source/includes/wp-api-v2/_coupons.md index d7de645b..183182ea 100644 --- a/source/includes/wp-api-v2/_coupons.md +++ b/source/includes/wp-api-v2/_coupons.md @@ -392,20 +392,21 @@ woocommerce.get("coupons").parsed_response #### Available parameters #### -| Parameter | Type | Description | -| ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | -| `page` | integer | Current page of the collection. Default is `1`. | -| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | array | Ensure result set excludes specific IDs. | -| `include` | array | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | -| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | -| `code` | string | Limit result set to resources with a specific code. | +| Parameter | Type | Description | +| --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | +| `page` | integer | Current page of the collection. Default is `1`. | +| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | array | Ensure result set excludes specific IDs. | +| `include` | array | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | +| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | +| `code` | string | Limit result set to resources with a specific code. | ## Update a coupon ## diff --git a/source/includes/wp-api-v2/_order-refunds.md b/source/includes/wp-api-v2/_order-refunds.md index c6b112e6..25929548 100644 --- a/source/includes/wp-api-v2/_order-refunds.md +++ b/source/includes/wp-api-v2/_order-refunds.md @@ -355,6 +355,7 @@ woocommerce.get("orders/723/refunds").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v2/_orders.md b/source/includes/wp-api-v2/_orders.md index 84318e0b..ad072a86 100644 --- a/source/includes/wp-api-v2/_orders.md +++ b/source/includes/wp-api-v2/_orders.md @@ -1195,6 +1195,7 @@ woocommerce.get("orders").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v2/_product-variations.md b/source/includes/wp-api-v2/_product-variations.md index 9781444a..bddae632 100644 --- a/source/includes/wp-api-v2/_product-variations.md +++ b/source/includes/wp-api-v2/_product-variations.md @@ -620,6 +620,7 @@ woocommerce.get("products/22/variations").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v2/_products.md b/source/includes/wp-api-v2/_products.md index 98d0f0e7..d72628e4 100644 --- a/source/includes/wp-api-v2/_products.md +++ b/source/includes/wp-api-v2/_products.md @@ -1513,6 +1513,7 @@ woocommerce.get("products").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v2/_webhooks.md b/source/includes/wp-api-v2/_webhooks.md index b3c6887e..a4601106 100644 --- a/source/includes/wp-api-v2/_webhooks.md +++ b/source/includes/wp-api-v2/_webhooks.md @@ -400,20 +400,21 @@ woocommerce.get("webhooks").parsed_response #### Available parameters #### -| Parameter | Type | Description | -| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | -| `page` | integer | Current page of the collection. Default is `1`. | -| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | array | Ensure result set excludes specific IDs. | -| `include` | array | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | -| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | -| `status` | string | Limit result set to webhooks assigned a specific status. Options: `all`, `active`, `paused` and `disabled`. Default is `all`. | +| Parameter | Type | Description | +| --------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | +| `page` | integer | Current page of the collection. Default is `1`. | +| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | array | Ensure result set excludes specific IDs. | +| `include` | array | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | +| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | +| `status` | string | Limit result set to webhooks assigned a specific status. Options: `all`, `active`, `paused` and `disabled`. Default is `all`. | ## Update a webhook ## diff --git a/source/includes/wp-api-v3/_coupons.md b/source/includes/wp-api-v3/_coupons.md index f40d19a4..0f85886f 100644 --- a/source/includes/wp-api-v3/_coupons.md +++ b/source/includes/wp-api-v3/_coupons.md @@ -392,20 +392,21 @@ woocommerce.get("coupons").parsed_response #### Available parameters #### -| Parameter | Type | Description | -| ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | -| `page` | integer | Current page of the collection. Default is `1`. | -| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | array | Ensure result set excludes specific IDs. | -| `include` | array | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | -| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | -| `code` | string | Limit result set to resources with a specific code. | +| Parameter | Type | Description | +| --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | +| `page` | integer | Current page of the collection. Default is `1`. | +| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | array | Ensure result set excludes specific IDs. | +| `include` | array | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | +| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | +| `code` | string | Limit result set to resources with a specific code. | ## Update a coupon ## diff --git a/source/includes/wp-api-v3/_order-refunds.md b/source/includes/wp-api-v3/_order-refunds.md index ce2c6efd..8f264fd1 100644 --- a/source/includes/wp-api-v3/_order-refunds.md +++ b/source/includes/wp-api-v3/_order-refunds.md @@ -423,6 +423,7 @@ woocommerce.get("orders/723/refunds").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v3/_orders.md b/source/includes/wp-api-v3/_orders.md index 59acd63e..40f51441 100644 --- a/source/includes/wp-api-v3/_orders.md +++ b/source/includes/wp-api-v3/_orders.md @@ -1195,6 +1195,7 @@ woocommerce.get("orders").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v3/_product-reviews.md b/source/includes/wp-api-v3/_product-reviews.md index 45f6c197..834e5721 100644 --- a/source/includes/wp-api-v3/_product-reviews.md +++ b/source/includes/wp-api-v3/_product-reviews.md @@ -346,6 +346,7 @@ woocommerce.get("products/reviews").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to reviews published after a given ISO8601 compliant date. | | `before` | string | Limit response to reviews published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific ids. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v3/_product-variations.md b/source/includes/wp-api-v3/_product-variations.md index 84ec8502..7e87db12 100644 --- a/source/includes/wp-api-v3/_product-variations.md +++ b/source/includes/wp-api-v3/_product-variations.md @@ -615,6 +615,7 @@ woocommerce.get("products/22/variations").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v3/_products.md b/source/includes/wp-api-v3/_products.md index fb9aad7c..8d7c33bd 100644 --- a/source/includes/wp-api-v3/_products.md +++ b/source/includes/wp-api-v3/_products.md @@ -1469,6 +1469,7 @@ woocommerce.get("products").parsed_response | `search` | string | Limit results to those matching a string. | | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | | `exclude` | array | Ensure result set excludes specific IDs. | | `include` | array | Limit result set to specific ids. | | `offset` | integer | Offset the result set by a specific number of items. | diff --git a/source/includes/wp-api-v3/_webhooks.md b/source/includes/wp-api-v3/_webhooks.md index a84d173b..eb135215 100644 --- a/source/includes/wp-api-v3/_webhooks.md +++ b/source/includes/wp-api-v3/_webhooks.md @@ -366,20 +366,21 @@ woocommerce.get("webhooks").parsed_response #### Available parameters #### -| Parameter | Type | Description | -| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | -| `page` | integer | Current page of the collection. Default is `1`. | -| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | -| `search` | string | Limit results to those matching a string. | -| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | -| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | -| `exclude` | array | Ensure result set excludes specific IDs. | -| `include` | array | Limit result set to specific ids. | -| `offset` | integer | Offset the result set by a specific number of items. | -| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | -| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | -| `status` | string | Limit result set to webhooks assigned a specific status. Options: `all`, `active`, `paused` and `disabled`. Default is `all`. | +| Parameter | Type | Description | +| --------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | +| `page` | integer | Current page of the collection. Default is `1`. | +| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | +| `search` | string | Limit results to those matching a string. | +| `after` | string | Limit response to resources published after a given ISO8601 compliant date. | +| `before` | string | Limit response to resources published before a given ISO8601 compliant date. | +| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. | +| `exclude` | array | Ensure result set excludes specific IDs. | +| `include` | array | Limit result set to specific ids. | +| `offset` | integer | Offset the result set by a specific number of items. | +| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | +| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. | +| `status` | string | Limit result set to webhooks assigned a specific status. Options: `all`, `active`, `paused` and `disabled`. Default is `all`. | ## Update a webhook ##