Skip to content

Commit 7602d65

Browse files
authored
Merge pull request #193 from woocommerce/update/report
Update document to reflect sales report defaults to todays date if pe…
2 parents 9fff96a + 314e98e commit 7602d65

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

source/includes/wp-api-v1/_reports.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ woocommerce.get("reports/sales", query).parsed_response
194194
| `total_items` | integer | Total of items purchased. <i class="label label-info">read-only</i> |
195195
| `total_tax` | string | Total charged for taxes. <i class="label label-info">read-only</i> |
196196
| `total_shipping` | string | Total charged for shipping. <i class="label label-info">read-only</i> |
197-
| `total_refunds` | number | Total of refunded orders. <i class="label label-info">read-only</i> |
197+
| `total_refunds` | number | Total of refunded orders. <i class="label label-info">read-only</i> |
198198
| `total_discount` | integer | Total of coupons used. <i class="label label-info">read-only</i> |
199199
| `totals_grouped_by` | string | Group type. <i class="label label-info">read-only</i> |
200200
| `totals` | array | Totals. <i class="label label-info">read-only</i> |
@@ -204,7 +204,7 @@ woocommerce.get("reports/sales", query).parsed_response
204204
| Parameter | Type | Description |
205205
|------------|--------|-------------------------------------------------------------------------------------------------------------------|
206206
| `context` | string | Scope under which the request is made; determines fields present in response. Default is `view`. Options: `view`. |
207-
| `period` | string | Report period. Default is `week`. Options: `week`, `month`, `last_month` and `year` |
207+
| `period` | string | Report period. Default is today's date. Options: `week`, `month`, `last_month` and `year` |
208208
| `date_min` | string | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. |
209209
| `date_max` | string | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. |
210210

source/includes/wp-api-v2/_reports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ woocommerce.get("reports/sales", query).parsed_response
204204
| Parameter | Type | Description |
205205
|------------|--------|-------------------------------------------------------------------------------------------------------------------|
206206
| `context` | string | Scope under which the request is made; determines fields present in response. Default is `view`. Options: `view`. |
207-
| `period` | string | Report period. Default is `week`. Options: `week`, `month`, `last_month` and `year` |
207+
| `period` | string | Report period. Default is today's date. Options: `week`, `month`, `last_month` and `year` |
208208
| `date_min` | string | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. |
209209
| `date_max` | string | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. |
210210

source/includes/wp-api-v3/_reports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ woocommerce.get("reports/sales", query).parsed_response
332332
| Parameter | Type | Description |
333333
|------------|--------|-------------------------------------------------------------------------------------------------------------------|
334334
| `context` | string | Scope under which the request is made; determines fields present in response. Default is `view`. Options: `view`. |
335-
| `period` | string | Report period. Default is `week`. Options: `week`, `month`, `last_month` and `year` |
335+
| `period` | string | Report period. Default is today's date. Options: `week`, `month`, `last_month` and `year` |
336336
| `date_min` | string | Return sales for a specific start date, the date need to be in the YYYY-MM-DD format. |
337337
| `date_max` | string | Return sales for a specific end date, the date need to be in the YYYY-MM-DD format. |
338338

0 commit comments

Comments
 (0)