@commercelayer/cli-plugin-triggers 3.1.0 → 3.1.1
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 +65 -65
- package/oclif.manifest.json +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -128,7 +128,7 @@ _See code: [src/commands/adyen_payment/index.ts](https://github.com/commercelaye
|
|
|
128
128
|
|
|
129
129
|
### `commercelayer adyen_payment:details ID`
|
|
130
130
|
|
|
131
|
-
Send this attribute if you want to send additional details the payment request
|
|
131
|
+
Send this attribute if you want to send additional details the payment request.
|
|
132
132
|
|
|
133
133
|
```
|
|
134
134
|
USAGE
|
|
@@ -174,7 +174,7 @@ _See code: [src/commands/authorization/index.ts](https://github.com/commercelaye
|
|
|
174
174
|
|
|
175
175
|
### `commercelayer authorization:capture ID`
|
|
176
176
|
|
|
177
|
-
Send this attribute if you want to create a capture for this authorization
|
|
177
|
+
Send this attribute if you want to create a capture for this authorization.
|
|
178
178
|
|
|
179
179
|
```
|
|
180
180
|
USAGE
|
|
@@ -197,7 +197,7 @@ _See code: [src/commands/authorization/capture.ts](https://github.com/commercela
|
|
|
197
197
|
|
|
198
198
|
### `commercelayer authorization:capture_amount_cents ID`
|
|
199
199
|
|
|
200
|
-
The associated capture amount, in cents
|
|
200
|
+
The associated capture amount, in cents.
|
|
201
201
|
|
|
202
202
|
```
|
|
203
203
|
USAGE
|
|
@@ -220,7 +220,7 @@ _See code: [src/commands/authorization/capture_amount_cents.ts](https://github.c
|
|
|
220
220
|
|
|
221
221
|
### `commercelayer authorization:void ID`
|
|
222
222
|
|
|
223
|
-
Send this attribute if you want to create a void for this authorization
|
|
223
|
+
Send this attribute if you want to create a void for this authorization.
|
|
224
224
|
|
|
225
225
|
```
|
|
226
226
|
USAGE
|
|
@@ -266,7 +266,7 @@ _See code: [src/commands/bundle/index.ts](https://github.com/commercelayer/comme
|
|
|
266
266
|
|
|
267
267
|
### `commercelayer bundle:compute_compare_at_amount ID`
|
|
268
268
|
|
|
269
|
-
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
|
|
269
|
+
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
270
|
|
|
271
271
|
```
|
|
272
272
|
USAGE
|
|
@@ -290,7 +290,7 @@ _See code: [src/commands/bundle/compute_compare_at_amount.ts](https://github.com
|
|
|
290
290
|
|
|
291
291
|
### `commercelayer bundle:compute_price_amount ID`
|
|
292
292
|
|
|
293
|
-
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
|
|
293
|
+
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
294
|
|
|
295
295
|
```
|
|
296
296
|
USAGE
|
|
@@ -337,7 +337,7 @@ _See code: [src/commands/capture/index.ts](https://github.com/commercelayer/comm
|
|
|
337
337
|
|
|
338
338
|
### `commercelayer capture:refund ID`
|
|
339
339
|
|
|
340
|
-
Send this attribute if you want to create a refund for this capture
|
|
340
|
+
Send this attribute if you want to create a refund for this capture.
|
|
341
341
|
|
|
342
342
|
```
|
|
343
343
|
USAGE
|
|
@@ -360,7 +360,7 @@ _See code: [src/commands/capture/refund.ts](https://github.com/commercelayer/com
|
|
|
360
360
|
|
|
361
361
|
### `commercelayer capture:refund_amount_cents ID`
|
|
362
362
|
|
|
363
|
-
The associated refund amount, in cents
|
|
363
|
+
The associated refund amount, in cents.
|
|
364
364
|
|
|
365
365
|
```
|
|
366
366
|
USAGE
|
|
@@ -406,7 +406,7 @@ _See code: [src/commands/checkout_com_payment/index.ts](https://github.com/comme
|
|
|
406
406
|
|
|
407
407
|
### `commercelayer checkout_com_payment:details ID`
|
|
408
408
|
|
|
409
|
-
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check)
|
|
409
|
+
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).
|
|
410
410
|
|
|
411
411
|
```
|
|
412
412
|
USAGE
|
|
@@ -429,7 +429,7 @@ _See code: [src/commands/checkout_com_payment/details.ts](https://github.com/com
|
|
|
429
429
|
|
|
430
430
|
### `commercelayer checkout_com_payment:refresh ID`
|
|
431
431
|
|
|
432
|
-
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic
|
|
432
|
+
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.
|
|
433
433
|
|
|
434
434
|
```
|
|
435
435
|
USAGE
|
|
@@ -475,7 +475,7 @@ _See code: [src/commands/customer_password_reset/index.ts](https://github.com/co
|
|
|
475
475
|
|
|
476
476
|
### `commercelayer customer_password_reset:reset_password_token ID`
|
|
477
477
|
|
|
478
|
-
Send the 'reset_password_token' that you got on create when updating the customer password
|
|
478
|
+
Send the 'reset_password_token' that you got on create when updating the customer password.
|
|
479
479
|
|
|
480
480
|
```
|
|
481
481
|
USAGE
|
|
@@ -521,7 +521,7 @@ _See code: [src/commands/gift_card/index.ts](https://github.com/commercelayer/co
|
|
|
521
521
|
|
|
522
522
|
### `commercelayer gift_card:activate ID`
|
|
523
523
|
|
|
524
|
-
Send this attribute if you want to activate a gift card
|
|
524
|
+
Send this attribute if you want to activate a gift card.
|
|
525
525
|
|
|
526
526
|
```
|
|
527
527
|
USAGE
|
|
@@ -544,7 +544,7 @@ _See code: [src/commands/gift_card/activate.ts](https://github.com/commercelayer
|
|
|
544
544
|
|
|
545
545
|
### `commercelayer gift_card:balance_change_cents ID`
|
|
546
546
|
|
|
547
|
-
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)
|
|
547
|
+
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
548
|
|
|
549
549
|
```
|
|
550
550
|
USAGE
|
|
@@ -568,7 +568,7 @@ _See code: [src/commands/gift_card/balance_change_cents.ts](https://github.com/c
|
|
|
568
568
|
|
|
569
569
|
### `commercelayer gift_card:deactivate ID`
|
|
570
570
|
|
|
571
|
-
Send this attribute if you want to deactivate a gift card
|
|
571
|
+
Send this attribute if you want to deactivate a gift card.
|
|
572
572
|
|
|
573
573
|
```
|
|
574
574
|
USAGE
|
|
@@ -591,7 +591,7 @@ _See code: [src/commands/gift_card/deactivate.ts](https://github.com/commercelay
|
|
|
591
591
|
|
|
592
592
|
### `commercelayer gift_card:purchase ID`
|
|
593
593
|
|
|
594
|
-
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated
|
|
594
|
+
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.
|
|
595
595
|
|
|
596
596
|
```
|
|
597
597
|
USAGE
|
|
@@ -638,7 +638,7 @@ _See code: [src/commands/in_stock_subscription/index.ts](https://github.com/comm
|
|
|
638
638
|
|
|
639
639
|
### `commercelayer in_stock_subscription:activate ID`
|
|
640
640
|
|
|
641
|
-
Send this attribute if you want to activate an inactive subscription
|
|
641
|
+
Send this attribute if you want to activate an inactive subscription.
|
|
642
642
|
|
|
643
643
|
```
|
|
644
644
|
USAGE
|
|
@@ -661,7 +661,7 @@ _See code: [src/commands/in_stock_subscription/activate.ts](https://github.com/c
|
|
|
661
661
|
|
|
662
662
|
### `commercelayer in_stock_subscription:deactivate ID`
|
|
663
663
|
|
|
664
|
-
Send this attribute if you want to dactivate an active subscription
|
|
664
|
+
Send this attribute if you want to dactivate an active subscription.
|
|
665
665
|
|
|
666
666
|
```
|
|
667
667
|
USAGE
|
|
@@ -707,7 +707,7 @@ _See code: [src/commands/klarna_payment/index.ts](https://github.com/commercelay
|
|
|
707
707
|
|
|
708
708
|
### `commercelayer klarna_payment:update ID`
|
|
709
709
|
|
|
710
|
-
Send this attribute if you want to update the payment session with fresh order data
|
|
710
|
+
Send this attribute if you want to update the payment session with fresh order data.
|
|
711
711
|
|
|
712
712
|
```
|
|
713
713
|
USAGE
|
|
@@ -753,7 +753,7 @@ _See code: [src/commands/order/index.ts](https://github.com/commercelayer/commer
|
|
|
753
753
|
|
|
754
754
|
### `commercelayer order:approve ID`
|
|
755
755
|
|
|
756
|
-
Send this attribute if you want to approve a placed order
|
|
756
|
+
Send this attribute if you want to approve a placed order.
|
|
757
757
|
|
|
758
758
|
```
|
|
759
759
|
USAGE
|
|
@@ -776,7 +776,7 @@ _See code: [src/commands/order/approve.ts](https://github.com/commercelayer/comm
|
|
|
776
776
|
|
|
777
777
|
### `commercelayer order:approve_and_capture ID`
|
|
778
778
|
|
|
779
|
-
Send this attribute if you want to approve and capture a placed order
|
|
779
|
+
Send this attribute if you want to approve and capture a placed order.
|
|
780
780
|
|
|
781
781
|
```
|
|
782
782
|
USAGE
|
|
@@ -799,7 +799,7 @@ _See code: [src/commands/order/approve_and_capture.ts](https://github.com/commer
|
|
|
799
799
|
|
|
800
800
|
### `commercelayer order:archive ID`
|
|
801
801
|
|
|
802
|
-
Send this attribute if you want to archive the order
|
|
802
|
+
Send this attribute if you want to archive the order.
|
|
803
803
|
|
|
804
804
|
```
|
|
805
805
|
USAGE
|
|
@@ -822,7 +822,7 @@ _See code: [src/commands/order/archive.ts](https://github.com/commercelayer/comm
|
|
|
822
822
|
|
|
823
823
|
### `commercelayer order:authorization_amount_cents ID`
|
|
824
824
|
|
|
825
|
-
The authorization amount, in cents
|
|
825
|
+
The authorization amount, in cents.
|
|
826
826
|
|
|
827
827
|
```
|
|
828
828
|
USAGE
|
|
@@ -845,7 +845,7 @@ _See code: [src/commands/order/authorization_amount_cents.ts](https://github.com
|
|
|
845
845
|
|
|
846
846
|
### `commercelayer order:authorize ID`
|
|
847
847
|
|
|
848
|
-
Send this attribute if you want to authorize the order's payment source
|
|
848
|
+
Send this attribute if you want to authorize the order's payment source.
|
|
849
849
|
|
|
850
850
|
```
|
|
851
851
|
USAGE
|
|
@@ -868,7 +868,7 @@ _See code: [src/commands/order/authorize.ts](https://github.com/commercelayer/co
|
|
|
868
868
|
|
|
869
869
|
### `commercelayer order:billing_address_clone_id ID`
|
|
870
870
|
|
|
871
|
-
The id of the address that you want to clone to create the order's billing address
|
|
871
|
+
The id of the address that you want to clone to create the order's billing address.
|
|
872
872
|
|
|
873
873
|
```
|
|
874
874
|
USAGE
|
|
@@ -892,7 +892,7 @@ _See code: [src/commands/order/billing_address_clone_id.ts](https://github.com/c
|
|
|
892
892
|
|
|
893
893
|
### `commercelayer order:billing_address_same_as_shipping ID`
|
|
894
894
|
|
|
895
|
-
Send this attribute if you want the billing address to be cloned from the order's shipping address
|
|
895
|
+
Send this attribute if you want the billing address to be cloned from the order's shipping address.
|
|
896
896
|
|
|
897
897
|
```
|
|
898
898
|
USAGE
|
|
@@ -915,7 +915,7 @@ _See code: [src/commands/order/billing_address_same_as_shipping.ts](https://gith
|
|
|
915
915
|
|
|
916
916
|
### `commercelayer order:cancel ID`
|
|
917
917
|
|
|
918
|
-
Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided
|
|
918
|
+
Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.
|
|
919
919
|
|
|
920
920
|
```
|
|
921
921
|
USAGE
|
|
@@ -938,7 +938,7 @@ _See code: [src/commands/order/cancel.ts](https://github.com/commercelayer/comme
|
|
|
938
938
|
|
|
939
939
|
### `commercelayer order:capture ID`
|
|
940
940
|
|
|
941
|
-
Send this attribute if you want to capture an approved order
|
|
941
|
+
Send this attribute if you want to capture an approved order.
|
|
942
942
|
|
|
943
943
|
```
|
|
944
944
|
USAGE
|
|
@@ -961,7 +961,7 @@ _See code: [src/commands/order/capture.ts](https://github.com/commercelayer/comm
|
|
|
961
961
|
|
|
962
962
|
### `commercelayer order:customer_payment_source_id ID`
|
|
963
963
|
|
|
964
|
-
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source
|
|
964
|
+
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.
|
|
965
965
|
|
|
966
966
|
```
|
|
967
967
|
USAGE
|
|
@@ -985,7 +985,7 @@ _See code: [src/commands/order/customer_payment_source_id.ts](https://github.com
|
|
|
985
985
|
|
|
986
986
|
### `commercelayer order:place ID`
|
|
987
987
|
|
|
988
|
-
Send this attribute if you want to place the order
|
|
988
|
+
Send this attribute if you want to place the order.
|
|
989
989
|
|
|
990
990
|
```
|
|
991
991
|
USAGE
|
|
@@ -1008,7 +1008,7 @@ _See code: [src/commands/order/place.ts](https://github.com/commercelayer/commer
|
|
|
1008
1008
|
|
|
1009
1009
|
### `commercelayer order:refresh ID`
|
|
1010
1010
|
|
|
1011
|
-
Send this attribute if you want to manually refresh the order
|
|
1011
|
+
Send this attribute if you want to manually refresh the order.
|
|
1012
1012
|
|
|
1013
1013
|
```
|
|
1014
1014
|
USAGE
|
|
@@ -1031,7 +1031,7 @@ _See code: [src/commands/order/refresh.ts](https://github.com/commercelayer/comm
|
|
|
1031
1031
|
|
|
1032
1032
|
### `commercelayer order:refund ID`
|
|
1033
1033
|
|
|
1034
|
-
Send this attribute if you want to refund a captured order
|
|
1034
|
+
Send this attribute if you want to refund a captured order.
|
|
1035
1035
|
|
|
1036
1036
|
```
|
|
1037
1037
|
USAGE
|
|
@@ -1054,7 +1054,7 @@ _See code: [src/commands/order/refund.ts](https://github.com/commercelayer/comme
|
|
|
1054
1054
|
|
|
1055
1055
|
### `commercelayer order:save_billing_address_to_customer_address_book ID`
|
|
1056
1056
|
|
|
1057
|
-
Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address
|
|
1057
|
+
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
1058
|
|
|
1059
1059
|
```
|
|
1060
1060
|
USAGE
|
|
@@ -1078,7 +1078,7 @@ _See code: [src/commands/order/save_billing_address_to_customer_address_book.ts]
|
|
|
1078
1078
|
|
|
1079
1079
|
### `commercelayer order:save_payment_source_to_customer_wallet ID`
|
|
1080
1080
|
|
|
1081
|
-
Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source
|
|
1081
|
+
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
1082
|
|
|
1083
1083
|
```
|
|
1084
1084
|
USAGE
|
|
@@ -1102,7 +1102,7 @@ _See code: [src/commands/order/save_payment_source_to_customer_wallet.ts](https:
|
|
|
1102
1102
|
|
|
1103
1103
|
### `commercelayer order:save_shipping_address_to_customer_address_book ID`
|
|
1104
1104
|
|
|
1105
|
-
Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address
|
|
1105
|
+
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
1106
|
|
|
1107
1107
|
```
|
|
1108
1108
|
USAGE
|
|
@@ -1126,7 +1126,7 @@ _See code: [src/commands/order/save_shipping_address_to_customer_address_book.ts
|
|
|
1126
1126
|
|
|
1127
1127
|
### `commercelayer order:shipping_address_clone_id ID`
|
|
1128
1128
|
|
|
1129
|
-
The id of the address that you want to clone to create the order's shipping address
|
|
1129
|
+
The id of the address that you want to clone to create the order's shipping address.
|
|
1130
1130
|
|
|
1131
1131
|
```
|
|
1132
1132
|
USAGE
|
|
@@ -1150,7 +1150,7 @@ _See code: [src/commands/order/shipping_address_clone_id.ts](https://github.com/
|
|
|
1150
1150
|
|
|
1151
1151
|
### `commercelayer order:shipping_address_same_as_billing ID`
|
|
1152
1152
|
|
|
1153
|
-
Send this attribute if you want the shipping address to be cloned from the order's billing address
|
|
1153
|
+
Send this attribute if you want the shipping address to be cloned from the order's billing address.
|
|
1154
1154
|
|
|
1155
1155
|
```
|
|
1156
1156
|
USAGE
|
|
@@ -1173,7 +1173,7 @@ _See code: [src/commands/order/shipping_address_same_as_billing.ts](https://gith
|
|
|
1173
1173
|
|
|
1174
1174
|
### `commercelayer order:unarchive ID`
|
|
1175
1175
|
|
|
1176
|
-
Send this attribute if you want to unarchive the order
|
|
1176
|
+
Send this attribute if you want to unarchive the order.
|
|
1177
1177
|
|
|
1178
1178
|
```
|
|
1179
1179
|
USAGE
|
|
@@ -1196,7 +1196,7 @@ _See code: [src/commands/order/unarchive.ts](https://github.com/commercelayer/co
|
|
|
1196
1196
|
|
|
1197
1197
|
### `commercelayer order:update_taxes ID`
|
|
1198
1198
|
|
|
1199
|
-
Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market)
|
|
1199
|
+
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
1200
|
|
|
1201
1201
|
```
|
|
1202
1202
|
USAGE
|
|
@@ -1243,7 +1243,7 @@ _See code: [src/commands/order_subscription/index.ts](https://github.com/commerc
|
|
|
1243
1243
|
|
|
1244
1244
|
### `commercelayer order_subscription:activate ID`
|
|
1245
1245
|
|
|
1246
|
-
Send this attribute if you want to mark this subscription as active
|
|
1246
|
+
Send this attribute if you want to mark this subscription as active.
|
|
1247
1247
|
|
|
1248
1248
|
```
|
|
1249
1249
|
USAGE
|
|
@@ -1266,7 +1266,7 @@ _See code: [src/commands/order_subscription/activate.ts](https://github.com/comm
|
|
|
1266
1266
|
|
|
1267
1267
|
### `commercelayer order_subscription:cancel ID`
|
|
1268
1268
|
|
|
1269
|
-
Send this attribute if you want to mark this subscription as cancelled
|
|
1269
|
+
Send this attribute if you want to mark this subscription as cancelled.
|
|
1270
1270
|
|
|
1271
1271
|
```
|
|
1272
1272
|
USAGE
|
|
@@ -1289,7 +1289,7 @@ _See code: [src/commands/order_subscription/cancel.ts](https://github.com/commer
|
|
|
1289
1289
|
|
|
1290
1290
|
### `commercelayer order_subscription:deactivate ID`
|
|
1291
1291
|
|
|
1292
|
-
Send this attribute if you want to mark this subscription as inactive
|
|
1292
|
+
Send this attribute if you want to mark this subscription as inactive.
|
|
1293
1293
|
|
|
1294
1294
|
```
|
|
1295
1295
|
USAGE
|
|
@@ -1335,7 +1335,7 @@ _See code: [src/commands/return/index.ts](https://github.com/commercelayer/comme
|
|
|
1335
1335
|
|
|
1336
1336
|
### `commercelayer return:approve ID`
|
|
1337
1337
|
|
|
1338
|
-
Send this attribute if you want to mark this return as approved
|
|
1338
|
+
Send this attribute if you want to mark this return as approved.
|
|
1339
1339
|
|
|
1340
1340
|
```
|
|
1341
1341
|
USAGE
|
|
@@ -1358,7 +1358,7 @@ _See code: [src/commands/return/approve.ts](https://github.com/commercelayer/com
|
|
|
1358
1358
|
|
|
1359
1359
|
### `commercelayer return:archive ID`
|
|
1360
1360
|
|
|
1361
|
-
Send this attribute if you want to archive the return
|
|
1361
|
+
Send this attribute if you want to archive the return.
|
|
1362
1362
|
|
|
1363
1363
|
```
|
|
1364
1364
|
USAGE
|
|
@@ -1381,7 +1381,7 @@ _See code: [src/commands/return/archive.ts](https://github.com/commercelayer/com
|
|
|
1381
1381
|
|
|
1382
1382
|
### `commercelayer return:cancel ID`
|
|
1383
1383
|
|
|
1384
|
-
Send this attribute if you want to mark this return as cancelled
|
|
1384
|
+
Send this attribute if you want to mark this return as cancelled.
|
|
1385
1385
|
|
|
1386
1386
|
```
|
|
1387
1387
|
USAGE
|
|
@@ -1404,7 +1404,7 @@ _See code: [src/commands/return/cancel.ts](https://github.com/commercelayer/comm
|
|
|
1404
1404
|
|
|
1405
1405
|
### `commercelayer return:receive ID`
|
|
1406
1406
|
|
|
1407
|
-
Send this attribute if you want to mark this return as received
|
|
1407
|
+
Send this attribute if you want to mark this return as received.
|
|
1408
1408
|
|
|
1409
1409
|
```
|
|
1410
1410
|
USAGE
|
|
@@ -1427,7 +1427,7 @@ _See code: [src/commands/return/receive.ts](https://github.com/commercelayer/com
|
|
|
1427
1427
|
|
|
1428
1428
|
### `commercelayer return:reject ID`
|
|
1429
1429
|
|
|
1430
|
-
Send this attribute if you want to mark this return as rejected
|
|
1430
|
+
Send this attribute if you want to mark this return as rejected.
|
|
1431
1431
|
|
|
1432
1432
|
```
|
|
1433
1433
|
USAGE
|
|
@@ -1450,7 +1450,7 @@ _See code: [src/commands/return/reject.ts](https://github.com/commercelayer/comm
|
|
|
1450
1450
|
|
|
1451
1451
|
### `commercelayer return:request ID`
|
|
1452
1452
|
|
|
1453
|
-
Send this attribute if you want to activate this return
|
|
1453
|
+
Send this attribute if you want to activate this return.
|
|
1454
1454
|
|
|
1455
1455
|
```
|
|
1456
1456
|
USAGE
|
|
@@ -1473,7 +1473,7 @@ _See code: [src/commands/return/request.ts](https://github.com/commercelayer/com
|
|
|
1473
1473
|
|
|
1474
1474
|
### `commercelayer return:restock ID`
|
|
1475
1475
|
|
|
1476
|
-
Send this attribute if you want to restock all of the return line items
|
|
1476
|
+
Send this attribute if you want to restock all of the return line items.
|
|
1477
1477
|
|
|
1478
1478
|
```
|
|
1479
1479
|
USAGE
|
|
@@ -1496,7 +1496,7 @@ _See code: [src/commands/return/restock.ts](https://github.com/commercelayer/com
|
|
|
1496
1496
|
|
|
1497
1497
|
### `commercelayer return:ship ID`
|
|
1498
1498
|
|
|
1499
|
-
Send this attribute if you want to mark this return as shipped
|
|
1499
|
+
Send this attribute if you want to mark this return as shipped.
|
|
1500
1500
|
|
|
1501
1501
|
```
|
|
1502
1502
|
USAGE
|
|
@@ -1519,7 +1519,7 @@ _See code: [src/commands/return/ship.ts](https://github.com/commercelayer/commer
|
|
|
1519
1519
|
|
|
1520
1520
|
### `commercelayer return:unarchive ID`
|
|
1521
1521
|
|
|
1522
|
-
Send this attribute if you want to unarchive the return
|
|
1522
|
+
Send this attribute if you want to unarchive the return.
|
|
1523
1523
|
|
|
1524
1524
|
```
|
|
1525
1525
|
USAGE
|
|
@@ -1565,7 +1565,7 @@ _See code: [src/commands/return_line_item/index.ts](https://github.com/commercel
|
|
|
1565
1565
|
|
|
1566
1566
|
### `commercelayer return_line_item:restock ID`
|
|
1567
1567
|
|
|
1568
|
-
Send this attribute if you want to restock the line item
|
|
1568
|
+
Send this attribute if you want to restock the line item.
|
|
1569
1569
|
|
|
1570
1570
|
```
|
|
1571
1571
|
USAGE
|
|
@@ -1611,7 +1611,7 @@ _See code: [src/commands/shipment/index.ts](https://github.com/commercelayer/com
|
|
|
1611
1611
|
|
|
1612
1612
|
### `commercelayer shipment:get_rates ID`
|
|
1613
1613
|
|
|
1614
|
-
Send this attribute if you want get the shipping rates from the associated carrier accounts
|
|
1614
|
+
Send this attribute if you want get the shipping rates from the associated carrier accounts.
|
|
1615
1615
|
|
|
1616
1616
|
```
|
|
1617
1617
|
USAGE
|
|
@@ -1634,7 +1634,7 @@ _See code: [src/commands/shipment/get_rates.ts](https://github.com/commercelayer
|
|
|
1634
1634
|
|
|
1635
1635
|
### `commercelayer shipment:on_hold ID`
|
|
1636
1636
|
|
|
1637
|
-
Send this attribute if you want to put this shipment on hold
|
|
1637
|
+
Send this attribute if you want to put this shipment on hold.
|
|
1638
1638
|
|
|
1639
1639
|
```
|
|
1640
1640
|
USAGE
|
|
@@ -1657,7 +1657,7 @@ _See code: [src/commands/shipment/on_hold.ts](https://github.com/commercelayer/c
|
|
|
1657
1657
|
|
|
1658
1658
|
### `commercelayer shipment:packing ID`
|
|
1659
1659
|
|
|
1660
|
-
Send this attribute if you want to start packing this shipment
|
|
1660
|
+
Send this attribute if you want to start packing this shipment.
|
|
1661
1661
|
|
|
1662
1662
|
```
|
|
1663
1663
|
USAGE
|
|
@@ -1680,7 +1680,7 @@ _See code: [src/commands/shipment/packing.ts](https://github.com/commercelayer/c
|
|
|
1680
1680
|
|
|
1681
1681
|
### `commercelayer shipment:picking ID`
|
|
1682
1682
|
|
|
1683
|
-
Send this attribute if you want to start picking this shipment
|
|
1683
|
+
Send this attribute if you want to start picking this shipment.
|
|
1684
1684
|
|
|
1685
1685
|
```
|
|
1686
1686
|
USAGE
|
|
@@ -1703,7 +1703,7 @@ _See code: [src/commands/shipment/picking.ts](https://github.com/commercelayer/c
|
|
|
1703
1703
|
|
|
1704
1704
|
### `commercelayer shipment:purchase ID`
|
|
1705
1705
|
|
|
1706
|
-
Send this attribute if you want to purchase this shipment with the selected rate
|
|
1706
|
+
Send this attribute if you want to purchase this shipment with the selected rate.
|
|
1707
1707
|
|
|
1708
1708
|
```
|
|
1709
1709
|
USAGE
|
|
@@ -1726,7 +1726,7 @@ _See code: [src/commands/shipment/purchase.ts](https://github.com/commercelayer/
|
|
|
1726
1726
|
|
|
1727
1727
|
### `commercelayer shipment:ready_to_ship ID`
|
|
1728
1728
|
|
|
1729
|
-
Send this attribute if you want to mark this shipment as ready to ship
|
|
1729
|
+
Send this attribute if you want to mark this shipment as ready to ship.
|
|
1730
1730
|
|
|
1731
1731
|
```
|
|
1732
1732
|
USAGE
|
|
@@ -1749,7 +1749,7 @@ _See code: [src/commands/shipment/ready_to_ship.ts](https://github.com/commercel
|
|
|
1749
1749
|
|
|
1750
1750
|
### `commercelayer shipment:ship ID`
|
|
1751
1751
|
|
|
1752
|
-
Send this attribute if you want to mark this shipment as shipped
|
|
1752
|
+
Send this attribute if you want to mark this shipment as shipped.
|
|
1753
1753
|
|
|
1754
1754
|
```
|
|
1755
1755
|
USAGE
|
|
@@ -1795,7 +1795,7 @@ _See code: [src/commands/stock_transfer/index.ts](https://github.com/commercelay
|
|
|
1795
1795
|
|
|
1796
1796
|
### `commercelayer stock_transfer:cancel ID`
|
|
1797
1797
|
|
|
1798
|
-
Send this attribute if you want to cancel this stock transfer
|
|
1798
|
+
Send this attribute if you want to cancel this stock transfer.
|
|
1799
1799
|
|
|
1800
1800
|
```
|
|
1801
1801
|
USAGE
|
|
@@ -1818,7 +1818,7 @@ _See code: [src/commands/stock_transfer/cancel.ts](https://github.com/commercela
|
|
|
1818
1818
|
|
|
1819
1819
|
### `commercelayer stock_transfer:complete ID`
|
|
1820
1820
|
|
|
1821
|
-
Send this attribute if you want to complete this stock transfer
|
|
1821
|
+
Send this attribute if you want to complete this stock transfer.
|
|
1822
1822
|
|
|
1823
1823
|
```
|
|
1824
1824
|
USAGE
|
|
@@ -1841,7 +1841,7 @@ _See code: [src/commands/stock_transfer/complete.ts](https://github.com/commerce
|
|
|
1841
1841
|
|
|
1842
1842
|
### `commercelayer stock_transfer:in_transit ID`
|
|
1843
1843
|
|
|
1844
|
-
Send this attribute if you want to mark this stock transfer as in transit
|
|
1844
|
+
Send this attribute if you want to mark this stock transfer as in transit.
|
|
1845
1845
|
|
|
1846
1846
|
```
|
|
1847
1847
|
USAGE
|
|
@@ -1864,7 +1864,7 @@ _See code: [src/commands/stock_transfer/in_transit.ts](https://github.com/commer
|
|
|
1864
1864
|
|
|
1865
1865
|
### `commercelayer stock_transfer:picking ID`
|
|
1866
1866
|
|
|
1867
|
-
Send this attribute if you want to start picking this stock transfer
|
|
1867
|
+
Send this attribute if you want to start picking this stock transfer.
|
|
1868
1868
|
|
|
1869
1869
|
```
|
|
1870
1870
|
USAGE
|
|
@@ -1887,7 +1887,7 @@ _See code: [src/commands/stock_transfer/picking.ts](https://github.com/commercel
|
|
|
1887
1887
|
|
|
1888
1888
|
### `commercelayer stock_transfer:upcoming ID`
|
|
1889
1889
|
|
|
1890
|
-
Send this attribute if you want to mark this stock transfer as upcoming
|
|
1890
|
+
Send this attribute if you want to mark this stock transfer as upcoming.
|
|
1891
1891
|
|
|
1892
1892
|
```
|
|
1893
1893
|
USAGE
|
|
@@ -1933,7 +1933,7 @@ _See code: [src/commands/stripe_payment/index.ts](https://github.com/commercelay
|
|
|
1933
1933
|
|
|
1934
1934
|
### `commercelayer stripe_payment:refresh ID`
|
|
1935
1935
|
|
|
1936
|
-
Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic
|
|
1936
|
+
Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.
|
|
1937
1937
|
|
|
1938
1938
|
```
|
|
1939
1939
|
USAGE
|
|
@@ -1979,7 +1979,7 @@ _See code: [src/commands/webhook/index.ts](https://github.com/commercelayer/comm
|
|
|
1979
1979
|
|
|
1980
1980
|
### `commercelayer webhook:reset_circuit ID`
|
|
1981
1981
|
|
|
1982
|
-
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count
|
|
1982
|
+
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.
|
|
1983
1983
|
|
|
1984
1984
|
```
|
|
1985
1985
|
USAGE
|