Skip to content

Commit e2897ac

Browse files
claudiosanchesclaudiosanches
committed
Fixed all docs for prices and amounts, closes #40 
1 parent 4f78cec commit e2897ac

File tree

11 files changed

+86
-86
lines changed

11 files changed

+86
-86
lines changed

Diff for: ‎source/includes/v2/_coupons.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This section lists all API that can be used to create, edit or otherwise manipul
55
## Coupon Properties ##
66

77
| Attribute | Type | Description |
8-
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------- |
8+
|--------------------------------|---------|----------------------------------------------------------------------------------------------------------------------------|
99
| `id` | integer | Coupon ID (post ID) <i class="label label-info">read-only</i> |
1010
| `code` | string | Coupon code, always lowercase <i class="label label-info">mandatory</i> |
1111
| `type` | string | Coupon type, valid core types are: `fixed_cart`, `percent`, `fixed_product` and `percent_product`. Default is `fixed_cart` |
1212
| `created_at` | string | UTC DateTime when the coupon was created <i class="label label-info">read-only</i> |
1313
| `updated_at` | string | UTC DateTime when the coupon was last updated <i class="label label-info">read-only</i> |
14-
| `amount` | float | The amount of discount |
14+
| `amount` | string | The amount of discount |
1515
| `individual_use` | boolean | Whether coupon can only be used individually |
1616
| `product_ids` | array | Array of product ID's the coupon can be used on |
1717
| `exclude_product_ids` | array | Array of product ID's the coupon cannot be used on |
@@ -24,8 +24,8 @@ This section lists all API that can be used to create, edit or otherwise manipul
2424
| `product_category_ids` | array | Array of category ID's the coupon applies to |
2525
| `exclude_product_category_ids` | array | Array of category ID's the coupon does not apply to |
2626
| `exclude_sale_items` | boolean | Exclude sale items from the coupon |
27-
| `minimum_amount` | float | Minimum order amount that needs to be in the cart before coupon applies |
28-
| `maximum_amount` | float | Maximum order amount allowed when using the coupon |
27+
| `minimum_amount` | string | Minimum order amount that needs to be in the cart before coupon applies |
28+
| `maximum_amount` | string | Maximum order amount allowed when using the coupon |
2929
| `customer_emails` | array | Array of email addresses that can use this coupon |
3030
| `description` | string | Coupon description |
3131

Diff for: ‎source/includes/v2/_orders.md

+25-25
Large diffs are not rendered by default.

Diff for: ‎source/includes/v2/_products.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This section lists all API that can be used to create, edit or otherwise manipul
55
## Products Properties ##
66

77
| Attribute | Type | Description |
8-
| ------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8+
|---------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
99
| `title` | string | Product name |
1010
| `id` | integer | Product ID (post ID) <i class="label label-info">read-only</i> |
1111
| `created_at` | string | UTC DateTime when the product was created <i class="label label-info">read-only</i> |
@@ -16,11 +16,11 @@ This section lists all API that can be used to create, edit or otherwise manipul
1616
| `virtual` | boolean | If the product is virtual or not. Virtual products are intangible and aren't shipped |
1717
| `permalink` | string | Product URL (post permalink) <i class="label label-info">read-only</i> |
1818
| `sku` | string | SKU refers to a Stock-keeping unit, a unique identifier for each distinct product and service that can be purchased |
19-
| `price` | float | Current product price. This is setted from `regular_price` and `sale_price` <i class="label label-info">read-only</i> |
20-
| `regular_price` | float | Product regular price |
21-
| `sale_price` | float | Product sale price |
22-
| `sale_price_dates_from` | float | Sets the sale start date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
23-
| `sale_price_dates_to` | float | Sets the sale end date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
19+
| `price` | string | Current product price. This is setted from `regular_price` and `sale_price` <i class="label label-info">read-only</i> |
20+
| `regular_price` | string | Product regular price |
21+
| `sale_price` | string | Product sale price |
22+
| `sale_price_dates_from` | string | Sets the sale start date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
23+
| `sale_price_dates_to` | string | Sets the sale end date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
2424
| `price_html` | string | Price formatted in HTML, e.g. `<del><span class=\"amount\">&#36;&nbsp;3.00</span></del> <ins><span class=\"amount\">&#36;&nbsp;2.00</span></ins>` <i class="label label-info">read-only</i> |
2525
| `taxable` | boolean | Show if the product is taxable or not <i class="label label-info">read-only</i> |
2626
| `tax_status` | string | Tax status. The options are: `taxable`, `shipping` (Shipping only) and `none` |
@@ -130,11 +130,11 @@ This section lists all API that can be used to create, edit or otherwise manipul
130130
| `virtual` | boolean | If the variation is virtual or not. Virtual variations are intangible and aren't shipped |
131131
| `permalink` | string | Variation URL (post permalink) <i class="label label-info">read-only</i> |
132132
| `sku` | string | SKU refers to a Stock-keeping unit, a unique identifier for each distinct product and service that can be purchased |
133-
| `price` | float | Current variation price. This is setted from `regular_price` and `sale_price` <i class="label label-info">read-only</i> |
134-
| `regular_price` | float | Variation regular price |
135-
| `sale_price` | float | Variation sale price |
136-
| `sale_price_dates_from` | float | Sets the sale start date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
137-
| `sale_price_dates_to` | float | Sets the sale end date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
133+
| `price` | string | Current variation price. This is setted from `regular_price` and `sale_price` <i class="label label-info">read-only</i> |
134+
| `regular_price` | string | Variation regular price |
135+
| `sale_price` | string | Variation sale price |
136+
| `sale_price_dates_from` | string | Sets the sale start date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
137+
| `sale_price_dates_to` | string | Sets the sale end date. Date in the `YYYY-MM-DD` format <i class="label label-info">write-only</i> |
138138
| `taxable` | boolean | Show if the variation is taxable or not <i class="label label-info">read-only</i> |
139139
| `tax_status` | string | Tax status. The options are: `taxable`, `shipping` (Shipping only) and `none` |
140140
| `tax_class` | string | Tax class |

Diff for: ‎source/includes/v3/_coupons.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This section lists all API endpoints that can be used to create, edit or otherwi
55
## Coupon Properties ##
66

77
| Attribute | Type | Description |
8-
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------- |
8+
|--------------------------------|---------|----------------------------------------------------------------------------------------------------------------------------|
99
| `id` | integer | Coupon ID (post ID) <i class="label label-info">read-only</i> |
1010
| `code` | string | Coupon code, always lowercase <i class="label label-info">mandatory</i> |
1111
| `type` | string | Coupon type, valid core types are: `fixed_cart`, `percent`, `fixed_product` and `percent_product`. Default is `fixed_cart` |
1212
| `created_at` | string | UTC DateTime when the coupon was created <i class="label label-info">read-only</i> |
1313
| `updated_at` | string | UTC DateTime when the coupon was last updated <i class="label label-info">read-only</i> |
14-
| `amount` | float | The amount of discount |
14+
| `amount` | string | The amount of discount |
1515
| `individual_use` | boolean | Whether coupon can only be used individually |
1616
| `product_ids` | array | Array of product ID's the coupon can be used on |
1717
| `exclude_product_ids` | array | Array of product ID's the coupon cannot be used on |
@@ -24,8 +24,8 @@ This section lists all API endpoints that can be used to create, edit or otherwi
2424
| `product_category_ids` | array | Array of category ID's the coupon applies to |
2525
| `exclude_product_category_ids` | array | Array of category ID's the coupon does not apply to |
2626
| `exclude_sale_items` | boolean | Exclude sale items from the coupon |
27-
| `minimum_amount` | float | Minimum order amount that needs to be in the cart before coupon applies |
28-
| `maximum_amount` | float | Maximum order amount allowed when using the coupon |
27+
| `minimum_amount` | string | Minimum order amount that needs to be in the cart before coupon applies |
28+
| `maximum_amount` | string | Maximum order amount allowed when using the coupon |
2929
| `customer_emails` | array | Array of email addresses that can use this coupon |
3030
| `description` | string | Coupon description |
3131

Diff for: ‎source/includes/v3/_order-refunds.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ This section lists all API endpoints that can be used to create, edit or otherwi
55
## Order Refunds Properties ##
66

77
| Attribute | Type | Description |
8-
| ------------ | ------- | ---------------------------------------------------------------------------------------- |
8+
|--------------|---------|------------------------------------------------------------------------------------------|
99
| `id` | integer | Order note ID <i class="label label-info">read-only</i> |
1010
| `created_at` | string | UTC DateTime when the order refund was created <i class="label label-info">read-only</i> |
11-
| `amount` | float | Refund amount <i class="label label-info">required</i> |
11+
| `amount` | string | Refund amount <i class="label label-info">required</i> |
1212
| `reason` | string | Reason for refund |
1313
| `line_items` | array | List of order items to refund. See [Line Items Properties](#line-items-properties) |
1414

0 commit comments

Comments
 (0)