@commercelayer/cli-plugin-triggers 3.1.1 → 3.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +94 -90
- package/lib/commands/adyen_payment/details.js +2 -2
- package/lib/commands/adyen_payment/index.js +4 -4
- package/lib/commands/authorization/capture.js +2 -2
- package/lib/commands/authorization/capture_amount_cents.js +2 -2
- package/lib/commands/authorization/index.js +4 -4
- package/lib/commands/authorization/void.js +2 -2
- package/lib/commands/bundle/compute_compare_at_amount.js +2 -2
- package/lib/commands/bundle/compute_price_amount.js +2 -2
- package/lib/commands/bundle/index.js +4 -4
- package/lib/commands/capture/index.js +4 -4
- package/lib/commands/capture/refund.js +2 -2
- package/lib/commands/capture/refund_amount_cents.js +2 -2
- package/lib/commands/checkout_com_payment/details.js +2 -2
- package/lib/commands/checkout_com_payment/index.js +4 -4
- package/lib/commands/checkout_com_payment/refresh.js +2 -2
- package/lib/commands/customer_password_reset/index.js +4 -4
- package/lib/commands/customer_password_reset/reset_password_token.js +2 -2
- package/lib/commands/gift_card/activate.js +2 -2
- package/lib/commands/gift_card/balance_change_cents.js +2 -2
- package/lib/commands/gift_card/deactivate.js +2 -2
- package/lib/commands/gift_card/index.js +4 -4
- package/lib/commands/gift_card/purchase.js +2 -2
- package/lib/commands/in_stock_subscription/activate.js +2 -2
- package/lib/commands/in_stock_subscription/deactivate.js +2 -2
- package/lib/commands/in_stock_subscription/index.js +4 -4
- package/lib/commands/klarna_payment/index.js +4 -4
- package/lib/commands/klarna_payment/update.js +2 -2
- package/lib/commands/order/approve.js +2 -2
- package/lib/commands/order/approve_and_capture.js +2 -2
- package/lib/commands/order/archive.js +2 -2
- package/lib/commands/order/authorization_amount_cents.js +2 -2
- package/lib/commands/order/authorize.js +2 -2
- package/lib/commands/order/billing_address_clone_id.js +2 -2
- package/lib/commands/order/billing_address_same_as_shipping.js +2 -2
- package/lib/commands/order/cancel.js +2 -2
- package/lib/commands/order/capture.js +2 -2
- package/lib/commands/order/customer_payment_source_id.js +2 -2
- package/lib/commands/order/index.js +4 -4
- package/lib/commands/order/place.js +2 -2
- package/lib/commands/order/refresh.js +2 -2
- package/lib/commands/order/refund.js +2 -2
- package/lib/commands/order/save_billing_address_to_customer_address_book.js +2 -2
- package/lib/commands/order/save_payment_source_to_customer_wallet.js +2 -2
- package/lib/commands/order/save_shipping_address_to_customer_address_book.js +2 -2
- package/lib/commands/order/shipping_address_clone_id.js +2 -2
- package/lib/commands/order/shipping_address_same_as_billing.js +2 -2
- package/lib/commands/order/unarchive.js +2 -2
- package/lib/commands/order/update_taxes.js +2 -2
- package/lib/commands/order_subscription/activate.js +2 -2
- package/lib/commands/order_subscription/cancel.js +2 -2
- package/lib/commands/order_subscription/deactivate.js +2 -2
- package/lib/commands/order_subscription/index.js +4 -4
- package/lib/commands/return/approve.js +2 -2
- package/lib/commands/return/archive.js +2 -2
- package/lib/commands/return/cancel.js +2 -2
- package/lib/commands/return/index.js +4 -4
- package/lib/commands/return/receive.js +2 -2
- package/lib/commands/return/reject.js +2 -2
- package/lib/commands/return/request.js +2 -2
- package/lib/commands/return/restock.js +2 -2
- package/lib/commands/return/ship.js +2 -2
- package/lib/commands/return/unarchive.js +2 -2
- package/lib/commands/return_line_item/index.js +4 -4
- package/lib/commands/return_line_item/restock.js +2 -2
- package/lib/commands/shipment/get_rates.js +2 -2
- package/lib/commands/shipment/index.js +4 -4
- package/lib/commands/shipment/on_hold.js +2 -2
- package/lib/commands/shipment/packing.js +2 -2
- package/lib/commands/shipment/picking.js +2 -2
- package/lib/commands/shipment/purchase.js +2 -2
- package/lib/commands/shipment/ready_to_ship.js +2 -2
- package/lib/commands/shipment/ship.js +2 -2
- package/lib/commands/stock_transfer/cancel.js +2 -2
- package/lib/commands/stock_transfer/complete.js +2 -2
- package/lib/commands/stock_transfer/in_transit.js +2 -2
- package/lib/commands/stock_transfer/index.js +4 -4
- package/lib/commands/stock_transfer/picking.js +2 -2
- package/lib/commands/stock_transfer/upcoming.js +2 -2
- package/lib/commands/stripe_payment/index.js +4 -4
- package/lib/commands/stripe_payment/refresh.js +2 -2
- package/lib/commands/webhook/index.js +4 -4
- package/lib/commands/webhook/reset_circuit.js +2 -2
- package/lib/exec.js +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +9 -10
package/README.md
CHANGED
|
@@ -1,23 +1,27 @@
|
|
|
1
|
-
commercelayer-cli-plugin-triggers
|
|
2
|
-
=================================
|
|
1
|
+
# commercelayer-cli-plugin-triggers
|
|
3
2
|
|
|
4
3
|
Commerce Layer CLI Triggers plugin
|
|
5
4
|
|
|
6
5
|
[](https://oclif.io)
|
|
7
|
-
[](https://npmjs.org/package/@commercelayer/cli-plugin-triggers)
|
|
7
|
+
[](https://npmjs.org/package/@commercelayer/cli-plugin-triggers)
|
|
8
|
+
[](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/master/package.json)
|
|
10
9
|
|
|
11
10
|
<!-- toc -->
|
|
12
11
|
|
|
13
|
-
|
|
12
|
+
* [Usage](#usage)
|
|
13
|
+
* [Commands](#commands)
|
|
14
14
|
<!-- tocstop -->
|
|
15
|
-
|
|
15
|
+
## Usage
|
|
16
16
|
<!-- usage -->
|
|
17
17
|
|
|
18
|
+
```sh-session
|
|
19
|
+
$ commercelayer COMMAND
|
|
18
20
|
|
|
21
|
+
$ commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
|
|
22
|
+
```
|
|
19
23
|
<!-- usagestop -->
|
|
20
|
-
|
|
24
|
+
## Commands
|
|
21
25
|
<!-- commands -->
|
|
22
26
|
|
|
23
27
|
* [`commercelayer adyen_payment ID`](#commercelayer-adyen_payment-id)
|
|
@@ -107,7 +111,7 @@ Commerce Layer CLI Triggers plugin
|
|
|
107
111
|
|
|
108
112
|
Execute an action on a resource of type adyen_payments.
|
|
109
113
|
|
|
110
|
-
```
|
|
114
|
+
```sh-session
|
|
111
115
|
USAGE
|
|
112
116
|
$ commercelayer adyen_payment [ID] -o <value> [-u [-j -p]]
|
|
113
117
|
|
|
@@ -130,7 +134,7 @@ _See code: [src/commands/adyen_payment/index.ts](https://github.com/commercelaye
|
|
|
130
134
|
|
|
131
135
|
Send this attribute if you want to send additional details the payment request.
|
|
132
136
|
|
|
133
|
-
```
|
|
137
|
+
```sh-session
|
|
134
138
|
USAGE
|
|
135
139
|
$ commercelayer adyen_payment:details [ID] -o <value> [-u [-j -p]]
|
|
136
140
|
|
|
@@ -153,7 +157,7 @@ _See code: [src/commands/adyen_payment/details.ts](https://github.com/commercela
|
|
|
153
157
|
|
|
154
158
|
Execute an action on a resource of type authorizations.
|
|
155
159
|
|
|
156
|
-
```
|
|
160
|
+
```sh-session
|
|
157
161
|
USAGE
|
|
158
162
|
$ commercelayer authorization [ID] -o <value> [-u [-j -p]]
|
|
159
163
|
|
|
@@ -176,7 +180,7 @@ _See code: [src/commands/authorization/index.ts](https://github.com/commercelaye
|
|
|
176
180
|
|
|
177
181
|
Send this attribute if you want to create a capture for this authorization.
|
|
178
182
|
|
|
179
|
-
```
|
|
183
|
+
```sh-session
|
|
180
184
|
USAGE
|
|
181
185
|
$ commercelayer authorization:capture [ID] -o <value> [-u [-j -p]]
|
|
182
186
|
|
|
@@ -199,7 +203,7 @@ _See code: [src/commands/authorization/capture.ts](https://github.com/commercela
|
|
|
199
203
|
|
|
200
204
|
The associated capture amount, in cents.
|
|
201
205
|
|
|
202
|
-
```
|
|
206
|
+
```sh-session
|
|
203
207
|
USAGE
|
|
204
208
|
$ commercelayer authorization:capture_amount_cents [ID] -o <value> [-u [-j -p]]
|
|
205
209
|
|
|
@@ -222,7 +226,7 @@ _See code: [src/commands/authorization/capture_amount_cents.ts](https://github.c
|
|
|
222
226
|
|
|
223
227
|
Send this attribute if you want to create a void for this authorization.
|
|
224
228
|
|
|
225
|
-
```
|
|
229
|
+
```sh-session
|
|
226
230
|
USAGE
|
|
227
231
|
$ commercelayer authorization:void [ID] -o <value> [-u [-j -p]]
|
|
228
232
|
|
|
@@ -245,7 +249,7 @@ _See code: [src/commands/authorization/void.ts](https://github.com/commercelayer
|
|
|
245
249
|
|
|
246
250
|
Execute an action on a resource of type bundles.
|
|
247
251
|
|
|
248
|
-
```
|
|
252
|
+
```sh-session
|
|
249
253
|
USAGE
|
|
250
254
|
$ commercelayer bundle [ID] -o <value> [-u [-j -p]]
|
|
251
255
|
|
|
@@ -268,7 +272,7 @@ _See code: [src/commands/bundle/index.ts](https://github.com/commercelayer/comme
|
|
|
268
272
|
|
|
269
273
|
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market.
|
|
270
274
|
|
|
271
|
-
```
|
|
275
|
+
```sh-session
|
|
272
276
|
USAGE
|
|
273
277
|
$ commercelayer bundle:compute_compare_at_amount [ID] -o <value> [-u [-j -p]]
|
|
274
278
|
|
|
@@ -292,7 +296,7 @@ _See code: [src/commands/bundle/compute_compare_at_amount.ts](https://github.com
|
|
|
292
296
|
|
|
293
297
|
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market.
|
|
294
298
|
|
|
295
|
-
```
|
|
299
|
+
```sh-session
|
|
296
300
|
USAGE
|
|
297
301
|
$ commercelayer bundle:compute_price_amount [ID] -o <value> [-u [-j -p]]
|
|
298
302
|
|
|
@@ -316,7 +320,7 @@ _See code: [src/commands/bundle/compute_price_amount.ts](https://github.com/comm
|
|
|
316
320
|
|
|
317
321
|
Execute an action on a resource of type captures.
|
|
318
322
|
|
|
319
|
-
```
|
|
323
|
+
```sh-session
|
|
320
324
|
USAGE
|
|
321
325
|
$ commercelayer capture [ID] -o <value> [-u [-j -p]]
|
|
322
326
|
|
|
@@ -339,7 +343,7 @@ _See code: [src/commands/capture/index.ts](https://github.com/commercelayer/comm
|
|
|
339
343
|
|
|
340
344
|
Send this attribute if you want to create a refund for this capture.
|
|
341
345
|
|
|
342
|
-
```
|
|
346
|
+
```sh-session
|
|
343
347
|
USAGE
|
|
344
348
|
$ commercelayer capture:refund [ID] -o <value> [-u [-j -p]]
|
|
345
349
|
|
|
@@ -362,7 +366,7 @@ _See code: [src/commands/capture/refund.ts](https://github.com/commercelayer/com
|
|
|
362
366
|
|
|
363
367
|
The associated refund amount, in cents.
|
|
364
368
|
|
|
365
|
-
```
|
|
369
|
+
```sh-session
|
|
366
370
|
USAGE
|
|
367
371
|
$ commercelayer capture:refund_amount_cents [ID] -o <value> [-u [-j -p]]
|
|
368
372
|
|
|
@@ -385,7 +389,7 @@ _See code: [src/commands/capture/refund_amount_cents.ts](https://github.com/comm
|
|
|
385
389
|
|
|
386
390
|
Execute an action on a resource of type checkout_com_payments.
|
|
387
391
|
|
|
388
|
-
```
|
|
392
|
+
```sh-session
|
|
389
393
|
USAGE
|
|
390
394
|
$ commercelayer checkout_com_payment [ID] -o <value> [-u [-j -p]]
|
|
391
395
|
|
|
@@ -408,7 +412,7 @@ _See code: [src/commands/checkout_com_payment/index.ts](https://github.com/comme
|
|
|
408
412
|
|
|
409
413
|
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).
|
|
410
414
|
|
|
411
|
-
```
|
|
415
|
+
```sh-session
|
|
412
416
|
USAGE
|
|
413
417
|
$ commercelayer checkout_com_payment:details [ID] -o <value> [-u [-j -p]]
|
|
414
418
|
|
|
@@ -431,7 +435,7 @@ _See code: [src/commands/checkout_com_payment/details.ts](https://github.com/com
|
|
|
431
435
|
|
|
432
436
|
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.
|
|
433
437
|
|
|
434
|
-
```
|
|
438
|
+
```sh-session
|
|
435
439
|
USAGE
|
|
436
440
|
$ commercelayer checkout_com_payment:refresh [ID] -o <value> [-u [-j -p]]
|
|
437
441
|
|
|
@@ -454,7 +458,7 @@ _See code: [src/commands/checkout_com_payment/refresh.ts](https://github.com/com
|
|
|
454
458
|
|
|
455
459
|
Execute an action on a resource of type customer_password_resets.
|
|
456
460
|
|
|
457
|
-
```
|
|
461
|
+
```sh-session
|
|
458
462
|
USAGE
|
|
459
463
|
$ commercelayer customer_password_reset [ID] -o <value> [-u [-j -p]]
|
|
460
464
|
|
|
@@ -477,7 +481,7 @@ _See code: [src/commands/customer_password_reset/index.ts](https://github.com/co
|
|
|
477
481
|
|
|
478
482
|
Send the 'reset_password_token' that you got on create when updating the customer password.
|
|
479
483
|
|
|
480
|
-
```
|
|
484
|
+
```sh-session
|
|
481
485
|
USAGE
|
|
482
486
|
$ commercelayer customer_password_reset:reset_password_token [ID] -o <value> [-u [-j -p]]
|
|
483
487
|
|
|
@@ -500,7 +504,7 @@ _See code: [src/commands/customer_password_reset/reset_password_token.ts](https:
|
|
|
500
504
|
|
|
501
505
|
Execute an action on a resource of type gift_cards.
|
|
502
506
|
|
|
503
|
-
```
|
|
507
|
+
```sh-session
|
|
504
508
|
USAGE
|
|
505
509
|
$ commercelayer gift_card [ID] -o <value> [-u [-j -p]]
|
|
506
510
|
|
|
@@ -523,7 +527,7 @@ _See code: [src/commands/gift_card/index.ts](https://github.com/commercelayer/co
|
|
|
523
527
|
|
|
524
528
|
Send this attribute if you want to activate a gift card.
|
|
525
529
|
|
|
526
|
-
```
|
|
530
|
+
```sh-session
|
|
527
531
|
USAGE
|
|
528
532
|
$ commercelayer gift_card:activate [ID] -o <value> [-u [-j -p]]
|
|
529
533
|
|
|
@@ -546,7 +550,7 @@ _See code: [src/commands/gift_card/activate.ts](https://github.com/commercelayer
|
|
|
546
550
|
|
|
547
551
|
The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable).
|
|
548
552
|
|
|
549
|
-
```
|
|
553
|
+
```sh-session
|
|
550
554
|
USAGE
|
|
551
555
|
$ commercelayer gift_card:balance_change_cents [ID] -o <value> [-u [-j -p]]
|
|
552
556
|
|
|
@@ -570,7 +574,7 @@ _See code: [src/commands/gift_card/balance_change_cents.ts](https://github.com/c
|
|
|
570
574
|
|
|
571
575
|
Send this attribute if you want to deactivate a gift card.
|
|
572
576
|
|
|
573
|
-
```
|
|
577
|
+
```sh-session
|
|
574
578
|
USAGE
|
|
575
579
|
$ commercelayer gift_card:deactivate [ID] -o <value> [-u [-j -p]]
|
|
576
580
|
|
|
@@ -593,7 +597,7 @@ _See code: [src/commands/gift_card/deactivate.ts](https://github.com/commercelay
|
|
|
593
597
|
|
|
594
598
|
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.
|
|
595
599
|
|
|
596
|
-
```
|
|
600
|
+
```sh-session
|
|
597
601
|
USAGE
|
|
598
602
|
$ commercelayer gift_card:purchase [ID] -o <value> [-u [-j -p]]
|
|
599
603
|
|
|
@@ -617,7 +621,7 @@ _See code: [src/commands/gift_card/purchase.ts](https://github.com/commercelayer
|
|
|
617
621
|
|
|
618
622
|
Execute an action on a resource of type in_stock_subscriptions.
|
|
619
623
|
|
|
620
|
-
```
|
|
624
|
+
```sh-session
|
|
621
625
|
USAGE
|
|
622
626
|
$ commercelayer in_stock_subscription [ID] -o <value> [-u [-j -p]]
|
|
623
627
|
|
|
@@ -640,7 +644,7 @@ _See code: [src/commands/in_stock_subscription/index.ts](https://github.com/comm
|
|
|
640
644
|
|
|
641
645
|
Send this attribute if you want to activate an inactive subscription.
|
|
642
646
|
|
|
643
|
-
```
|
|
647
|
+
```sh-session
|
|
644
648
|
USAGE
|
|
645
649
|
$ commercelayer in_stock_subscription:activate [ID] -o <value> [-u [-j -p]]
|
|
646
650
|
|
|
@@ -663,7 +667,7 @@ _See code: [src/commands/in_stock_subscription/activate.ts](https://github.com/c
|
|
|
663
667
|
|
|
664
668
|
Send this attribute if you want to dactivate an active subscription.
|
|
665
669
|
|
|
666
|
-
```
|
|
670
|
+
```sh-session
|
|
667
671
|
USAGE
|
|
668
672
|
$ commercelayer in_stock_subscription:deactivate [ID] -o <value> [-u [-j -p]]
|
|
669
673
|
|
|
@@ -686,7 +690,7 @@ _See code: [src/commands/in_stock_subscription/deactivate.ts](https://github.com
|
|
|
686
690
|
|
|
687
691
|
Execute an action on a resource of type klarna_payments.
|
|
688
692
|
|
|
689
|
-
```
|
|
693
|
+
```sh-session
|
|
690
694
|
USAGE
|
|
691
695
|
$ commercelayer klarna_payment [ID] -o <value> [-u [-j -p]]
|
|
692
696
|
|
|
@@ -709,7 +713,7 @@ _See code: [src/commands/klarna_payment/index.ts](https://github.com/commercelay
|
|
|
709
713
|
|
|
710
714
|
Send this attribute if you want to update the payment session with fresh order data.
|
|
711
715
|
|
|
712
|
-
```
|
|
716
|
+
```sh-session
|
|
713
717
|
USAGE
|
|
714
718
|
$ commercelayer klarna_payment:update [ID] -o <value> [-u [-j -p]]
|
|
715
719
|
|
|
@@ -732,7 +736,7 @@ _See code: [src/commands/klarna_payment/update.ts](https://github.com/commercela
|
|
|
732
736
|
|
|
733
737
|
Execute an action on a resource of type orders.
|
|
734
738
|
|
|
735
|
-
```
|
|
739
|
+
```sh-session
|
|
736
740
|
USAGE
|
|
737
741
|
$ commercelayer order [ID] -o <value> [-u [-j -p]]
|
|
738
742
|
|
|
@@ -755,7 +759,7 @@ _See code: [src/commands/order/index.ts](https://github.com/commercelayer/commer
|
|
|
755
759
|
|
|
756
760
|
Send this attribute if you want to approve a placed order.
|
|
757
761
|
|
|
758
|
-
```
|
|
762
|
+
```sh-session
|
|
759
763
|
USAGE
|
|
760
764
|
$ commercelayer order:approve [ID] -o <value> [-u [-j -p]]
|
|
761
765
|
|
|
@@ -778,7 +782,7 @@ _See code: [src/commands/order/approve.ts](https://github.com/commercelayer/comm
|
|
|
778
782
|
|
|
779
783
|
Send this attribute if you want to approve and capture a placed order.
|
|
780
784
|
|
|
781
|
-
```
|
|
785
|
+
```sh-session
|
|
782
786
|
USAGE
|
|
783
787
|
$ commercelayer order:approve_and_capture [ID] -o <value> [-u [-j -p]]
|
|
784
788
|
|
|
@@ -801,7 +805,7 @@ _See code: [src/commands/order/approve_and_capture.ts](https://github.com/commer
|
|
|
801
805
|
|
|
802
806
|
Send this attribute if you want to archive the order.
|
|
803
807
|
|
|
804
|
-
```
|
|
808
|
+
```sh-session
|
|
805
809
|
USAGE
|
|
806
810
|
$ commercelayer order:archive [ID] -o <value> [-u [-j -p]]
|
|
807
811
|
|
|
@@ -824,7 +828,7 @@ _See code: [src/commands/order/archive.ts](https://github.com/commercelayer/comm
|
|
|
824
828
|
|
|
825
829
|
The authorization amount, in cents.
|
|
826
830
|
|
|
827
|
-
```
|
|
831
|
+
```sh-session
|
|
828
832
|
USAGE
|
|
829
833
|
$ commercelayer order:authorization_amount_cents [ID] -o <value> [-u [-j -p]]
|
|
830
834
|
|
|
@@ -847,7 +851,7 @@ _See code: [src/commands/order/authorization_amount_cents.ts](https://github.com
|
|
|
847
851
|
|
|
848
852
|
Send this attribute if you want to authorize the order's payment source.
|
|
849
853
|
|
|
850
|
-
```
|
|
854
|
+
```sh-session
|
|
851
855
|
USAGE
|
|
852
856
|
$ commercelayer order:authorize [ID] -o <value> [-u [-j -p]]
|
|
853
857
|
|
|
@@ -870,7 +874,7 @@ _See code: [src/commands/order/authorize.ts](https://github.com/commercelayer/co
|
|
|
870
874
|
|
|
871
875
|
The id of the address that you want to clone to create the order's billing address.
|
|
872
876
|
|
|
873
|
-
```
|
|
877
|
+
```sh-session
|
|
874
878
|
USAGE
|
|
875
879
|
$ commercelayer order:billing_address_clone_id [ID] -o <value> -v <value> [-u [-j -p]]
|
|
876
880
|
|
|
@@ -894,7 +898,7 @@ _See code: [src/commands/order/billing_address_clone_id.ts](https://github.com/c
|
|
|
894
898
|
|
|
895
899
|
Send this attribute if you want the billing address to be cloned from the order's shipping address.
|
|
896
900
|
|
|
897
|
-
```
|
|
901
|
+
```sh-session
|
|
898
902
|
USAGE
|
|
899
903
|
$ commercelayer order:billing_address_same_as_shipping [ID] -o <value> [-u [-j -p]]
|
|
900
904
|
|
|
@@ -917,7 +921,7 @@ _See code: [src/commands/order/billing_address_same_as_shipping.ts](https://gith
|
|
|
917
921
|
|
|
918
922
|
Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.
|
|
919
923
|
|
|
920
|
-
```
|
|
924
|
+
```sh-session
|
|
921
925
|
USAGE
|
|
922
926
|
$ commercelayer order:cancel [ID] -o <value> [-u [-j -p]]
|
|
923
927
|
|
|
@@ -940,7 +944,7 @@ _See code: [src/commands/order/cancel.ts](https://github.com/commercelayer/comme
|
|
|
940
944
|
|
|
941
945
|
Send this attribute if you want to capture an approved order.
|
|
942
946
|
|
|
943
|
-
```
|
|
947
|
+
```sh-session
|
|
944
948
|
USAGE
|
|
945
949
|
$ commercelayer order:capture [ID] -o <value> [-u [-j -p]]
|
|
946
950
|
|
|
@@ -963,7 +967,7 @@ _See code: [src/commands/order/capture.ts](https://github.com/commercelayer/comm
|
|
|
963
967
|
|
|
964
968
|
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.
|
|
965
969
|
|
|
966
|
-
```
|
|
970
|
+
```sh-session
|
|
967
971
|
USAGE
|
|
968
972
|
$ commercelayer order:customer_payment_source_id [ID] -o <value> -v <value> [-u [-j -p]]
|
|
969
973
|
|
|
@@ -987,7 +991,7 @@ _See code: [src/commands/order/customer_payment_source_id.ts](https://github.com
|
|
|
987
991
|
|
|
988
992
|
Send this attribute if you want to place the order.
|
|
989
993
|
|
|
990
|
-
```
|
|
994
|
+
```sh-session
|
|
991
995
|
USAGE
|
|
992
996
|
$ commercelayer order:place [ID] -o <value> [-u [-j -p]]
|
|
993
997
|
|
|
@@ -1010,7 +1014,7 @@ _See code: [src/commands/order/place.ts](https://github.com/commercelayer/commer
|
|
|
1010
1014
|
|
|
1011
1015
|
Send this attribute if you want to manually refresh the order.
|
|
1012
1016
|
|
|
1013
|
-
```
|
|
1017
|
+
```sh-session
|
|
1014
1018
|
USAGE
|
|
1015
1019
|
$ commercelayer order:refresh [ID] -o <value> [-u [-j -p]]
|
|
1016
1020
|
|
|
@@ -1033,7 +1037,7 @@ _See code: [src/commands/order/refresh.ts](https://github.com/commercelayer/comm
|
|
|
1033
1037
|
|
|
1034
1038
|
Send this attribute if you want to refund a captured order.
|
|
1035
1039
|
|
|
1036
|
-
```
|
|
1040
|
+
```sh-session
|
|
1037
1041
|
USAGE
|
|
1038
1042
|
$ commercelayer order:refund [ID] -o <value> [-u [-j -p]]
|
|
1039
1043
|
|
|
@@ -1056,7 +1060,7 @@ _See code: [src/commands/order/refund.ts](https://github.com/commercelayer/comme
|
|
|
1056
1060
|
|
|
1057
1061
|
Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.
|
|
1058
1062
|
|
|
1059
|
-
```
|
|
1063
|
+
```sh-session
|
|
1060
1064
|
USAGE
|
|
1061
1065
|
$ commercelayer order:save_billing_address_to_customer_address_book [ID] -o <value> [-u [-j -p]]
|
|
1062
1066
|
|
|
@@ -1080,7 +1084,7 @@ _See code: [src/commands/order/save_billing_address_to_customer_address_book.ts]
|
|
|
1080
1084
|
|
|
1081
1085
|
Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.
|
|
1082
1086
|
|
|
1083
|
-
```
|
|
1087
|
+
```sh-session
|
|
1084
1088
|
USAGE
|
|
1085
1089
|
$ commercelayer order:save_payment_source_to_customer_wallet [ID] -o <value> [-u [-j -p]]
|
|
1086
1090
|
|
|
@@ -1104,7 +1108,7 @@ _See code: [src/commands/order/save_payment_source_to_customer_wallet.ts](https:
|
|
|
1104
1108
|
|
|
1105
1109
|
Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.
|
|
1106
1110
|
|
|
1107
|
-
```
|
|
1111
|
+
```sh-session
|
|
1108
1112
|
USAGE
|
|
1109
1113
|
$ commercelayer order:save_shipping_address_to_customer_address_book [ID] -o <value> [-u [-j -p]]
|
|
1110
1114
|
|
|
@@ -1128,7 +1132,7 @@ _See code: [src/commands/order/save_shipping_address_to_customer_address_book.ts
|
|
|
1128
1132
|
|
|
1129
1133
|
The id of the address that you want to clone to create the order's shipping address.
|
|
1130
1134
|
|
|
1131
|
-
```
|
|
1135
|
+
```sh-session
|
|
1132
1136
|
USAGE
|
|
1133
1137
|
$ commercelayer order:shipping_address_clone_id [ID] -o <value> -v <value> [-u [-j -p]]
|
|
1134
1138
|
|
|
@@ -1152,7 +1156,7 @@ _See code: [src/commands/order/shipping_address_clone_id.ts](https://github.com/
|
|
|
1152
1156
|
|
|
1153
1157
|
Send this attribute if you want the shipping address to be cloned from the order's billing address.
|
|
1154
1158
|
|
|
1155
|
-
```
|
|
1159
|
+
```sh-session
|
|
1156
1160
|
USAGE
|
|
1157
1161
|
$ commercelayer order:shipping_address_same_as_billing [ID] -o <value> [-u [-j -p]]
|
|
1158
1162
|
|
|
@@ -1175,7 +1179,7 @@ _See code: [src/commands/order/shipping_address_same_as_billing.ts](https://gith
|
|
|
1175
1179
|
|
|
1176
1180
|
Send this attribute if you want to unarchive the order.
|
|
1177
1181
|
|
|
1178
|
-
```
|
|
1182
|
+
```sh-session
|
|
1179
1183
|
USAGE
|
|
1180
1184
|
$ commercelayer order:unarchive [ID] -o <value> [-u [-j -p]]
|
|
1181
1185
|
|
|
@@ -1198,7 +1202,7 @@ _See code: [src/commands/order/unarchive.ts](https://github.com/commercelayer/co
|
|
|
1198
1202
|
|
|
1199
1203
|
Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).
|
|
1200
1204
|
|
|
1201
|
-
```
|
|
1205
|
+
```sh-session
|
|
1202
1206
|
USAGE
|
|
1203
1207
|
$ commercelayer order:update_taxes [ID] -o <value> [-u [-j -p]]
|
|
1204
1208
|
|
|
@@ -1222,7 +1226,7 @@ _See code: [src/commands/order/update_taxes.ts](https://github.com/commercelayer
|
|
|
1222
1226
|
|
|
1223
1227
|
Execute an action on a resource of type order_subscriptions.
|
|
1224
1228
|
|
|
1225
|
-
```
|
|
1229
|
+
```sh-session
|
|
1226
1230
|
USAGE
|
|
1227
1231
|
$ commercelayer order_subscription [ID] -o <value> [-u [-j -p]]
|
|
1228
1232
|
|
|
@@ -1245,7 +1249,7 @@ _See code: [src/commands/order_subscription/index.ts](https://github.com/commerc
|
|
|
1245
1249
|
|
|
1246
1250
|
Send this attribute if you want to mark this subscription as active.
|
|
1247
1251
|
|
|
1248
|
-
```
|
|
1252
|
+
```sh-session
|
|
1249
1253
|
USAGE
|
|
1250
1254
|
$ commercelayer order_subscription:activate [ID] -o <value> [-u [-j -p]]
|
|
1251
1255
|
|
|
@@ -1268,7 +1272,7 @@ _See code: [src/commands/order_subscription/activate.ts](https://github.com/comm
|
|
|
1268
1272
|
|
|
1269
1273
|
Send this attribute if you want to mark this subscription as cancelled.
|
|
1270
1274
|
|
|
1271
|
-
```
|
|
1275
|
+
```sh-session
|
|
1272
1276
|
USAGE
|
|
1273
1277
|
$ commercelayer order_subscription:cancel [ID] -o <value> [-u [-j -p]]
|
|
1274
1278
|
|
|
@@ -1291,7 +1295,7 @@ _See code: [src/commands/order_subscription/cancel.ts](https://github.com/commer
|
|
|
1291
1295
|
|
|
1292
1296
|
Send this attribute if you want to mark this subscription as inactive.
|
|
1293
1297
|
|
|
1294
|
-
```
|
|
1298
|
+
```sh-session
|
|
1295
1299
|
USAGE
|
|
1296
1300
|
$ commercelayer order_subscription:deactivate [ID] -o <value> [-u [-j -p]]
|
|
1297
1301
|
|
|
@@ -1314,7 +1318,7 @@ _See code: [src/commands/order_subscription/deactivate.ts](https://github.com/co
|
|
|
1314
1318
|
|
|
1315
1319
|
Execute an action on a resource of type returns.
|
|
1316
1320
|
|
|
1317
|
-
```
|
|
1321
|
+
```sh-session
|
|
1318
1322
|
USAGE
|
|
1319
1323
|
$ commercelayer return [ID] -o <value> [-u [-j -p]]
|
|
1320
1324
|
|
|
@@ -1337,7 +1341,7 @@ _See code: [src/commands/return/index.ts](https://github.com/commercelayer/comme
|
|
|
1337
1341
|
|
|
1338
1342
|
Send this attribute if you want to mark this return as approved.
|
|
1339
1343
|
|
|
1340
|
-
```
|
|
1344
|
+
```sh-session
|
|
1341
1345
|
USAGE
|
|
1342
1346
|
$ commercelayer return:approve [ID] -o <value> [-u [-j -p]]
|
|
1343
1347
|
|
|
@@ -1360,7 +1364,7 @@ _See code: [src/commands/return/approve.ts](https://github.com/commercelayer/com
|
|
|
1360
1364
|
|
|
1361
1365
|
Send this attribute if you want to archive the return.
|
|
1362
1366
|
|
|
1363
|
-
```
|
|
1367
|
+
```sh-session
|
|
1364
1368
|
USAGE
|
|
1365
1369
|
$ commercelayer return:archive [ID] -o <value> [-u [-j -p]]
|
|
1366
1370
|
|
|
@@ -1383,7 +1387,7 @@ _See code: [src/commands/return/archive.ts](https://github.com/commercelayer/com
|
|
|
1383
1387
|
|
|
1384
1388
|
Send this attribute if you want to mark this return as cancelled.
|
|
1385
1389
|
|
|
1386
|
-
```
|
|
1390
|
+
```sh-session
|
|
1387
1391
|
USAGE
|
|
1388
1392
|
$ commercelayer return:cancel [ID] -o <value> [-u [-j -p]]
|
|
1389
1393
|
|
|
@@ -1406,7 +1410,7 @@ _See code: [src/commands/return/cancel.ts](https://github.com/commercelayer/comm
|
|
|
1406
1410
|
|
|
1407
1411
|
Send this attribute if you want to mark this return as received.
|
|
1408
1412
|
|
|
1409
|
-
```
|
|
1413
|
+
```sh-session
|
|
1410
1414
|
USAGE
|
|
1411
1415
|
$ commercelayer return:receive [ID] -o <value> [-u [-j -p]]
|
|
1412
1416
|
|
|
@@ -1429,7 +1433,7 @@ _See code: [src/commands/return/receive.ts](https://github.com/commercelayer/com
|
|
|
1429
1433
|
|
|
1430
1434
|
Send this attribute if you want to mark this return as rejected.
|
|
1431
1435
|
|
|
1432
|
-
```
|
|
1436
|
+
```sh-session
|
|
1433
1437
|
USAGE
|
|
1434
1438
|
$ commercelayer return:reject [ID] -o <value> [-u [-j -p]]
|
|
1435
1439
|
|
|
@@ -1452,7 +1456,7 @@ _See code: [src/commands/return/reject.ts](https://github.com/commercelayer/comm
|
|
|
1452
1456
|
|
|
1453
1457
|
Send this attribute if you want to activate this return.
|
|
1454
1458
|
|
|
1455
|
-
```
|
|
1459
|
+
```sh-session
|
|
1456
1460
|
USAGE
|
|
1457
1461
|
$ commercelayer return:request [ID] -o <value> [-u [-j -p]]
|
|
1458
1462
|
|
|
@@ -1475,7 +1479,7 @@ _See code: [src/commands/return/request.ts](https://github.com/commercelayer/com
|
|
|
1475
1479
|
|
|
1476
1480
|
Send this attribute if you want to restock all of the return line items.
|
|
1477
1481
|
|
|
1478
|
-
```
|
|
1482
|
+
```sh-session
|
|
1479
1483
|
USAGE
|
|
1480
1484
|
$ commercelayer return:restock [ID] -o <value> [-u [-j -p]]
|
|
1481
1485
|
|
|
@@ -1498,7 +1502,7 @@ _See code: [src/commands/return/restock.ts](https://github.com/commercelayer/com
|
|
|
1498
1502
|
|
|
1499
1503
|
Send this attribute if you want to mark this return as shipped.
|
|
1500
1504
|
|
|
1501
|
-
```
|
|
1505
|
+
```sh-session
|
|
1502
1506
|
USAGE
|
|
1503
1507
|
$ commercelayer return:ship [ID] -o <value> [-u [-j -p]]
|
|
1504
1508
|
|
|
@@ -1521,7 +1525,7 @@ _See code: [src/commands/return/ship.ts](https://github.com/commercelayer/commer
|
|
|
1521
1525
|
|
|
1522
1526
|
Send this attribute if you want to unarchive the return.
|
|
1523
1527
|
|
|
1524
|
-
```
|
|
1528
|
+
```sh-session
|
|
1525
1529
|
USAGE
|
|
1526
1530
|
$ commercelayer return:unarchive [ID] -o <value> [-u [-j -p]]
|
|
1527
1531
|
|
|
@@ -1544,7 +1548,7 @@ _See code: [src/commands/return/unarchive.ts](https://github.com/commercelayer/c
|
|
|
1544
1548
|
|
|
1545
1549
|
Execute an action on a resource of type return_line_items.
|
|
1546
1550
|
|
|
1547
|
-
```
|
|
1551
|
+
```sh-session
|
|
1548
1552
|
USAGE
|
|
1549
1553
|
$ commercelayer return_line_item [ID] -o <value> [-u [-j -p]]
|
|
1550
1554
|
|
|
@@ -1567,7 +1571,7 @@ _See code: [src/commands/return_line_item/index.ts](https://github.com/commercel
|
|
|
1567
1571
|
|
|
1568
1572
|
Send this attribute if you want to restock the line item.
|
|
1569
1573
|
|
|
1570
|
-
```
|
|
1574
|
+
```sh-session
|
|
1571
1575
|
USAGE
|
|
1572
1576
|
$ commercelayer return_line_item:restock [ID] -o <value> [-u [-j -p]]
|
|
1573
1577
|
|
|
@@ -1590,7 +1594,7 @@ _See code: [src/commands/return_line_item/restock.ts](https://github.com/commerc
|
|
|
1590
1594
|
|
|
1591
1595
|
Execute an action on a resource of type shipments.
|
|
1592
1596
|
|
|
1593
|
-
```
|
|
1597
|
+
```sh-session
|
|
1594
1598
|
USAGE
|
|
1595
1599
|
$ commercelayer shipment [ID] -o <value> [-u [-j -p]]
|
|
1596
1600
|
|
|
@@ -1613,7 +1617,7 @@ _See code: [src/commands/shipment/index.ts](https://github.com/commercelayer/com
|
|
|
1613
1617
|
|
|
1614
1618
|
Send this attribute if you want get the shipping rates from the associated carrier accounts.
|
|
1615
1619
|
|
|
1616
|
-
```
|
|
1620
|
+
```sh-session
|
|
1617
1621
|
USAGE
|
|
1618
1622
|
$ commercelayer shipment:get_rates [ID] -o <value> [-u [-j -p]]
|
|
1619
1623
|
|
|
@@ -1636,7 +1640,7 @@ _See code: [src/commands/shipment/get_rates.ts](https://github.com/commercelayer
|
|
|
1636
1640
|
|
|
1637
1641
|
Send this attribute if you want to put this shipment on hold.
|
|
1638
1642
|
|
|
1639
|
-
```
|
|
1643
|
+
```sh-session
|
|
1640
1644
|
USAGE
|
|
1641
1645
|
$ commercelayer shipment:on_hold [ID] -o <value> [-u [-j -p]]
|
|
1642
1646
|
|
|
@@ -1659,7 +1663,7 @@ _See code: [src/commands/shipment/on_hold.ts](https://github.com/commercelayer/c
|
|
|
1659
1663
|
|
|
1660
1664
|
Send this attribute if you want to start packing this shipment.
|
|
1661
1665
|
|
|
1662
|
-
```
|
|
1666
|
+
```sh-session
|
|
1663
1667
|
USAGE
|
|
1664
1668
|
$ commercelayer shipment:packing [ID] -o <value> [-u [-j -p]]
|
|
1665
1669
|
|
|
@@ -1682,7 +1686,7 @@ _See code: [src/commands/shipment/packing.ts](https://github.com/commercelayer/c
|
|
|
1682
1686
|
|
|
1683
1687
|
Send this attribute if you want to start picking this shipment.
|
|
1684
1688
|
|
|
1685
|
-
```
|
|
1689
|
+
```sh-session
|
|
1686
1690
|
USAGE
|
|
1687
1691
|
$ commercelayer shipment:picking [ID] -o <value> [-u [-j -p]]
|
|
1688
1692
|
|
|
@@ -1705,7 +1709,7 @@ _See code: [src/commands/shipment/picking.ts](https://github.com/commercelayer/c
|
|
|
1705
1709
|
|
|
1706
1710
|
Send this attribute if you want to purchase this shipment with the selected rate.
|
|
1707
1711
|
|
|
1708
|
-
```
|
|
1712
|
+
```sh-session
|
|
1709
1713
|
USAGE
|
|
1710
1714
|
$ commercelayer shipment:purchase [ID] -o <value> [-u [-j -p]]
|
|
1711
1715
|
|
|
@@ -1728,7 +1732,7 @@ _See code: [src/commands/shipment/purchase.ts](https://github.com/commercelayer/
|
|
|
1728
1732
|
|
|
1729
1733
|
Send this attribute if you want to mark this shipment as ready to ship.
|
|
1730
1734
|
|
|
1731
|
-
```
|
|
1735
|
+
```sh-session
|
|
1732
1736
|
USAGE
|
|
1733
1737
|
$ commercelayer shipment:ready_to_ship [ID] -o <value> [-u [-j -p]]
|
|
1734
1738
|
|
|
@@ -1751,7 +1755,7 @@ _See code: [src/commands/shipment/ready_to_ship.ts](https://github.com/commercel
|
|
|
1751
1755
|
|
|
1752
1756
|
Send this attribute if you want to mark this shipment as shipped.
|
|
1753
1757
|
|
|
1754
|
-
```
|
|
1758
|
+
```sh-session
|
|
1755
1759
|
USAGE
|
|
1756
1760
|
$ commercelayer shipment:ship [ID] -o <value> [-u [-j -p]]
|
|
1757
1761
|
|
|
@@ -1774,7 +1778,7 @@ _See code: [src/commands/shipment/ship.ts](https://github.com/commercelayer/comm
|
|
|
1774
1778
|
|
|
1775
1779
|
Execute an action on a resource of type stock_transfers.
|
|
1776
1780
|
|
|
1777
|
-
```
|
|
1781
|
+
```sh-session
|
|
1778
1782
|
USAGE
|
|
1779
1783
|
$ commercelayer stock_transfer [ID] -o <value> [-u [-j -p]]
|
|
1780
1784
|
|
|
@@ -1797,7 +1801,7 @@ _See code: [src/commands/stock_transfer/index.ts](https://github.com/commercelay
|
|
|
1797
1801
|
|
|
1798
1802
|
Send this attribute if you want to cancel this stock transfer.
|
|
1799
1803
|
|
|
1800
|
-
```
|
|
1804
|
+
```sh-session
|
|
1801
1805
|
USAGE
|
|
1802
1806
|
$ commercelayer stock_transfer:cancel [ID] -o <value> [-u [-j -p]]
|
|
1803
1807
|
|
|
@@ -1820,7 +1824,7 @@ _See code: [src/commands/stock_transfer/cancel.ts](https://github.com/commercela
|
|
|
1820
1824
|
|
|
1821
1825
|
Send this attribute if you want to complete this stock transfer.
|
|
1822
1826
|
|
|
1823
|
-
```
|
|
1827
|
+
```sh-session
|
|
1824
1828
|
USAGE
|
|
1825
1829
|
$ commercelayer stock_transfer:complete [ID] -o <value> [-u [-j -p]]
|
|
1826
1830
|
|
|
@@ -1843,7 +1847,7 @@ _See code: [src/commands/stock_transfer/complete.ts](https://github.com/commerce
|
|
|
1843
1847
|
|
|
1844
1848
|
Send this attribute if you want to mark this stock transfer as in transit.
|
|
1845
1849
|
|
|
1846
|
-
```
|
|
1850
|
+
```sh-session
|
|
1847
1851
|
USAGE
|
|
1848
1852
|
$ commercelayer stock_transfer:in_transit [ID] -o <value> [-u [-j -p]]
|
|
1849
1853
|
|
|
@@ -1866,7 +1870,7 @@ _See code: [src/commands/stock_transfer/in_transit.ts](https://github.com/commer
|
|
|
1866
1870
|
|
|
1867
1871
|
Send this attribute if you want to start picking this stock transfer.
|
|
1868
1872
|
|
|
1869
|
-
```
|
|
1873
|
+
```sh-session
|
|
1870
1874
|
USAGE
|
|
1871
1875
|
$ commercelayer stock_transfer:picking [ID] -o <value> [-u [-j -p]]
|
|
1872
1876
|
|
|
@@ -1889,7 +1893,7 @@ _See code: [src/commands/stock_transfer/picking.ts](https://github.com/commercel
|
|
|
1889
1893
|
|
|
1890
1894
|
Send this attribute if you want to mark this stock transfer as upcoming.
|
|
1891
1895
|
|
|
1892
|
-
```
|
|
1896
|
+
```sh-session
|
|
1893
1897
|
USAGE
|
|
1894
1898
|
$ commercelayer stock_transfer:upcoming [ID] -o <value> [-u [-j -p]]
|
|
1895
1899
|
|
|
@@ -1912,7 +1916,7 @@ _See code: [src/commands/stock_transfer/upcoming.ts](https://github.com/commerce
|
|
|
1912
1916
|
|
|
1913
1917
|
Execute an action on a resource of type stripe_payments.
|
|
1914
1918
|
|
|
1915
|
-
```
|
|
1919
|
+
```sh-session
|
|
1916
1920
|
USAGE
|
|
1917
1921
|
$ commercelayer stripe_payment [ID] -o <value> [-u [-j -p]]
|
|
1918
1922
|
|
|
@@ -1935,7 +1939,7 @@ _See code: [src/commands/stripe_payment/index.ts](https://github.com/commercelay
|
|
|
1935
1939
|
|
|
1936
1940
|
Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.
|
|
1937
1941
|
|
|
1938
|
-
```
|
|
1942
|
+
```sh-session
|
|
1939
1943
|
USAGE
|
|
1940
1944
|
$ commercelayer stripe_payment:refresh [ID] -o <value> [-u [-j -p]]
|
|
1941
1945
|
|
|
@@ -1958,7 +1962,7 @@ _See code: [src/commands/stripe_payment/refresh.ts](https://github.com/commercel
|
|
|
1958
1962
|
|
|
1959
1963
|
Execute an action on a resource of type webhooks.
|
|
1960
1964
|
|
|
1961
|
-
```
|
|
1965
|
+
```sh-session
|
|
1962
1966
|
USAGE
|
|
1963
1967
|
$ commercelayer webhook [ID] -o <value> [-u [-j -p]]
|
|
1964
1968
|
|
|
@@ -1981,7 +1985,7 @@ _See code: [src/commands/webhook/index.ts](https://github.com/commercelayer/comm
|
|
|
1981
1985
|
|
|
1982
1986
|
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.
|
|
1983
1987
|
|
|
1984
|
-
```
|
|
1988
|
+
```sh-session
|
|
1985
1989
|
USAGE
|
|
1986
1990
|
$ commercelayer webhook:reset_circuit [ID] -o <value> [-u [-j -p]]
|
|
1987
1991
|
|