Skip to content

Commit ae26320

Browse files
monikakustermonikakuster
committed
2317 - docs generated
1 parent 5121577 commit ae26320

File tree

1 file changed

+80
-20
lines changed

1 file changed

+80
-20
lines changed

‎docs/content/docs/reference/components/woocommerce.mdx

Lines changed: 80 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ WooCommerce is a e-commerce plugin for WordPress that allows you to turn a stand
99
Categories: E-commerce
1010

1111

12-
Type: wooCommerce/v1
12+
Type: woocommerce/v1
1313

1414
<hr />
1515

@@ -78,7 +78,7 @@ Name: createCoupon
7878
"minimum_amount" : "",
7979
"maximum_amount" : ""
8080
},
81-
"type" : "wooCommerce/v1/createCoupon"
81+
"type" : "woocommerce/v1/createCoupon"
8282
}
8383
```
8484

@@ -223,7 +223,7 @@ Name: createCustomer
223223
"phone" : ""
224224
}
225225
},
226-
"type" : "wooCommerce/v1/createCustomer"
226+
"type" : "woocommerce/v1/createCustomer"
227227
}
228228
```
229229

@@ -324,7 +324,13 @@ Name: createOrder
324324
| Name | Label | Type | Description | Required |
325325
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
326326
| customer_id | Customer Id | STRING | `User ID who owns the order. 0 for guests.` | true |
327-
| line_items | Line Items | ARRAY <details> <summary> Items </summary> [&#123;STRING\(product_id), INTEGER\(quantity)&#125;, STRING\($status), STRING\($customer_note), &#123;STRING\(first_name), STRING\(last_name), STRING\(company), STRING\(address_1), STRING\(address_2), STRING\(city), STRING\(state), STRING\(postcode), STRING\(country), STRING\(email), STRING\(phone)&#125;\($billing), &#123;STRING\(first_name), STRING\(last_name), STRING\(company), STRING\(address_1), STRING\(address_2), STRING\(city), STRING\(state), STRING\(postcode), STRING\(country), STRING\(phone)&#125;\($shipping), STRING\($payment_method), BOOLEAN\($set_paid)] </details> | `Line items data.` | true |
327+
| line_items | Line Items | ARRAY <details> <summary> Items </summary> [&#123;STRING\(product_id), INTEGER\(quantity)&#125;] </details> | `Line items data.` | true |
328+
| status | Status | STRING <details> <summary> Options </summary> pending, processing, on-hold, completed, cancelled, refunded, failed </details> | `Order status.` | false |
329+
| customer_note | Customer Note | STRING | `Note left by customer during checkout.` | false |
330+
| billing | Billing | OBJECT <details> <summary> Properties </summary> &#123;STRING\(first_name), STRING\(last_name), STRING\(company), STRING\(address_1), STRING\(address_2), STRING\(city), STRING\(state), STRING\(postcode), STRING\(country), STRING\(email), STRING\(phone)&#125; </details> | `List of billing address data.` | false |
331+
| shipping | Shipping | OBJECT <details> <summary> Properties </summary> &#123;STRING\(first_name), STRING\(last_name), STRING\(company), STRING\(address_1), STRING\(address_2), STRING\(city), STRING\(state), STRING\(postcode), STRING\(country), STRING\(phone)&#125; </details> | `List of shipping address data.` | false |
332+
| payment_method | Payment Method | STRING | `Payment method ID.` | false |
333+
| set_paid | Set Paid | BOOLEAN <details> <summary> Options </summary> true, false </details> | `Define if the order is paid. It will set the status to processing and reduce stock items.` | false |
328334

329335
#### Example JSON Structure
330336
```json
@@ -336,7 +342,10 @@ Name: createOrder
336342
"line_items" : [ {
337343
"product_id" : "",
338344
"quantity" : 1
339-
}, "", "", {
345+
} ],
346+
"status" : "",
347+
"customer_note" : "",
348+
"billing" : {
340349
"first_name" : "",
341350
"last_name" : "",
342351
"company" : "",
@@ -348,7 +357,8 @@ Name: createOrder
348357
"country" : "",
349358
"email" : "",
350359
"phone" : ""
351-
}, {
360+
},
361+
"shipping" : {
352362
"first_name" : "",
353363
"last_name" : "",
354364
"company" : "",
@@ -359,9 +369,11 @@ Name: createOrder
359369
"postcode" : "",
360370
"country" : "",
361371
"phone" : ""
362-
}, "", false ]
372+
},
373+
"payment_method" : "",
374+
"set_paid" : false
363375
},
364-
"type" : "wooCommerce/v1/createOrder"
376+
"type" : "woocommerce/v1/createOrder"
365377
}
366378
```
367379

@@ -573,7 +585,9 @@ Name: createProduct
573585
| stock_status | Stock Status | STRING <details> <summary> Options </summary> instock, outofstock, onbackorder </details> | `Controls the stock status of the product.` | false |
574586
| weight | Weight | STRING | `Product weight (kg).` | false |
575587
| dimensions | Dimensions | OBJECT <details> <summary> Properties </summary> &#123;STRING\(length), STRING\(width), STRING\(height)&#125; </details> | `Product dimensions.` | false |
576-
| categories | Categories | ARRAY <details> <summary> Items </summary> [&#123;INTEGER\(id)&#125;, [&#123;INTEGER\(id)&#125;, [&#123;STRING\(src), STRING\(name)&#125;]\($images)]\($tags)] </details> | `List of categories.` | false |
588+
| categories | Categories | ARRAY <details> <summary> Items </summary> [STRING] </details> | `List of categories.` | false |
589+
| tags | Tags | ARRAY <details> <summary> Items </summary> [STRING] </details> | `List of tags.` | false |
590+
| images | Images | ARRAY <details> <summary> Items </summary> [&#123;STRING\(src), STRING\(name)&#125;] </details> | `List of images.` | false |
577591

578592
#### Example JSON Structure
579593
```json
@@ -594,16 +608,14 @@ Name: createProduct
594608
"width" : "",
595609
"height" : ""
596610
},
597-
"categories" : [ {
598-
"id" : 1
599-
}, [ {
600-
"id" : 1
601-
}, [ {
611+
"categories" : [ "" ],
612+
"tags" : [ "" ],
613+
"images" : [ {
602614
"src" : "",
603615
"name" : ""
604-
} ] ] ]
616+
} ]
605617
},
606-
"type" : "wooCommerce/v1/createProduct"
618+
"type" : "woocommerce/v1/createProduct"
607619
}
608620
```
609621

@@ -823,14 +835,38 @@ Type: DYNAMIC_WEBHOOK
823835

824836
#### Output
825837

826-
This trigger does not produce any output.
838+
839+
840+
Type: OBJECT
841+
842+
843+
#### Properties
844+
845+
| Name | Type | Description |
846+
|:------------:|:------------:|:-------------------:|
847+
| id | INTEGER | Unique identifier for the resource. |
848+
| name | STRING | A friendly name for the webhook. |
849+
| status | STRING | Webhook status. |
850+
| topic | STRING | Webhook topic. |
851+
| resource | STRING | Webhook resource. |
852+
| event | STRING | Webhook event. |
853+
| hooks | ARRAY <details> <summary> Items </summary> [STRING] </details> | WooCommerce action names associated with the webhook. |
854+
| delivery_url | STRING | The URL where the webhook payload is delivered. |
855+
| date_created | STRING | The date the webhook was created, in the site's timezone. |
856+
| date_created_gmt | STRING | The date the webhook was created, as GMT. |
857+
| date_modified | STRING | The date the webhook was last modified, in the site's timezone. |
858+
| date_modified_gmt | STRING | The date the webhook was last modified, as GMT. |
859+
| _links | OBJECT <details> <summary> Properties </summary> &#123;[&#123;STRING\(href)&#125;]\(self), [&#123;STRING\(href)&#125;]\(collection)&#125; </details> | |
860+
861+
862+
827863

828864
#### JSON Example
829865
```json
830866
{
831867
"label" : "New Order",
832868
"name" : "newOrder",
833-
"type" : "wooCommerce/v1/newOrder"
869+
"type" : "woocommerce/v1/newOrder"
834870
}
835871
```
836872

@@ -845,14 +881,38 @@ Type: DYNAMIC_WEBHOOK
845881

846882
#### Output
847883

848-
This trigger does not produce any output.
884+
885+
886+
Type: OBJECT
887+
888+
889+
#### Properties
890+
891+
| Name | Type | Description |
892+
|:------------:|:------------:|:-------------------:|
893+
| id | INTEGER | Unique identifier for the resource. |
894+
| name | STRING | A friendly name for the webhook. |
895+
| status | STRING | Webhook status. |
896+
| topic | STRING | Webhook topic. |
897+
| resource | STRING | Webhook resource. |
898+
| event | STRING | Webhook event. |
899+
| hooks | ARRAY <details> <summary> Items </summary> [STRING] </details> | WooCommerce action names associated with the webhook. |
900+
| delivery_url | STRING | The URL where the webhook payload is delivered. |
901+
| date_created | STRING | The date the webhook was created, in the site's timezone. |
902+
| date_created_gmt | STRING | The date the webhook was created, as GMT. |
903+
| date_modified | STRING | The date the webhook was last modified, in the site's timezone. |
904+
| date_modified_gmt | STRING | The date the webhook was last modified, as GMT. |
905+
| _links | OBJECT <details> <summary> Properties </summary> &#123;[&#123;STRING\(href)&#125;]\(self), [&#123;STRING\(href)&#125;]\(collection)&#125; </details> | |
906+
907+
908+
849909

850910
#### JSON Example
851911
```json
852912
{
853913
"label" : "New Coupon",
854914
"name" : "newCoupon",
855-
"type" : "wooCommerce/v1/newCoupon"
915+
"type" : "woocommerce/v1/newCoupon"
856916
}
857917
```
858918

0 commit comments

Comments
 (0)