@commercelayer/cli-plugin-triggers 2.3.0 → 3.1.0
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/LICENSE +21 -0
- package/README.md +750 -495
- package/oclif.manifest.json +1 -1
- package/package.json +16 -18
package/README.md
CHANGED
|
@@ -109,16 +109,19 @@ Execute an action on a resource of type adyen_payments.
|
|
|
109
109
|
|
|
110
110
|
```
|
|
111
111
|
USAGE
|
|
112
|
-
$ commercelayer adyen_payment ID
|
|
112
|
+
$ commercelayer adyen_payment [ID] -o <value> [-u [-j -p]]
|
|
113
113
|
|
|
114
114
|
ARGUMENTS
|
|
115
115
|
ID the unique id of the resource
|
|
116
116
|
|
|
117
|
-
|
|
118
|
-
-j, --json
|
|
119
|
-
-o, --organization
|
|
120
|
-
-p, --print
|
|
121
|
-
-u, --unformatted
|
|
117
|
+
FLAGS
|
|
118
|
+
-j, --json print result in JSON format
|
|
119
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
120
|
+
-p, --print print out the modified resource
|
|
121
|
+
-u, --unformatted print JSON output without indentation
|
|
122
|
+
|
|
123
|
+
DESCRIPTION
|
|
124
|
+
execute an action on a resource of type adyen_payments
|
|
122
125
|
```
|
|
123
126
|
|
|
124
127
|
_See code: [src/commands/adyen_payment/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/adyen_payment/index.ts)_
|
|
@@ -129,16 +132,19 @@ Send this attribute if you want to send additional details the payment request..
|
|
|
129
132
|
|
|
130
133
|
```
|
|
131
134
|
USAGE
|
|
132
|
-
$ commercelayer adyen_payment:details ID
|
|
135
|
+
$ commercelayer adyen_payment:details [ID] -o <value> [-u [-j -p]]
|
|
133
136
|
|
|
134
137
|
ARGUMENTS
|
|
135
138
|
ID the unique id of the resource
|
|
136
139
|
|
|
137
|
-
|
|
138
|
-
-j, --json
|
|
139
|
-
-o, --organization
|
|
140
|
-
-p, --print
|
|
141
|
-
-u, --unformatted
|
|
140
|
+
FLAGS
|
|
141
|
+
-j, --json print result in JSON format
|
|
142
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
143
|
+
-p, --print print out the modified resource
|
|
144
|
+
-u, --unformatted print JSON output without indentation
|
|
145
|
+
|
|
146
|
+
DESCRIPTION
|
|
147
|
+
Send this attribute if you want to send additional details the payment request.
|
|
142
148
|
```
|
|
143
149
|
|
|
144
150
|
_See code: [src/commands/adyen_payment/details.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/adyen_payment/details.ts)_
|
|
@@ -149,16 +155,19 @@ Execute an action on a resource of type authorizations.
|
|
|
149
155
|
|
|
150
156
|
```
|
|
151
157
|
USAGE
|
|
152
|
-
$ commercelayer authorization ID
|
|
158
|
+
$ commercelayer authorization [ID] -o <value> [-u [-j -p]]
|
|
153
159
|
|
|
154
160
|
ARGUMENTS
|
|
155
161
|
ID the unique id of the resource
|
|
156
162
|
|
|
157
|
-
|
|
158
|
-
-j, --json
|
|
159
|
-
-o, --organization
|
|
160
|
-
-p, --print
|
|
161
|
-
-u, --unformatted
|
|
163
|
+
FLAGS
|
|
164
|
+
-j, --json print result in JSON format
|
|
165
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
166
|
+
-p, --print print out the modified resource
|
|
167
|
+
-u, --unformatted print JSON output without indentation
|
|
168
|
+
|
|
169
|
+
DESCRIPTION
|
|
170
|
+
execute an action on a resource of type authorizations
|
|
162
171
|
```
|
|
163
172
|
|
|
164
173
|
_See code: [src/commands/authorization/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/index.ts)_
|
|
@@ -169,16 +178,19 @@ Send this attribute if you want to create a capture for this authorization..
|
|
|
169
178
|
|
|
170
179
|
```
|
|
171
180
|
USAGE
|
|
172
|
-
$ commercelayer authorization:capture ID
|
|
181
|
+
$ commercelayer authorization:capture [ID] -o <value> [-u [-j -p]]
|
|
173
182
|
|
|
174
183
|
ARGUMENTS
|
|
175
184
|
ID the unique id of the resource
|
|
176
185
|
|
|
177
|
-
|
|
178
|
-
-j, --json
|
|
179
|
-
-o, --organization
|
|
180
|
-
-p, --print
|
|
181
|
-
-u, --unformatted
|
|
186
|
+
FLAGS
|
|
187
|
+
-j, --json print result in JSON format
|
|
188
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
189
|
+
-p, --print print out the modified resource
|
|
190
|
+
-u, --unformatted print JSON output without indentation
|
|
191
|
+
|
|
192
|
+
DESCRIPTION
|
|
193
|
+
Send this attribute if you want to create a capture for this authorization.
|
|
182
194
|
```
|
|
183
195
|
|
|
184
196
|
_See code: [src/commands/authorization/capture.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/capture.ts)_
|
|
@@ -189,16 +201,19 @@ The associated capture amount, in cents..
|
|
|
189
201
|
|
|
190
202
|
```
|
|
191
203
|
USAGE
|
|
192
|
-
$ commercelayer authorization:capture_amount_cents ID
|
|
204
|
+
$ commercelayer authorization:capture_amount_cents [ID] -o <value> [-u [-j -p]]
|
|
193
205
|
|
|
194
206
|
ARGUMENTS
|
|
195
207
|
ID the unique id of the resource
|
|
196
208
|
|
|
197
|
-
|
|
198
|
-
-j, --json
|
|
199
|
-
-o, --organization
|
|
200
|
-
-p, --print
|
|
201
|
-
-u, --unformatted
|
|
209
|
+
FLAGS
|
|
210
|
+
-j, --json print result in JSON format
|
|
211
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
212
|
+
-p, --print print out the modified resource
|
|
213
|
+
-u, --unformatted print JSON output without indentation
|
|
214
|
+
|
|
215
|
+
DESCRIPTION
|
|
216
|
+
The associated capture amount, in cents.
|
|
202
217
|
```
|
|
203
218
|
|
|
204
219
|
_See code: [src/commands/authorization/capture_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/capture_amount_cents.ts)_
|
|
@@ -209,16 +224,19 @@ Send this attribute if you want to create a void for this authorization..
|
|
|
209
224
|
|
|
210
225
|
```
|
|
211
226
|
USAGE
|
|
212
|
-
$ commercelayer authorization:void ID
|
|
227
|
+
$ commercelayer authorization:void [ID] -o <value> [-u [-j -p]]
|
|
213
228
|
|
|
214
229
|
ARGUMENTS
|
|
215
230
|
ID the unique id of the resource
|
|
216
231
|
|
|
217
|
-
|
|
218
|
-
-j, --json
|
|
219
|
-
-o, --organization
|
|
220
|
-
-p, --print
|
|
221
|
-
-u, --unformatted
|
|
232
|
+
FLAGS
|
|
233
|
+
-j, --json print result in JSON format
|
|
234
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
235
|
+
-p, --print print out the modified resource
|
|
236
|
+
-u, --unformatted print JSON output without indentation
|
|
237
|
+
|
|
238
|
+
DESCRIPTION
|
|
239
|
+
Send this attribute if you want to create a void for this authorization.
|
|
222
240
|
```
|
|
223
241
|
|
|
224
242
|
_See code: [src/commands/authorization/void.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/void.ts)_
|
|
@@ -229,16 +247,19 @@ Execute an action on a resource of type bundles.
|
|
|
229
247
|
|
|
230
248
|
```
|
|
231
249
|
USAGE
|
|
232
|
-
$ commercelayer bundle ID
|
|
250
|
+
$ commercelayer bundle [ID] -o <value> [-u [-j -p]]
|
|
233
251
|
|
|
234
252
|
ARGUMENTS
|
|
235
253
|
ID the unique id of the resource
|
|
236
254
|
|
|
237
|
-
|
|
238
|
-
-j, --json
|
|
239
|
-
-o, --organization
|
|
240
|
-
-p, --print
|
|
241
|
-
-u, --unformatted
|
|
255
|
+
FLAGS
|
|
256
|
+
-j, --json print result in JSON format
|
|
257
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
258
|
+
-p, --print print out the modified resource
|
|
259
|
+
-u, --unformatted print JSON output without indentation
|
|
260
|
+
|
|
261
|
+
DESCRIPTION
|
|
262
|
+
execute an action on a resource of type bundles
|
|
242
263
|
```
|
|
243
264
|
|
|
244
265
|
_See code: [src/commands/bundle/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/bundle/index.ts)_
|
|
@@ -249,16 +270,20 @@ Send this attribute if you want to compute the compare_at_amount_cents as the su
|
|
|
249
270
|
|
|
250
271
|
```
|
|
251
272
|
USAGE
|
|
252
|
-
$ commercelayer bundle:compute_compare_at_amount ID
|
|
273
|
+
$ commercelayer bundle:compute_compare_at_amount [ID] -o <value> [-u [-j -p]]
|
|
253
274
|
|
|
254
275
|
ARGUMENTS
|
|
255
276
|
ID the unique id of the resource
|
|
256
277
|
|
|
257
|
-
|
|
258
|
-
-j, --json
|
|
259
|
-
-o, --organization
|
|
260
|
-
-p, --print
|
|
261
|
-
-u, --unformatted
|
|
278
|
+
FLAGS
|
|
279
|
+
-j, --json print result in JSON format
|
|
280
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
281
|
+
-p, --print print out the modified resource
|
|
282
|
+
-u, --unformatted print JSON output without indentation
|
|
283
|
+
|
|
284
|
+
DESCRIPTION
|
|
285
|
+
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for
|
|
286
|
+
the market.
|
|
262
287
|
```
|
|
263
288
|
|
|
264
289
|
_See code: [src/commands/bundle/compute_compare_at_amount.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/bundle/compute_compare_at_amount.ts)_
|
|
@@ -269,16 +294,20 @@ Send this attribute if you want to compute the price_amount_cents as the sum of
|
|
|
269
294
|
|
|
270
295
|
```
|
|
271
296
|
USAGE
|
|
272
|
-
$ commercelayer bundle:compute_price_amount ID
|
|
297
|
+
$ commercelayer bundle:compute_price_amount [ID] -o <value> [-u [-j -p]]
|
|
273
298
|
|
|
274
299
|
ARGUMENTS
|
|
275
300
|
ID the unique id of the resource
|
|
276
301
|
|
|
277
|
-
|
|
278
|
-
-j, --json
|
|
279
|
-
-o, --organization
|
|
280
|
-
-p, --print
|
|
281
|
-
-u, --unformatted
|
|
302
|
+
FLAGS
|
|
303
|
+
-j, --json print result in JSON format
|
|
304
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
305
|
+
-p, --print print out the modified resource
|
|
306
|
+
-u, --unformatted print JSON output without indentation
|
|
307
|
+
|
|
308
|
+
DESCRIPTION
|
|
309
|
+
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the
|
|
310
|
+
market.
|
|
282
311
|
```
|
|
283
312
|
|
|
284
313
|
_See code: [src/commands/bundle/compute_price_amount.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/bundle/compute_price_amount.ts)_
|
|
@@ -289,16 +318,19 @@ Execute an action on a resource of type captures.
|
|
|
289
318
|
|
|
290
319
|
```
|
|
291
320
|
USAGE
|
|
292
|
-
$ commercelayer capture ID
|
|
321
|
+
$ commercelayer capture [ID] -o <value> [-u [-j -p]]
|
|
293
322
|
|
|
294
323
|
ARGUMENTS
|
|
295
324
|
ID the unique id of the resource
|
|
296
325
|
|
|
297
|
-
|
|
298
|
-
-j, --json
|
|
299
|
-
-o, --organization
|
|
300
|
-
-p, --print
|
|
301
|
-
-u, --unformatted
|
|
326
|
+
FLAGS
|
|
327
|
+
-j, --json print result in JSON format
|
|
328
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
329
|
+
-p, --print print out the modified resource
|
|
330
|
+
-u, --unformatted print JSON output without indentation
|
|
331
|
+
|
|
332
|
+
DESCRIPTION
|
|
333
|
+
execute an action on a resource of type captures
|
|
302
334
|
```
|
|
303
335
|
|
|
304
336
|
_See code: [src/commands/capture/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/index.ts)_
|
|
@@ -309,16 +341,19 @@ Send this attribute if you want to create a refund for this capture..
|
|
|
309
341
|
|
|
310
342
|
```
|
|
311
343
|
USAGE
|
|
312
|
-
$ commercelayer capture:refund ID
|
|
344
|
+
$ commercelayer capture:refund [ID] -o <value> [-u [-j -p]]
|
|
313
345
|
|
|
314
346
|
ARGUMENTS
|
|
315
347
|
ID the unique id of the resource
|
|
316
348
|
|
|
317
|
-
|
|
318
|
-
-j, --json
|
|
319
|
-
-o, --organization
|
|
320
|
-
-p, --print
|
|
321
|
-
-u, --unformatted
|
|
349
|
+
FLAGS
|
|
350
|
+
-j, --json print result in JSON format
|
|
351
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
352
|
+
-p, --print print out the modified resource
|
|
353
|
+
-u, --unformatted print JSON output without indentation
|
|
354
|
+
|
|
355
|
+
DESCRIPTION
|
|
356
|
+
Send this attribute if you want to create a refund for this capture.
|
|
322
357
|
```
|
|
323
358
|
|
|
324
359
|
_See code: [src/commands/capture/refund.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/refund.ts)_
|
|
@@ -329,16 +364,19 @@ The associated refund amount, in cents..
|
|
|
329
364
|
|
|
330
365
|
```
|
|
331
366
|
USAGE
|
|
332
|
-
$ commercelayer capture:refund_amount_cents ID
|
|
367
|
+
$ commercelayer capture:refund_amount_cents [ID] -o <value> [-u [-j -p]]
|
|
333
368
|
|
|
334
369
|
ARGUMENTS
|
|
335
370
|
ID the unique id of the resource
|
|
336
371
|
|
|
337
|
-
|
|
338
|
-
-j, --json
|
|
339
|
-
-o, --organization
|
|
340
|
-
-p, --print
|
|
341
|
-
-u, --unformatted
|
|
372
|
+
FLAGS
|
|
373
|
+
-j, --json print result in JSON format
|
|
374
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
375
|
+
-p, --print print out the modified resource
|
|
376
|
+
-u, --unformatted print JSON output without indentation
|
|
377
|
+
|
|
378
|
+
DESCRIPTION
|
|
379
|
+
The associated refund amount, in cents.
|
|
342
380
|
```
|
|
343
381
|
|
|
344
382
|
_See code: [src/commands/capture/refund_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/refund_amount_cents.ts)_
|
|
@@ -349,16 +387,19 @@ Execute an action on a resource of type checkout_com_payments.
|
|
|
349
387
|
|
|
350
388
|
```
|
|
351
389
|
USAGE
|
|
352
|
-
$ commercelayer checkout_com_payment ID
|
|
390
|
+
$ commercelayer checkout_com_payment [ID] -o <value> [-u [-j -p]]
|
|
353
391
|
|
|
354
392
|
ARGUMENTS
|
|
355
393
|
ID the unique id of the resource
|
|
356
394
|
|
|
357
|
-
|
|
358
|
-
-j, --json
|
|
359
|
-
-o, --organization
|
|
360
|
-
-p, --print
|
|
361
|
-
-u, --unformatted
|
|
395
|
+
FLAGS
|
|
396
|
+
-j, --json print result in JSON format
|
|
397
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
398
|
+
-p, --print print out the modified resource
|
|
399
|
+
-u, --unformatted print JSON output without indentation
|
|
400
|
+
|
|
401
|
+
DESCRIPTION
|
|
402
|
+
execute an action on a resource of type checkout_com_payments
|
|
362
403
|
```
|
|
363
404
|
|
|
364
405
|
_See code: [src/commands/checkout_com_payment/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/checkout_com_payment/index.ts)_
|
|
@@ -369,16 +410,19 @@ Send this attribute if you want to send additional details the payment request (
|
|
|
369
410
|
|
|
370
411
|
```
|
|
371
412
|
USAGE
|
|
372
|
-
$ commercelayer checkout_com_payment:details ID
|
|
413
|
+
$ commercelayer checkout_com_payment:details [ID] -o <value> [-u [-j -p]]
|
|
373
414
|
|
|
374
415
|
ARGUMENTS
|
|
375
416
|
ID the unique id of the resource
|
|
376
417
|
|
|
377
|
-
|
|
378
|
-
-j, --json
|
|
379
|
-
-o, --organization
|
|
380
|
-
-p, --print
|
|
381
|
-
-u, --unformatted
|
|
418
|
+
FLAGS
|
|
419
|
+
-j, --json print result in JSON format
|
|
420
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
421
|
+
-p, --print print out the modified resource
|
|
422
|
+
-u, --unformatted print JSON output without indentation
|
|
423
|
+
|
|
424
|
+
DESCRIPTION
|
|
425
|
+
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).
|
|
382
426
|
```
|
|
383
427
|
|
|
384
428
|
_See code: [src/commands/checkout_com_payment/details.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/checkout_com_payment/details.ts)_
|
|
@@ -389,16 +433,19 @@ Send this attribute if you want to refresh all the pending transactions, can be
|
|
|
389
433
|
|
|
390
434
|
```
|
|
391
435
|
USAGE
|
|
392
|
-
$ commercelayer checkout_com_payment:refresh ID
|
|
436
|
+
$ commercelayer checkout_com_payment:refresh [ID] -o <value> [-u [-j -p]]
|
|
393
437
|
|
|
394
438
|
ARGUMENTS
|
|
395
439
|
ID the unique id of the resource
|
|
396
440
|
|
|
397
|
-
|
|
398
|
-
-j, --json
|
|
399
|
-
-o, --organization
|
|
400
|
-
-p, --print
|
|
401
|
-
-u, --unformatted
|
|
441
|
+
FLAGS
|
|
442
|
+
-j, --json print result in JSON format
|
|
443
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
444
|
+
-p, --print print out the modified resource
|
|
445
|
+
-u, --unformatted print JSON output without indentation
|
|
446
|
+
|
|
447
|
+
DESCRIPTION
|
|
448
|
+
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.
|
|
402
449
|
```
|
|
403
450
|
|
|
404
451
|
_See code: [src/commands/checkout_com_payment/refresh.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/checkout_com_payment/refresh.ts)_
|
|
@@ -409,16 +456,19 @@ Execute an action on a resource of type customer_password_resets.
|
|
|
409
456
|
|
|
410
457
|
```
|
|
411
458
|
USAGE
|
|
412
|
-
$ commercelayer customer_password_reset ID
|
|
459
|
+
$ commercelayer customer_password_reset [ID] -o <value> [-u [-j -p]]
|
|
413
460
|
|
|
414
461
|
ARGUMENTS
|
|
415
462
|
ID the unique id of the resource
|
|
416
463
|
|
|
417
|
-
|
|
418
|
-
-j, --json
|
|
419
|
-
-o, --organization
|
|
420
|
-
-p, --print
|
|
421
|
-
-u, --unformatted
|
|
464
|
+
FLAGS
|
|
465
|
+
-j, --json print result in JSON format
|
|
466
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
467
|
+
-p, --print print out the modified resource
|
|
468
|
+
-u, --unformatted print JSON output without indentation
|
|
469
|
+
|
|
470
|
+
DESCRIPTION
|
|
471
|
+
execute an action on a resource of type customer_password_resets
|
|
422
472
|
```
|
|
423
473
|
|
|
424
474
|
_See code: [src/commands/customer_password_reset/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/customer_password_reset/index.ts)_
|
|
@@ -429,16 +479,19 @@ Send the 'reset_password_token' that you got on create when updating the custome
|
|
|
429
479
|
|
|
430
480
|
```
|
|
431
481
|
USAGE
|
|
432
|
-
$ commercelayer customer_password_reset:reset_password_token ID
|
|
482
|
+
$ commercelayer customer_password_reset:reset_password_token [ID] -o <value> [-u [-j -p]]
|
|
433
483
|
|
|
434
484
|
ARGUMENTS
|
|
435
485
|
ID the unique id of the resource
|
|
436
486
|
|
|
437
|
-
|
|
438
|
-
-j, --json
|
|
439
|
-
-o, --organization
|
|
440
|
-
-p, --print
|
|
441
|
-
-u, --unformatted
|
|
487
|
+
FLAGS
|
|
488
|
+
-j, --json print result in JSON format
|
|
489
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
490
|
+
-p, --print print out the modified resource
|
|
491
|
+
-u, --unformatted print JSON output without indentation
|
|
492
|
+
|
|
493
|
+
DESCRIPTION
|
|
494
|
+
Send the 'reset_password_token' that you got on create when updating the customer password.
|
|
442
495
|
```
|
|
443
496
|
|
|
444
497
|
_See code: [src/commands/customer_password_reset/reset_password_token.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/customer_password_reset/reset_password_token.ts)_
|
|
@@ -449,16 +502,19 @@ Execute an action on a resource of type gift_cards.
|
|
|
449
502
|
|
|
450
503
|
```
|
|
451
504
|
USAGE
|
|
452
|
-
$ commercelayer gift_card ID
|
|
505
|
+
$ commercelayer gift_card [ID] -o <value> [-u [-j -p]]
|
|
453
506
|
|
|
454
507
|
ARGUMENTS
|
|
455
508
|
ID the unique id of the resource
|
|
456
509
|
|
|
457
|
-
|
|
458
|
-
-j, --json
|
|
459
|
-
-o, --organization
|
|
460
|
-
-p, --print
|
|
461
|
-
-u, --unformatted
|
|
510
|
+
FLAGS
|
|
511
|
+
-j, --json print result in JSON format
|
|
512
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
513
|
+
-p, --print print out the modified resource
|
|
514
|
+
-u, --unformatted print JSON output without indentation
|
|
515
|
+
|
|
516
|
+
DESCRIPTION
|
|
517
|
+
execute an action on a resource of type gift_cards
|
|
462
518
|
```
|
|
463
519
|
|
|
464
520
|
_See code: [src/commands/gift_card/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/gift_card/index.ts)_
|
|
@@ -469,16 +525,19 @@ Send this attribute if you want to activate a gift card..
|
|
|
469
525
|
|
|
470
526
|
```
|
|
471
527
|
USAGE
|
|
472
|
-
$ commercelayer gift_card:activate ID
|
|
528
|
+
$ commercelayer gift_card:activate [ID] -o <value> [-u [-j -p]]
|
|
473
529
|
|
|
474
530
|
ARGUMENTS
|
|
475
531
|
ID the unique id of the resource
|
|
476
532
|
|
|
477
|
-
|
|
478
|
-
-j, --json
|
|
479
|
-
-o, --organization
|
|
480
|
-
-p, --print
|
|
481
|
-
-u, --unformatted
|
|
533
|
+
FLAGS
|
|
534
|
+
-j, --json print result in JSON format
|
|
535
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
536
|
+
-p, --print print out the modified resource
|
|
537
|
+
-u, --unformatted print JSON output without indentation
|
|
538
|
+
|
|
539
|
+
DESCRIPTION
|
|
540
|
+
Send this attribute if you want to activate a gift card.
|
|
482
541
|
```
|
|
483
542
|
|
|
484
543
|
_See code: [src/commands/gift_card/activate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/gift_card/activate.ts)_
|
|
@@ -489,16 +548,20 @@ The balance change, in cents. Send a negative value to reduces the card balance
|
|
|
489
548
|
|
|
490
549
|
```
|
|
491
550
|
USAGE
|
|
492
|
-
$ commercelayer gift_card:balance_change_cents ID
|
|
551
|
+
$ commercelayer gift_card:balance_change_cents [ID] -o <value> [-u [-j -p]]
|
|
493
552
|
|
|
494
553
|
ARGUMENTS
|
|
495
554
|
ID the unique id of the resource
|
|
496
555
|
|
|
497
|
-
|
|
498
|
-
-j, --json
|
|
499
|
-
-o, --organization
|
|
500
|
-
-p, --print
|
|
501
|
-
-u, --unformatted
|
|
556
|
+
FLAGS
|
|
557
|
+
-j, --json print result in JSON format
|
|
558
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
559
|
+
-p, --print print out the modified resource
|
|
560
|
+
-u, --unformatted print JSON output without indentation
|
|
561
|
+
|
|
562
|
+
DESCRIPTION
|
|
563
|
+
The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a
|
|
564
|
+
positive value to recharge the gift card (if rechargeable).
|
|
502
565
|
```
|
|
503
566
|
|
|
504
567
|
_See code: [src/commands/gift_card/balance_change_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/gift_card/balance_change_cents.ts)_
|
|
@@ -509,16 +572,19 @@ Send this attribute if you want to deactivate a gift card..
|
|
|
509
572
|
|
|
510
573
|
```
|
|
511
574
|
USAGE
|
|
512
|
-
$ commercelayer gift_card:deactivate ID
|
|
575
|
+
$ commercelayer gift_card:deactivate [ID] -o <value> [-u [-j -p]]
|
|
513
576
|
|
|
514
577
|
ARGUMENTS
|
|
515
578
|
ID the unique id of the resource
|
|
516
579
|
|
|
517
|
-
|
|
518
|
-
-j, --json
|
|
519
|
-
-o, --organization
|
|
520
|
-
-p, --print
|
|
521
|
-
-u, --unformatted
|
|
580
|
+
FLAGS
|
|
581
|
+
-j, --json print result in JSON format
|
|
582
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
583
|
+
-p, --print print out the modified resource
|
|
584
|
+
-u, --unformatted print JSON output without indentation
|
|
585
|
+
|
|
586
|
+
DESCRIPTION
|
|
587
|
+
Send this attribute if you want to deactivate a gift card.
|
|
522
588
|
```
|
|
523
589
|
|
|
524
590
|
_See code: [src/commands/gift_card/deactivate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/gift_card/deactivate.ts)_
|
|
@@ -529,16 +595,20 @@ Send this attribute if you want to confirm a draft gift card. The gift card beco
|
|
|
529
595
|
|
|
530
596
|
```
|
|
531
597
|
USAGE
|
|
532
|
-
$ commercelayer gift_card:purchase ID
|
|
598
|
+
$ commercelayer gift_card:purchase [ID] -o <value> [-u [-j -p]]
|
|
533
599
|
|
|
534
600
|
ARGUMENTS
|
|
535
601
|
ID the unique id of the resource
|
|
536
602
|
|
|
537
|
-
|
|
538
|
-
-j, --json
|
|
539
|
-
-o, --organization
|
|
540
|
-
-p, --print
|
|
541
|
-
-u, --unformatted
|
|
603
|
+
FLAGS
|
|
604
|
+
-j, --json print result in JSON format
|
|
605
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
606
|
+
-p, --print print out the modified resource
|
|
607
|
+
-u, --unformatted print JSON output without indentation
|
|
608
|
+
|
|
609
|
+
DESCRIPTION
|
|
610
|
+
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be
|
|
611
|
+
activated.
|
|
542
612
|
```
|
|
543
613
|
|
|
544
614
|
_See code: [src/commands/gift_card/purchase.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/gift_card/purchase.ts)_
|
|
@@ -549,16 +619,19 @@ Execute an action on a resource of type in_stock_subscriptions.
|
|
|
549
619
|
|
|
550
620
|
```
|
|
551
621
|
USAGE
|
|
552
|
-
$ commercelayer in_stock_subscription ID
|
|
622
|
+
$ commercelayer in_stock_subscription [ID] -o <value> [-u [-j -p]]
|
|
553
623
|
|
|
554
624
|
ARGUMENTS
|
|
555
625
|
ID the unique id of the resource
|
|
556
626
|
|
|
557
|
-
|
|
558
|
-
-j, --json
|
|
559
|
-
-o, --organization
|
|
560
|
-
-p, --print
|
|
561
|
-
-u, --unformatted
|
|
627
|
+
FLAGS
|
|
628
|
+
-j, --json print result in JSON format
|
|
629
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
630
|
+
-p, --print print out the modified resource
|
|
631
|
+
-u, --unformatted print JSON output without indentation
|
|
632
|
+
|
|
633
|
+
DESCRIPTION
|
|
634
|
+
execute an action on a resource of type in_stock_subscriptions
|
|
562
635
|
```
|
|
563
636
|
|
|
564
637
|
_See code: [src/commands/in_stock_subscription/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/in_stock_subscription/index.ts)_
|
|
@@ -569,16 +642,19 @@ Send this attribute if you want to activate an inactive subscription..
|
|
|
569
642
|
|
|
570
643
|
```
|
|
571
644
|
USAGE
|
|
572
|
-
$ commercelayer in_stock_subscription:activate ID
|
|
645
|
+
$ commercelayer in_stock_subscription:activate [ID] -o <value> [-u [-j -p]]
|
|
573
646
|
|
|
574
647
|
ARGUMENTS
|
|
575
648
|
ID the unique id of the resource
|
|
576
649
|
|
|
577
|
-
|
|
578
|
-
-j, --json
|
|
579
|
-
-o, --organization
|
|
580
|
-
-p, --print
|
|
581
|
-
-u, --unformatted
|
|
650
|
+
FLAGS
|
|
651
|
+
-j, --json print result in JSON format
|
|
652
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
653
|
+
-p, --print print out the modified resource
|
|
654
|
+
-u, --unformatted print JSON output without indentation
|
|
655
|
+
|
|
656
|
+
DESCRIPTION
|
|
657
|
+
Send this attribute if you want to activate an inactive subscription.
|
|
582
658
|
```
|
|
583
659
|
|
|
584
660
|
_See code: [src/commands/in_stock_subscription/activate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/in_stock_subscription/activate.ts)_
|
|
@@ -589,16 +665,19 @@ Send this attribute if you want to dactivate an active subscription..
|
|
|
589
665
|
|
|
590
666
|
```
|
|
591
667
|
USAGE
|
|
592
|
-
$ commercelayer in_stock_subscription:deactivate ID
|
|
668
|
+
$ commercelayer in_stock_subscription:deactivate [ID] -o <value> [-u [-j -p]]
|
|
593
669
|
|
|
594
670
|
ARGUMENTS
|
|
595
671
|
ID the unique id of the resource
|
|
596
672
|
|
|
597
|
-
|
|
598
|
-
-j, --json
|
|
599
|
-
-o, --organization
|
|
600
|
-
-p, --print
|
|
601
|
-
-u, --unformatted
|
|
673
|
+
FLAGS
|
|
674
|
+
-j, --json print result in JSON format
|
|
675
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
676
|
+
-p, --print print out the modified resource
|
|
677
|
+
-u, --unformatted print JSON output without indentation
|
|
678
|
+
|
|
679
|
+
DESCRIPTION
|
|
680
|
+
Send this attribute if you want to dactivate an active subscription.
|
|
602
681
|
```
|
|
603
682
|
|
|
604
683
|
_See code: [src/commands/in_stock_subscription/deactivate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/in_stock_subscription/deactivate.ts)_
|
|
@@ -609,16 +688,19 @@ Execute an action on a resource of type klarna_payments.
|
|
|
609
688
|
|
|
610
689
|
```
|
|
611
690
|
USAGE
|
|
612
|
-
$ commercelayer klarna_payment ID
|
|
691
|
+
$ commercelayer klarna_payment [ID] -o <value> [-u [-j -p]]
|
|
613
692
|
|
|
614
693
|
ARGUMENTS
|
|
615
694
|
ID the unique id of the resource
|
|
616
695
|
|
|
617
|
-
|
|
618
|
-
-j, --json
|
|
619
|
-
-o, --organization
|
|
620
|
-
-p, --print
|
|
621
|
-
-u, --unformatted
|
|
696
|
+
FLAGS
|
|
697
|
+
-j, --json print result in JSON format
|
|
698
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
699
|
+
-p, --print print out the modified resource
|
|
700
|
+
-u, --unformatted print JSON output without indentation
|
|
701
|
+
|
|
702
|
+
DESCRIPTION
|
|
703
|
+
execute an action on a resource of type klarna_payments
|
|
622
704
|
```
|
|
623
705
|
|
|
624
706
|
_See code: [src/commands/klarna_payment/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/klarna_payment/index.ts)_
|
|
@@ -629,16 +711,19 @@ Send this attribute if you want to update the payment session with fresh order d
|
|
|
629
711
|
|
|
630
712
|
```
|
|
631
713
|
USAGE
|
|
632
|
-
$ commercelayer klarna_payment:update ID
|
|
714
|
+
$ commercelayer klarna_payment:update [ID] -o <value> [-u [-j -p]]
|
|
633
715
|
|
|
634
716
|
ARGUMENTS
|
|
635
717
|
ID the unique id of the resource
|
|
636
718
|
|
|
637
|
-
|
|
638
|
-
-j, --json
|
|
639
|
-
-o, --organization
|
|
640
|
-
-p, --print
|
|
641
|
-
-u, --unformatted
|
|
719
|
+
FLAGS
|
|
720
|
+
-j, --json print result in JSON format
|
|
721
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
722
|
+
-p, --print print out the modified resource
|
|
723
|
+
-u, --unformatted print JSON output without indentation
|
|
724
|
+
|
|
725
|
+
DESCRIPTION
|
|
726
|
+
Send this attribute if you want to update the payment session with fresh order data.
|
|
642
727
|
```
|
|
643
728
|
|
|
644
729
|
_See code: [src/commands/klarna_payment/update.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/klarna_payment/update.ts)_
|
|
@@ -649,16 +734,19 @@ Execute an action on a resource of type orders.
|
|
|
649
734
|
|
|
650
735
|
```
|
|
651
736
|
USAGE
|
|
652
|
-
$ commercelayer order ID
|
|
737
|
+
$ commercelayer order [ID] -o <value> [-u [-j -p]]
|
|
653
738
|
|
|
654
739
|
ARGUMENTS
|
|
655
740
|
ID the unique id of the resource
|
|
656
741
|
|
|
657
|
-
|
|
658
|
-
-j, --json
|
|
659
|
-
-o, --organization
|
|
660
|
-
-p, --print
|
|
661
|
-
-u, --unformatted
|
|
742
|
+
FLAGS
|
|
743
|
+
-j, --json print result in JSON format
|
|
744
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
745
|
+
-p, --print print out the modified resource
|
|
746
|
+
-u, --unformatted print JSON output without indentation
|
|
747
|
+
|
|
748
|
+
DESCRIPTION
|
|
749
|
+
execute an action on a resource of type orders
|
|
662
750
|
```
|
|
663
751
|
|
|
664
752
|
_See code: [src/commands/order/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/index.ts)_
|
|
@@ -669,16 +757,19 @@ Send this attribute if you want to approve a placed order..
|
|
|
669
757
|
|
|
670
758
|
```
|
|
671
759
|
USAGE
|
|
672
|
-
$ commercelayer order:approve ID
|
|
760
|
+
$ commercelayer order:approve [ID] -o <value> [-u [-j -p]]
|
|
673
761
|
|
|
674
762
|
ARGUMENTS
|
|
675
763
|
ID the unique id of the resource
|
|
676
764
|
|
|
677
|
-
|
|
678
|
-
-j, --json
|
|
679
|
-
-o, --organization
|
|
680
|
-
-p, --print
|
|
681
|
-
-u, --unformatted
|
|
765
|
+
FLAGS
|
|
766
|
+
-j, --json print result in JSON format
|
|
767
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
768
|
+
-p, --print print out the modified resource
|
|
769
|
+
-u, --unformatted print JSON output without indentation
|
|
770
|
+
|
|
771
|
+
DESCRIPTION
|
|
772
|
+
Send this attribute if you want to approve a placed order.
|
|
682
773
|
```
|
|
683
774
|
|
|
684
775
|
_See code: [src/commands/order/approve.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/approve.ts)_
|
|
@@ -689,16 +780,19 @@ Send this attribute if you want to approve and capture a placed order..
|
|
|
689
780
|
|
|
690
781
|
```
|
|
691
782
|
USAGE
|
|
692
|
-
$ commercelayer order:approve_and_capture ID
|
|
783
|
+
$ commercelayer order:approve_and_capture [ID] -o <value> [-u [-j -p]]
|
|
693
784
|
|
|
694
785
|
ARGUMENTS
|
|
695
786
|
ID the unique id of the resource
|
|
696
787
|
|
|
697
|
-
|
|
698
|
-
-j, --json
|
|
699
|
-
-o, --organization
|
|
700
|
-
-p, --print
|
|
701
|
-
-u, --unformatted
|
|
788
|
+
FLAGS
|
|
789
|
+
-j, --json print result in JSON format
|
|
790
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
791
|
+
-p, --print print out the modified resource
|
|
792
|
+
-u, --unformatted print JSON output without indentation
|
|
793
|
+
|
|
794
|
+
DESCRIPTION
|
|
795
|
+
Send this attribute if you want to approve and capture a placed order.
|
|
702
796
|
```
|
|
703
797
|
|
|
704
798
|
_See code: [src/commands/order/approve_and_capture.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/approve_and_capture.ts)_
|
|
@@ -709,16 +803,19 @@ Send this attribute if you want to archive the order..
|
|
|
709
803
|
|
|
710
804
|
```
|
|
711
805
|
USAGE
|
|
712
|
-
$ commercelayer order:archive ID
|
|
806
|
+
$ commercelayer order:archive [ID] -o <value> [-u [-j -p]]
|
|
713
807
|
|
|
714
808
|
ARGUMENTS
|
|
715
809
|
ID the unique id of the resource
|
|
716
810
|
|
|
717
|
-
|
|
718
|
-
-j, --json
|
|
719
|
-
-o, --organization
|
|
720
|
-
-p, --print
|
|
721
|
-
-u, --unformatted
|
|
811
|
+
FLAGS
|
|
812
|
+
-j, --json print result in JSON format
|
|
813
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
814
|
+
-p, --print print out the modified resource
|
|
815
|
+
-u, --unformatted print JSON output without indentation
|
|
816
|
+
|
|
817
|
+
DESCRIPTION
|
|
818
|
+
Send this attribute if you want to archive the order.
|
|
722
819
|
```
|
|
723
820
|
|
|
724
821
|
_See code: [src/commands/order/archive.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/archive.ts)_
|
|
@@ -729,16 +826,19 @@ The authorization amount, in cents..
|
|
|
729
826
|
|
|
730
827
|
```
|
|
731
828
|
USAGE
|
|
732
|
-
$ commercelayer order:authorization_amount_cents ID
|
|
829
|
+
$ commercelayer order:authorization_amount_cents [ID] -o <value> [-u [-j -p]]
|
|
733
830
|
|
|
734
831
|
ARGUMENTS
|
|
735
832
|
ID the unique id of the resource
|
|
736
833
|
|
|
737
|
-
|
|
738
|
-
-j, --json
|
|
739
|
-
-o, --organization
|
|
740
|
-
-p, --print
|
|
741
|
-
-u, --unformatted
|
|
834
|
+
FLAGS
|
|
835
|
+
-j, --json print result in JSON format
|
|
836
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
837
|
+
-p, --print print out the modified resource
|
|
838
|
+
-u, --unformatted print JSON output without indentation
|
|
839
|
+
|
|
840
|
+
DESCRIPTION
|
|
841
|
+
The authorization amount, in cents.
|
|
742
842
|
```
|
|
743
843
|
|
|
744
844
|
_See code: [src/commands/order/authorization_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/authorization_amount_cents.ts)_
|
|
@@ -749,16 +849,19 @@ Send this attribute if you want to authorize the order's payment source..
|
|
|
749
849
|
|
|
750
850
|
```
|
|
751
851
|
USAGE
|
|
752
|
-
$ commercelayer order:authorize ID
|
|
852
|
+
$ commercelayer order:authorize [ID] -o <value> [-u [-j -p]]
|
|
753
853
|
|
|
754
854
|
ARGUMENTS
|
|
755
855
|
ID the unique id of the resource
|
|
756
856
|
|
|
757
|
-
|
|
758
|
-
-j, --json
|
|
759
|
-
-o, --organization
|
|
760
|
-
-p, --print
|
|
761
|
-
-u, --unformatted
|
|
857
|
+
FLAGS
|
|
858
|
+
-j, --json print result in JSON format
|
|
859
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
860
|
+
-p, --print print out the modified resource
|
|
861
|
+
-u, --unformatted print JSON output without indentation
|
|
862
|
+
|
|
863
|
+
DESCRIPTION
|
|
864
|
+
Send this attribute if you want to authorize the order's payment source.
|
|
762
865
|
```
|
|
763
866
|
|
|
764
867
|
_See code: [src/commands/order/authorize.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/authorize.ts)_
|
|
@@ -769,17 +872,20 @@ The id of the address that you want to clone to create the order's billing addre
|
|
|
769
872
|
|
|
770
873
|
```
|
|
771
874
|
USAGE
|
|
772
|
-
$ commercelayer order:billing_address_clone_id ID
|
|
875
|
+
$ commercelayer order:billing_address_clone_id [ID] -o <value> -v <value> [-u [-j -p]]
|
|
773
876
|
|
|
774
877
|
ARGUMENTS
|
|
775
878
|
ID the unique id of the resource
|
|
776
879
|
|
|
777
|
-
|
|
778
|
-
-j, --json
|
|
779
|
-
-o, --organization
|
|
780
|
-
-p, --print
|
|
781
|
-
-u, --unformatted
|
|
782
|
-
-v, --value
|
|
880
|
+
FLAGS
|
|
881
|
+
-j, --json print result in JSON format
|
|
882
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
883
|
+
-p, --print print out the modified resource
|
|
884
|
+
-u, --unformatted print JSON output without indentation
|
|
885
|
+
-v, --value=<value> (required) the trigger attribute value
|
|
886
|
+
|
|
887
|
+
DESCRIPTION
|
|
888
|
+
The id of the address that you want to clone to create the order's billing address.
|
|
783
889
|
```
|
|
784
890
|
|
|
785
891
|
_See code: [src/commands/order/billing_address_clone_id.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/billing_address_clone_id.ts)_
|
|
@@ -790,16 +896,19 @@ Send this attribute if you want the billing address to be cloned from the order'
|
|
|
790
896
|
|
|
791
897
|
```
|
|
792
898
|
USAGE
|
|
793
|
-
$ commercelayer order:billing_address_same_as_shipping ID
|
|
899
|
+
$ commercelayer order:billing_address_same_as_shipping [ID] -o <value> [-u [-j -p]]
|
|
794
900
|
|
|
795
901
|
ARGUMENTS
|
|
796
902
|
ID the unique id of the resource
|
|
797
903
|
|
|
798
|
-
|
|
799
|
-
-j, --json
|
|
800
|
-
-o, --organization
|
|
801
|
-
-p, --print
|
|
802
|
-
-u, --unformatted
|
|
904
|
+
FLAGS
|
|
905
|
+
-j, --json print result in JSON format
|
|
906
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
907
|
+
-p, --print print out the modified resource
|
|
908
|
+
-u, --unformatted print JSON output without indentation
|
|
909
|
+
|
|
910
|
+
DESCRIPTION
|
|
911
|
+
Send this attribute if you want the billing address to be cloned from the order's shipping address.
|
|
803
912
|
```
|
|
804
913
|
|
|
805
914
|
_See code: [src/commands/order/billing_address_same_as_shipping.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/billing_address_same_as_shipping.ts)_
|
|
@@ -810,16 +919,19 @@ Send this attribute if you want to cancel a placed order. The order's authorizat
|
|
|
810
919
|
|
|
811
920
|
```
|
|
812
921
|
USAGE
|
|
813
|
-
$ commercelayer order:cancel ID
|
|
922
|
+
$ commercelayer order:cancel [ID] -o <value> [-u [-j -p]]
|
|
814
923
|
|
|
815
924
|
ARGUMENTS
|
|
816
925
|
ID the unique id of the resource
|
|
817
926
|
|
|
818
|
-
|
|
819
|
-
-j, --json
|
|
820
|
-
-o, --organization
|
|
821
|
-
-p, --print
|
|
822
|
-
-u, --unformatted
|
|
927
|
+
FLAGS
|
|
928
|
+
-j, --json print result in JSON format
|
|
929
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
930
|
+
-p, --print print out the modified resource
|
|
931
|
+
-u, --unformatted print JSON output without indentation
|
|
932
|
+
|
|
933
|
+
DESCRIPTION
|
|
934
|
+
Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.
|
|
823
935
|
```
|
|
824
936
|
|
|
825
937
|
_See code: [src/commands/order/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/cancel.ts)_
|
|
@@ -830,16 +942,19 @@ Send this attribute if you want to capture an approved order..
|
|
|
830
942
|
|
|
831
943
|
```
|
|
832
944
|
USAGE
|
|
833
|
-
$ commercelayer order:capture ID
|
|
945
|
+
$ commercelayer order:capture [ID] -o <value> [-u [-j -p]]
|
|
834
946
|
|
|
835
947
|
ARGUMENTS
|
|
836
948
|
ID the unique id of the resource
|
|
837
949
|
|
|
838
|
-
|
|
839
|
-
-j, --json
|
|
840
|
-
-o, --organization
|
|
841
|
-
-p, --print
|
|
842
|
-
-u, --unformatted
|
|
950
|
+
FLAGS
|
|
951
|
+
-j, --json print result in JSON format
|
|
952
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
953
|
+
-p, --print print out the modified resource
|
|
954
|
+
-u, --unformatted print JSON output without indentation
|
|
955
|
+
|
|
956
|
+
DESCRIPTION
|
|
957
|
+
Send this attribute if you want to capture an approved order.
|
|
843
958
|
```
|
|
844
959
|
|
|
845
960
|
_See code: [src/commands/order/capture.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/capture.ts)_
|
|
@@ -850,17 +965,20 @@ The id of the customer payment source (i.e. credit card) that you want to use as
|
|
|
850
965
|
|
|
851
966
|
```
|
|
852
967
|
USAGE
|
|
853
|
-
$ commercelayer order:customer_payment_source_id ID
|
|
968
|
+
$ commercelayer order:customer_payment_source_id [ID] -o <value> -v <value> [-u [-j -p]]
|
|
854
969
|
|
|
855
970
|
ARGUMENTS
|
|
856
971
|
ID the unique id of the resource
|
|
857
972
|
|
|
858
|
-
|
|
859
|
-
-j, --json
|
|
860
|
-
-o, --organization
|
|
861
|
-
-p, --print
|
|
862
|
-
-u, --unformatted
|
|
863
|
-
-v, --value
|
|
973
|
+
FLAGS
|
|
974
|
+
-j, --json print result in JSON format
|
|
975
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
976
|
+
-p, --print print out the modified resource
|
|
977
|
+
-u, --unformatted print JSON output without indentation
|
|
978
|
+
-v, --value=<value> (required) the trigger attribute value
|
|
979
|
+
|
|
980
|
+
DESCRIPTION
|
|
981
|
+
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.
|
|
864
982
|
```
|
|
865
983
|
|
|
866
984
|
_See code: [src/commands/order/customer_payment_source_id.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/customer_payment_source_id.ts)_
|
|
@@ -871,16 +989,19 @@ Send this attribute if you want to place the order..
|
|
|
871
989
|
|
|
872
990
|
```
|
|
873
991
|
USAGE
|
|
874
|
-
$ commercelayer order:place ID
|
|
992
|
+
$ commercelayer order:place [ID] -o <value> [-u [-j -p]]
|
|
875
993
|
|
|
876
994
|
ARGUMENTS
|
|
877
995
|
ID the unique id of the resource
|
|
878
996
|
|
|
879
|
-
|
|
880
|
-
-j, --json
|
|
881
|
-
-o, --organization
|
|
882
|
-
-p, --print
|
|
883
|
-
-u, --unformatted
|
|
997
|
+
FLAGS
|
|
998
|
+
-j, --json print result in JSON format
|
|
999
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1000
|
+
-p, --print print out the modified resource
|
|
1001
|
+
-u, --unformatted print JSON output without indentation
|
|
1002
|
+
|
|
1003
|
+
DESCRIPTION
|
|
1004
|
+
Send this attribute if you want to place the order.
|
|
884
1005
|
```
|
|
885
1006
|
|
|
886
1007
|
_See code: [src/commands/order/place.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/place.ts)_
|
|
@@ -891,16 +1012,19 @@ Send this attribute if you want to manually refresh the order..
|
|
|
891
1012
|
|
|
892
1013
|
```
|
|
893
1014
|
USAGE
|
|
894
|
-
$ commercelayer order:refresh ID
|
|
1015
|
+
$ commercelayer order:refresh [ID] -o <value> [-u [-j -p]]
|
|
895
1016
|
|
|
896
1017
|
ARGUMENTS
|
|
897
1018
|
ID the unique id of the resource
|
|
898
1019
|
|
|
899
|
-
|
|
900
|
-
-j, --json
|
|
901
|
-
-o, --organization
|
|
902
|
-
-p, --print
|
|
903
|
-
-u, --unformatted
|
|
1020
|
+
FLAGS
|
|
1021
|
+
-j, --json print result in JSON format
|
|
1022
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1023
|
+
-p, --print print out the modified resource
|
|
1024
|
+
-u, --unformatted print JSON output without indentation
|
|
1025
|
+
|
|
1026
|
+
DESCRIPTION
|
|
1027
|
+
Send this attribute if you want to manually refresh the order.
|
|
904
1028
|
```
|
|
905
1029
|
|
|
906
1030
|
_See code: [src/commands/order/refresh.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/refresh.ts)_
|
|
@@ -911,16 +1035,19 @@ Send this attribute if you want to refund a captured order..
|
|
|
911
1035
|
|
|
912
1036
|
```
|
|
913
1037
|
USAGE
|
|
914
|
-
$ commercelayer order:refund ID
|
|
1038
|
+
$ commercelayer order:refund [ID] -o <value> [-u [-j -p]]
|
|
915
1039
|
|
|
916
1040
|
ARGUMENTS
|
|
917
1041
|
ID the unique id of the resource
|
|
918
1042
|
|
|
919
|
-
|
|
920
|
-
-j, --json
|
|
921
|
-
-o, --organization
|
|
922
|
-
-p, --print
|
|
923
|
-
-u, --unformatted
|
|
1043
|
+
FLAGS
|
|
1044
|
+
-j, --json print result in JSON format
|
|
1045
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1046
|
+
-p, --print print out the modified resource
|
|
1047
|
+
-u, --unformatted print JSON output without indentation
|
|
1048
|
+
|
|
1049
|
+
DESCRIPTION
|
|
1050
|
+
Send this attribute if you want to refund a captured order.
|
|
924
1051
|
```
|
|
925
1052
|
|
|
926
1053
|
_See code: [src/commands/order/refund.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/refund.ts)_
|
|
@@ -931,16 +1058,20 @@ Send this attribute if you want the order's billing address to be saved in the c
|
|
|
931
1058
|
|
|
932
1059
|
```
|
|
933
1060
|
USAGE
|
|
934
|
-
$ commercelayer order:save_billing_address_to_customer_address_book ID
|
|
1061
|
+
$ commercelayer order:save_billing_address_to_customer_address_book [ID] -o <value> [-u [-j -p]]
|
|
935
1062
|
|
|
936
1063
|
ARGUMENTS
|
|
937
1064
|
ID the unique id of the resource
|
|
938
1065
|
|
|
939
|
-
|
|
940
|
-
-j, --json
|
|
941
|
-
-o, --organization
|
|
942
|
-
-p, --print
|
|
943
|
-
-u, --unformatted
|
|
1066
|
+
FLAGS
|
|
1067
|
+
-j, --json print result in JSON format
|
|
1068
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1069
|
+
-p, --print print out the modified resource
|
|
1070
|
+
-u, --unformatted print JSON output without indentation
|
|
1071
|
+
|
|
1072
|
+
DESCRIPTION
|
|
1073
|
+
Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer
|
|
1074
|
+
address.
|
|
944
1075
|
```
|
|
945
1076
|
|
|
946
1077
|
_See code: [src/commands/order/save_billing_address_to_customer_address_book.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/save_billing_address_to_customer_address_book.ts)_
|
|
@@ -951,16 +1082,20 @@ Send this attribute if you want the order's payment source to be saved in the cu
|
|
|
951
1082
|
|
|
952
1083
|
```
|
|
953
1084
|
USAGE
|
|
954
|
-
$ commercelayer order:save_payment_source_to_customer_wallet ID
|
|
1085
|
+
$ commercelayer order:save_payment_source_to_customer_wallet [ID] -o <value> [-u [-j -p]]
|
|
955
1086
|
|
|
956
1087
|
ARGUMENTS
|
|
957
1088
|
ID the unique id of the resource
|
|
958
1089
|
|
|
959
|
-
|
|
960
|
-
-j, --json
|
|
961
|
-
-o, --organization
|
|
962
|
-
-p, --print
|
|
963
|
-
-u, --unformatted
|
|
1090
|
+
FLAGS
|
|
1091
|
+
-j, --json print result in JSON format
|
|
1092
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1093
|
+
-p, --print print out the modified resource
|
|
1094
|
+
-u, --unformatted print JSON output without indentation
|
|
1095
|
+
|
|
1096
|
+
DESCRIPTION
|
|
1097
|
+
Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment
|
|
1098
|
+
source.
|
|
964
1099
|
```
|
|
965
1100
|
|
|
966
1101
|
_See code: [src/commands/order/save_payment_source_to_customer_wallet.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/save_payment_source_to_customer_wallet.ts)_
|
|
@@ -971,16 +1106,20 @@ Send this attribute if you want the order's shipping address to be saved in the
|
|
|
971
1106
|
|
|
972
1107
|
```
|
|
973
1108
|
USAGE
|
|
974
|
-
$ commercelayer order:save_shipping_address_to_customer_address_book ID
|
|
1109
|
+
$ commercelayer order:save_shipping_address_to_customer_address_book [ID] -o <value> [-u [-j -p]]
|
|
975
1110
|
|
|
976
1111
|
ARGUMENTS
|
|
977
1112
|
ID the unique id of the resource
|
|
978
1113
|
|
|
979
|
-
|
|
980
|
-
-j, --json
|
|
981
|
-
-o, --organization
|
|
982
|
-
-p, --print
|
|
983
|
-
-u, --unformatted
|
|
1114
|
+
FLAGS
|
|
1115
|
+
-j, --json print result in JSON format
|
|
1116
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1117
|
+
-p, --print print out the modified resource
|
|
1118
|
+
-u, --unformatted print JSON output without indentation
|
|
1119
|
+
|
|
1120
|
+
DESCRIPTION
|
|
1121
|
+
Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer
|
|
1122
|
+
address.
|
|
984
1123
|
```
|
|
985
1124
|
|
|
986
1125
|
_See code: [src/commands/order/save_shipping_address_to_customer_address_book.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/save_shipping_address_to_customer_address_book.ts)_
|
|
@@ -991,17 +1130,20 @@ The id of the address that you want to clone to create the order's shipping addr
|
|
|
991
1130
|
|
|
992
1131
|
```
|
|
993
1132
|
USAGE
|
|
994
|
-
$ commercelayer order:shipping_address_clone_id ID
|
|
1133
|
+
$ commercelayer order:shipping_address_clone_id [ID] -o <value> -v <value> [-u [-j -p]]
|
|
995
1134
|
|
|
996
1135
|
ARGUMENTS
|
|
997
1136
|
ID the unique id of the resource
|
|
998
1137
|
|
|
999
|
-
|
|
1000
|
-
-j, --json
|
|
1001
|
-
-o, --organization
|
|
1002
|
-
-p, --print
|
|
1003
|
-
-u, --unformatted
|
|
1004
|
-
-v, --value
|
|
1138
|
+
FLAGS
|
|
1139
|
+
-j, --json print result in JSON format
|
|
1140
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1141
|
+
-p, --print print out the modified resource
|
|
1142
|
+
-u, --unformatted print JSON output without indentation
|
|
1143
|
+
-v, --value=<value> (required) the trigger attribute value
|
|
1144
|
+
|
|
1145
|
+
DESCRIPTION
|
|
1146
|
+
The id of the address that you want to clone to create the order's shipping address.
|
|
1005
1147
|
```
|
|
1006
1148
|
|
|
1007
1149
|
_See code: [src/commands/order/shipping_address_clone_id.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/shipping_address_clone_id.ts)_
|
|
@@ -1012,16 +1154,19 @@ Send this attribute if you want the shipping address to be cloned from the order
|
|
|
1012
1154
|
|
|
1013
1155
|
```
|
|
1014
1156
|
USAGE
|
|
1015
|
-
$ commercelayer order:shipping_address_same_as_billing ID
|
|
1157
|
+
$ commercelayer order:shipping_address_same_as_billing [ID] -o <value> [-u [-j -p]]
|
|
1016
1158
|
|
|
1017
1159
|
ARGUMENTS
|
|
1018
1160
|
ID the unique id of the resource
|
|
1019
1161
|
|
|
1020
|
-
|
|
1021
|
-
-j, --json
|
|
1022
|
-
-o, --organization
|
|
1023
|
-
-p, --print
|
|
1024
|
-
-u, --unformatted
|
|
1162
|
+
FLAGS
|
|
1163
|
+
-j, --json print result in JSON format
|
|
1164
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1165
|
+
-p, --print print out the modified resource
|
|
1166
|
+
-u, --unformatted print JSON output without indentation
|
|
1167
|
+
|
|
1168
|
+
DESCRIPTION
|
|
1169
|
+
Send this attribute if you want the shipping address to be cloned from the order's billing address.
|
|
1025
1170
|
```
|
|
1026
1171
|
|
|
1027
1172
|
_See code: [src/commands/order/shipping_address_same_as_billing.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/shipping_address_same_as_billing.ts)_
|
|
@@ -1032,16 +1177,19 @@ Send this attribute if you want to unarchive the order..
|
|
|
1032
1177
|
|
|
1033
1178
|
```
|
|
1034
1179
|
USAGE
|
|
1035
|
-
$ commercelayer order:unarchive ID
|
|
1180
|
+
$ commercelayer order:unarchive [ID] -o <value> [-u [-j -p]]
|
|
1036
1181
|
|
|
1037
1182
|
ARGUMENTS
|
|
1038
1183
|
ID the unique id of the resource
|
|
1039
1184
|
|
|
1040
|
-
|
|
1041
|
-
-j, --json
|
|
1042
|
-
-o, --organization
|
|
1043
|
-
-p, --print
|
|
1044
|
-
-u, --unformatted
|
|
1185
|
+
FLAGS
|
|
1186
|
+
-j, --json print result in JSON format
|
|
1187
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1188
|
+
-p, --print print out the modified resource
|
|
1189
|
+
-u, --unformatted print JSON output without indentation
|
|
1190
|
+
|
|
1191
|
+
DESCRIPTION
|
|
1192
|
+
Send this attribute if you want to unarchive the order.
|
|
1045
1193
|
```
|
|
1046
1194
|
|
|
1047
1195
|
_See code: [src/commands/order/unarchive.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/unarchive.ts)_
|
|
@@ -1052,16 +1200,20 @@ Send this attribute if you want to force tax calculation for this order (a tax c
|
|
|
1052
1200
|
|
|
1053
1201
|
```
|
|
1054
1202
|
USAGE
|
|
1055
|
-
$ commercelayer order:update_taxes ID
|
|
1203
|
+
$ commercelayer order:update_taxes [ID] -o <value> [-u [-j -p]]
|
|
1056
1204
|
|
|
1057
1205
|
ARGUMENTS
|
|
1058
1206
|
ID the unique id of the resource
|
|
1059
1207
|
|
|
1060
|
-
|
|
1061
|
-
-j, --json
|
|
1062
|
-
-o, --organization
|
|
1063
|
-
-p, --print
|
|
1064
|
-
-u, --unformatted
|
|
1208
|
+
FLAGS
|
|
1209
|
+
-j, --json print result in JSON format
|
|
1210
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1211
|
+
-p, --print print out the modified resource
|
|
1212
|
+
-u, --unformatted print JSON output without indentation
|
|
1213
|
+
|
|
1214
|
+
DESCRIPTION
|
|
1215
|
+
Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the
|
|
1216
|
+
order's market).
|
|
1065
1217
|
```
|
|
1066
1218
|
|
|
1067
1219
|
_See code: [src/commands/order/update_taxes.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/update_taxes.ts)_
|
|
@@ -1072,16 +1224,19 @@ Execute an action on a resource of type order_subscriptions.
|
|
|
1072
1224
|
|
|
1073
1225
|
```
|
|
1074
1226
|
USAGE
|
|
1075
|
-
$ commercelayer order_subscription ID
|
|
1227
|
+
$ commercelayer order_subscription [ID] -o <value> [-u [-j -p]]
|
|
1076
1228
|
|
|
1077
1229
|
ARGUMENTS
|
|
1078
1230
|
ID the unique id of the resource
|
|
1079
1231
|
|
|
1080
|
-
|
|
1081
|
-
-j, --json
|
|
1082
|
-
-o, --organization
|
|
1083
|
-
-p, --print
|
|
1084
|
-
-u, --unformatted
|
|
1232
|
+
FLAGS
|
|
1233
|
+
-j, --json print result in JSON format
|
|
1234
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1235
|
+
-p, --print print out the modified resource
|
|
1236
|
+
-u, --unformatted print JSON output without indentation
|
|
1237
|
+
|
|
1238
|
+
DESCRIPTION
|
|
1239
|
+
execute an action on a resource of type order_subscriptions
|
|
1085
1240
|
```
|
|
1086
1241
|
|
|
1087
1242
|
_See code: [src/commands/order_subscription/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order_subscription/index.ts)_
|
|
@@ -1092,16 +1247,19 @@ Send this attribute if you want to mark this subscription as active..
|
|
|
1092
1247
|
|
|
1093
1248
|
```
|
|
1094
1249
|
USAGE
|
|
1095
|
-
$ commercelayer order_subscription:activate ID
|
|
1250
|
+
$ commercelayer order_subscription:activate [ID] -o <value> [-u [-j -p]]
|
|
1096
1251
|
|
|
1097
1252
|
ARGUMENTS
|
|
1098
1253
|
ID the unique id of the resource
|
|
1099
1254
|
|
|
1100
|
-
|
|
1101
|
-
-j, --json
|
|
1102
|
-
-o, --organization
|
|
1103
|
-
-p, --print
|
|
1104
|
-
-u, --unformatted
|
|
1255
|
+
FLAGS
|
|
1256
|
+
-j, --json print result in JSON format
|
|
1257
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1258
|
+
-p, --print print out the modified resource
|
|
1259
|
+
-u, --unformatted print JSON output without indentation
|
|
1260
|
+
|
|
1261
|
+
DESCRIPTION
|
|
1262
|
+
Send this attribute if you want to mark this subscription as active.
|
|
1105
1263
|
```
|
|
1106
1264
|
|
|
1107
1265
|
_See code: [src/commands/order_subscription/activate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order_subscription/activate.ts)_
|
|
@@ -1112,16 +1270,19 @@ Send this attribute if you want to mark this subscription as cancelled..
|
|
|
1112
1270
|
|
|
1113
1271
|
```
|
|
1114
1272
|
USAGE
|
|
1115
|
-
$ commercelayer order_subscription:cancel ID
|
|
1273
|
+
$ commercelayer order_subscription:cancel [ID] -o <value> [-u [-j -p]]
|
|
1116
1274
|
|
|
1117
1275
|
ARGUMENTS
|
|
1118
1276
|
ID the unique id of the resource
|
|
1119
1277
|
|
|
1120
|
-
|
|
1121
|
-
-j, --json
|
|
1122
|
-
-o, --organization
|
|
1123
|
-
-p, --print
|
|
1124
|
-
-u, --unformatted
|
|
1278
|
+
FLAGS
|
|
1279
|
+
-j, --json print result in JSON format
|
|
1280
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1281
|
+
-p, --print print out the modified resource
|
|
1282
|
+
-u, --unformatted print JSON output without indentation
|
|
1283
|
+
|
|
1284
|
+
DESCRIPTION
|
|
1285
|
+
Send this attribute if you want to mark this subscription as cancelled.
|
|
1125
1286
|
```
|
|
1126
1287
|
|
|
1127
1288
|
_See code: [src/commands/order_subscription/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order_subscription/cancel.ts)_
|
|
@@ -1132,16 +1293,19 @@ Send this attribute if you want to mark this subscription as inactive..
|
|
|
1132
1293
|
|
|
1133
1294
|
```
|
|
1134
1295
|
USAGE
|
|
1135
|
-
$ commercelayer order_subscription:deactivate ID
|
|
1296
|
+
$ commercelayer order_subscription:deactivate [ID] -o <value> [-u [-j -p]]
|
|
1136
1297
|
|
|
1137
1298
|
ARGUMENTS
|
|
1138
1299
|
ID the unique id of the resource
|
|
1139
1300
|
|
|
1140
|
-
|
|
1141
|
-
-j, --json
|
|
1142
|
-
-o, --organization
|
|
1143
|
-
-p, --print
|
|
1144
|
-
-u, --unformatted
|
|
1301
|
+
FLAGS
|
|
1302
|
+
-j, --json print result in JSON format
|
|
1303
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1304
|
+
-p, --print print out the modified resource
|
|
1305
|
+
-u, --unformatted print JSON output without indentation
|
|
1306
|
+
|
|
1307
|
+
DESCRIPTION
|
|
1308
|
+
Send this attribute if you want to mark this subscription as inactive.
|
|
1145
1309
|
```
|
|
1146
1310
|
|
|
1147
1311
|
_See code: [src/commands/order_subscription/deactivate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order_subscription/deactivate.ts)_
|
|
@@ -1152,16 +1316,19 @@ Execute an action on a resource of type returns.
|
|
|
1152
1316
|
|
|
1153
1317
|
```
|
|
1154
1318
|
USAGE
|
|
1155
|
-
$ commercelayer return ID
|
|
1319
|
+
$ commercelayer return [ID] -o <value> [-u [-j -p]]
|
|
1156
1320
|
|
|
1157
1321
|
ARGUMENTS
|
|
1158
1322
|
ID the unique id of the resource
|
|
1159
1323
|
|
|
1160
|
-
|
|
1161
|
-
-j, --json
|
|
1162
|
-
-o, --organization
|
|
1163
|
-
-p, --print
|
|
1164
|
-
-u, --unformatted
|
|
1324
|
+
FLAGS
|
|
1325
|
+
-j, --json print result in JSON format
|
|
1326
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1327
|
+
-p, --print print out the modified resource
|
|
1328
|
+
-u, --unformatted print JSON output without indentation
|
|
1329
|
+
|
|
1330
|
+
DESCRIPTION
|
|
1331
|
+
execute an action on a resource of type returns
|
|
1165
1332
|
```
|
|
1166
1333
|
|
|
1167
1334
|
_See code: [src/commands/return/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/index.ts)_
|
|
@@ -1172,16 +1339,19 @@ Send this attribute if you want to mark this return as approved..
|
|
|
1172
1339
|
|
|
1173
1340
|
```
|
|
1174
1341
|
USAGE
|
|
1175
|
-
$ commercelayer return:approve ID
|
|
1342
|
+
$ commercelayer return:approve [ID] -o <value> [-u [-j -p]]
|
|
1176
1343
|
|
|
1177
1344
|
ARGUMENTS
|
|
1178
1345
|
ID the unique id of the resource
|
|
1179
1346
|
|
|
1180
|
-
|
|
1181
|
-
-j, --json
|
|
1182
|
-
-o, --organization
|
|
1183
|
-
-p, --print
|
|
1184
|
-
-u, --unformatted
|
|
1347
|
+
FLAGS
|
|
1348
|
+
-j, --json print result in JSON format
|
|
1349
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1350
|
+
-p, --print print out the modified resource
|
|
1351
|
+
-u, --unformatted print JSON output without indentation
|
|
1352
|
+
|
|
1353
|
+
DESCRIPTION
|
|
1354
|
+
Send this attribute if you want to mark this return as approved.
|
|
1185
1355
|
```
|
|
1186
1356
|
|
|
1187
1357
|
_See code: [src/commands/return/approve.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/approve.ts)_
|
|
@@ -1192,16 +1362,19 @@ Send this attribute if you want to archive the return..
|
|
|
1192
1362
|
|
|
1193
1363
|
```
|
|
1194
1364
|
USAGE
|
|
1195
|
-
$ commercelayer return:archive ID
|
|
1365
|
+
$ commercelayer return:archive [ID] -o <value> [-u [-j -p]]
|
|
1196
1366
|
|
|
1197
1367
|
ARGUMENTS
|
|
1198
1368
|
ID the unique id of the resource
|
|
1199
1369
|
|
|
1200
|
-
|
|
1201
|
-
-j, --json
|
|
1202
|
-
-o, --organization
|
|
1203
|
-
-p, --print
|
|
1204
|
-
-u, --unformatted
|
|
1370
|
+
FLAGS
|
|
1371
|
+
-j, --json print result in JSON format
|
|
1372
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1373
|
+
-p, --print print out the modified resource
|
|
1374
|
+
-u, --unformatted print JSON output without indentation
|
|
1375
|
+
|
|
1376
|
+
DESCRIPTION
|
|
1377
|
+
Send this attribute if you want to archive the return.
|
|
1205
1378
|
```
|
|
1206
1379
|
|
|
1207
1380
|
_See code: [src/commands/return/archive.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/archive.ts)_
|
|
@@ -1212,16 +1385,19 @@ Send this attribute if you want to mark this return as cancelled..
|
|
|
1212
1385
|
|
|
1213
1386
|
```
|
|
1214
1387
|
USAGE
|
|
1215
|
-
$ commercelayer return:cancel ID
|
|
1388
|
+
$ commercelayer return:cancel [ID] -o <value> [-u [-j -p]]
|
|
1216
1389
|
|
|
1217
1390
|
ARGUMENTS
|
|
1218
1391
|
ID the unique id of the resource
|
|
1219
1392
|
|
|
1220
|
-
|
|
1221
|
-
-j, --json
|
|
1222
|
-
-o, --organization
|
|
1223
|
-
-p, --print
|
|
1224
|
-
-u, --unformatted
|
|
1393
|
+
FLAGS
|
|
1394
|
+
-j, --json print result in JSON format
|
|
1395
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1396
|
+
-p, --print print out the modified resource
|
|
1397
|
+
-u, --unformatted print JSON output without indentation
|
|
1398
|
+
|
|
1399
|
+
DESCRIPTION
|
|
1400
|
+
Send this attribute if you want to mark this return as cancelled.
|
|
1225
1401
|
```
|
|
1226
1402
|
|
|
1227
1403
|
_See code: [src/commands/return/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/cancel.ts)_
|
|
@@ -1232,16 +1408,19 @@ Send this attribute if you want to mark this return as received..
|
|
|
1232
1408
|
|
|
1233
1409
|
```
|
|
1234
1410
|
USAGE
|
|
1235
|
-
$ commercelayer return:receive ID
|
|
1411
|
+
$ commercelayer return:receive [ID] -o <value> [-u [-j -p]]
|
|
1236
1412
|
|
|
1237
1413
|
ARGUMENTS
|
|
1238
1414
|
ID the unique id of the resource
|
|
1239
1415
|
|
|
1240
|
-
|
|
1241
|
-
-j, --json
|
|
1242
|
-
-o, --organization
|
|
1243
|
-
-p, --print
|
|
1244
|
-
-u, --unformatted
|
|
1416
|
+
FLAGS
|
|
1417
|
+
-j, --json print result in JSON format
|
|
1418
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1419
|
+
-p, --print print out the modified resource
|
|
1420
|
+
-u, --unformatted print JSON output without indentation
|
|
1421
|
+
|
|
1422
|
+
DESCRIPTION
|
|
1423
|
+
Send this attribute if you want to mark this return as received.
|
|
1245
1424
|
```
|
|
1246
1425
|
|
|
1247
1426
|
_See code: [src/commands/return/receive.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/receive.ts)_
|
|
@@ -1252,16 +1431,19 @@ Send this attribute if you want to mark this return as rejected..
|
|
|
1252
1431
|
|
|
1253
1432
|
```
|
|
1254
1433
|
USAGE
|
|
1255
|
-
$ commercelayer return:reject ID
|
|
1434
|
+
$ commercelayer return:reject [ID] -o <value> [-u [-j -p]]
|
|
1256
1435
|
|
|
1257
1436
|
ARGUMENTS
|
|
1258
1437
|
ID the unique id of the resource
|
|
1259
1438
|
|
|
1260
|
-
|
|
1261
|
-
-j, --json
|
|
1262
|
-
-o, --organization
|
|
1263
|
-
-p, --print
|
|
1264
|
-
-u, --unformatted
|
|
1439
|
+
FLAGS
|
|
1440
|
+
-j, --json print result in JSON format
|
|
1441
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1442
|
+
-p, --print print out the modified resource
|
|
1443
|
+
-u, --unformatted print JSON output without indentation
|
|
1444
|
+
|
|
1445
|
+
DESCRIPTION
|
|
1446
|
+
Send this attribute if you want to mark this return as rejected.
|
|
1265
1447
|
```
|
|
1266
1448
|
|
|
1267
1449
|
_See code: [src/commands/return/reject.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/reject.ts)_
|
|
@@ -1272,16 +1454,19 @@ Send this attribute if you want to activate this return..
|
|
|
1272
1454
|
|
|
1273
1455
|
```
|
|
1274
1456
|
USAGE
|
|
1275
|
-
$ commercelayer return:request ID
|
|
1457
|
+
$ commercelayer return:request [ID] -o <value> [-u [-j -p]]
|
|
1276
1458
|
|
|
1277
1459
|
ARGUMENTS
|
|
1278
1460
|
ID the unique id of the resource
|
|
1279
1461
|
|
|
1280
|
-
|
|
1281
|
-
-j, --json
|
|
1282
|
-
-o, --organization
|
|
1283
|
-
-p, --print
|
|
1284
|
-
-u, --unformatted
|
|
1462
|
+
FLAGS
|
|
1463
|
+
-j, --json print result in JSON format
|
|
1464
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1465
|
+
-p, --print print out the modified resource
|
|
1466
|
+
-u, --unformatted print JSON output without indentation
|
|
1467
|
+
|
|
1468
|
+
DESCRIPTION
|
|
1469
|
+
Send this attribute if you want to activate this return.
|
|
1285
1470
|
```
|
|
1286
1471
|
|
|
1287
1472
|
_See code: [src/commands/return/request.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/request.ts)_
|
|
@@ -1292,16 +1477,19 @@ Send this attribute if you want to restock all of the return line items..
|
|
|
1292
1477
|
|
|
1293
1478
|
```
|
|
1294
1479
|
USAGE
|
|
1295
|
-
$ commercelayer return:restock ID
|
|
1480
|
+
$ commercelayer return:restock [ID] -o <value> [-u [-j -p]]
|
|
1296
1481
|
|
|
1297
1482
|
ARGUMENTS
|
|
1298
1483
|
ID the unique id of the resource
|
|
1299
1484
|
|
|
1300
|
-
|
|
1301
|
-
-j, --json
|
|
1302
|
-
-o, --organization
|
|
1303
|
-
-p, --print
|
|
1304
|
-
-u, --unformatted
|
|
1485
|
+
FLAGS
|
|
1486
|
+
-j, --json print result in JSON format
|
|
1487
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1488
|
+
-p, --print print out the modified resource
|
|
1489
|
+
-u, --unformatted print JSON output without indentation
|
|
1490
|
+
|
|
1491
|
+
DESCRIPTION
|
|
1492
|
+
Send this attribute if you want to restock all of the return line items.
|
|
1305
1493
|
```
|
|
1306
1494
|
|
|
1307
1495
|
_See code: [src/commands/return/restock.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/restock.ts)_
|
|
@@ -1312,16 +1500,19 @@ Send this attribute if you want to mark this return as shipped..
|
|
|
1312
1500
|
|
|
1313
1501
|
```
|
|
1314
1502
|
USAGE
|
|
1315
|
-
$ commercelayer return:ship ID
|
|
1503
|
+
$ commercelayer return:ship [ID] -o <value> [-u [-j -p]]
|
|
1316
1504
|
|
|
1317
1505
|
ARGUMENTS
|
|
1318
1506
|
ID the unique id of the resource
|
|
1319
1507
|
|
|
1320
|
-
|
|
1321
|
-
-j, --json
|
|
1322
|
-
-o, --organization
|
|
1323
|
-
-p, --print
|
|
1324
|
-
-u, --unformatted
|
|
1508
|
+
FLAGS
|
|
1509
|
+
-j, --json print result in JSON format
|
|
1510
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1511
|
+
-p, --print print out the modified resource
|
|
1512
|
+
-u, --unformatted print JSON output without indentation
|
|
1513
|
+
|
|
1514
|
+
DESCRIPTION
|
|
1515
|
+
Send this attribute if you want to mark this return as shipped.
|
|
1325
1516
|
```
|
|
1326
1517
|
|
|
1327
1518
|
_See code: [src/commands/return/ship.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/ship.ts)_
|
|
@@ -1332,16 +1523,19 @@ Send this attribute if you want to unarchive the return..
|
|
|
1332
1523
|
|
|
1333
1524
|
```
|
|
1334
1525
|
USAGE
|
|
1335
|
-
$ commercelayer return:unarchive ID
|
|
1526
|
+
$ commercelayer return:unarchive [ID] -o <value> [-u [-j -p]]
|
|
1336
1527
|
|
|
1337
1528
|
ARGUMENTS
|
|
1338
1529
|
ID the unique id of the resource
|
|
1339
1530
|
|
|
1340
|
-
|
|
1341
|
-
-j, --json
|
|
1342
|
-
-o, --organization
|
|
1343
|
-
-p, --print
|
|
1344
|
-
-u, --unformatted
|
|
1531
|
+
FLAGS
|
|
1532
|
+
-j, --json print result in JSON format
|
|
1533
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1534
|
+
-p, --print print out the modified resource
|
|
1535
|
+
-u, --unformatted print JSON output without indentation
|
|
1536
|
+
|
|
1537
|
+
DESCRIPTION
|
|
1538
|
+
Send this attribute if you want to unarchive the return.
|
|
1345
1539
|
```
|
|
1346
1540
|
|
|
1347
1541
|
_See code: [src/commands/return/unarchive.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/unarchive.ts)_
|
|
@@ -1352,16 +1546,19 @@ Execute an action on a resource of type return_line_items.
|
|
|
1352
1546
|
|
|
1353
1547
|
```
|
|
1354
1548
|
USAGE
|
|
1355
|
-
$ commercelayer return_line_item ID
|
|
1549
|
+
$ commercelayer return_line_item [ID] -o <value> [-u [-j -p]]
|
|
1356
1550
|
|
|
1357
1551
|
ARGUMENTS
|
|
1358
1552
|
ID the unique id of the resource
|
|
1359
1553
|
|
|
1360
|
-
|
|
1361
|
-
-j, --json
|
|
1362
|
-
-o, --organization
|
|
1363
|
-
-p, --print
|
|
1364
|
-
-u, --unformatted
|
|
1554
|
+
FLAGS
|
|
1555
|
+
-j, --json print result in JSON format
|
|
1556
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1557
|
+
-p, --print print out the modified resource
|
|
1558
|
+
-u, --unformatted print JSON output without indentation
|
|
1559
|
+
|
|
1560
|
+
DESCRIPTION
|
|
1561
|
+
execute an action on a resource of type return_line_items
|
|
1365
1562
|
```
|
|
1366
1563
|
|
|
1367
1564
|
_See code: [src/commands/return_line_item/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return_line_item/index.ts)_
|
|
@@ -1372,16 +1569,19 @@ Send this attribute if you want to restock the line item..
|
|
|
1372
1569
|
|
|
1373
1570
|
```
|
|
1374
1571
|
USAGE
|
|
1375
|
-
$ commercelayer return_line_item:restock ID
|
|
1572
|
+
$ commercelayer return_line_item:restock [ID] -o <value> [-u [-j -p]]
|
|
1376
1573
|
|
|
1377
1574
|
ARGUMENTS
|
|
1378
1575
|
ID the unique id of the resource
|
|
1379
1576
|
|
|
1380
|
-
|
|
1381
|
-
-j, --json
|
|
1382
|
-
-o, --organization
|
|
1383
|
-
-p, --print
|
|
1384
|
-
-u, --unformatted
|
|
1577
|
+
FLAGS
|
|
1578
|
+
-j, --json print result in JSON format
|
|
1579
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1580
|
+
-p, --print print out the modified resource
|
|
1581
|
+
-u, --unformatted print JSON output without indentation
|
|
1582
|
+
|
|
1583
|
+
DESCRIPTION
|
|
1584
|
+
Send this attribute if you want to restock the line item.
|
|
1385
1585
|
```
|
|
1386
1586
|
|
|
1387
1587
|
_See code: [src/commands/return_line_item/restock.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return_line_item/restock.ts)_
|
|
@@ -1392,16 +1592,19 @@ Execute an action on a resource of type shipments.
|
|
|
1392
1592
|
|
|
1393
1593
|
```
|
|
1394
1594
|
USAGE
|
|
1395
|
-
$ commercelayer shipment ID
|
|
1595
|
+
$ commercelayer shipment [ID] -o <value> [-u [-j -p]]
|
|
1396
1596
|
|
|
1397
1597
|
ARGUMENTS
|
|
1398
1598
|
ID the unique id of the resource
|
|
1399
1599
|
|
|
1400
|
-
|
|
1401
|
-
-j, --json
|
|
1402
|
-
-o, --organization
|
|
1403
|
-
-p, --print
|
|
1404
|
-
-u, --unformatted
|
|
1600
|
+
FLAGS
|
|
1601
|
+
-j, --json print result in JSON format
|
|
1602
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1603
|
+
-p, --print print out the modified resource
|
|
1604
|
+
-u, --unformatted print JSON output without indentation
|
|
1605
|
+
|
|
1606
|
+
DESCRIPTION
|
|
1607
|
+
execute an action on a resource of type shipments
|
|
1405
1608
|
```
|
|
1406
1609
|
|
|
1407
1610
|
_See code: [src/commands/shipment/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/index.ts)_
|
|
@@ -1412,16 +1615,19 @@ Send this attribute if you want get the shipping rates from the associated carri
|
|
|
1412
1615
|
|
|
1413
1616
|
```
|
|
1414
1617
|
USAGE
|
|
1415
|
-
$ commercelayer shipment:get_rates ID
|
|
1618
|
+
$ commercelayer shipment:get_rates [ID] -o <value> [-u [-j -p]]
|
|
1416
1619
|
|
|
1417
1620
|
ARGUMENTS
|
|
1418
1621
|
ID the unique id of the resource
|
|
1419
1622
|
|
|
1420
|
-
|
|
1421
|
-
-j, --json
|
|
1422
|
-
-o, --organization
|
|
1423
|
-
-p, --print
|
|
1424
|
-
-u, --unformatted
|
|
1623
|
+
FLAGS
|
|
1624
|
+
-j, --json print result in JSON format
|
|
1625
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1626
|
+
-p, --print print out the modified resource
|
|
1627
|
+
-u, --unformatted print JSON output without indentation
|
|
1628
|
+
|
|
1629
|
+
DESCRIPTION
|
|
1630
|
+
Send this attribute if you want get the shipping rates from the associated carrier accounts.
|
|
1425
1631
|
```
|
|
1426
1632
|
|
|
1427
1633
|
_See code: [src/commands/shipment/get_rates.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/get_rates.ts)_
|
|
@@ -1432,16 +1638,19 @@ Send this attribute if you want to put this shipment on hold..
|
|
|
1432
1638
|
|
|
1433
1639
|
```
|
|
1434
1640
|
USAGE
|
|
1435
|
-
$ commercelayer shipment:on_hold ID
|
|
1641
|
+
$ commercelayer shipment:on_hold [ID] -o <value> [-u [-j -p]]
|
|
1436
1642
|
|
|
1437
1643
|
ARGUMENTS
|
|
1438
1644
|
ID the unique id of the resource
|
|
1439
1645
|
|
|
1440
|
-
|
|
1441
|
-
-j, --json
|
|
1442
|
-
-o, --organization
|
|
1443
|
-
-p, --print
|
|
1444
|
-
-u, --unformatted
|
|
1646
|
+
FLAGS
|
|
1647
|
+
-j, --json print result in JSON format
|
|
1648
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1649
|
+
-p, --print print out the modified resource
|
|
1650
|
+
-u, --unformatted print JSON output without indentation
|
|
1651
|
+
|
|
1652
|
+
DESCRIPTION
|
|
1653
|
+
Send this attribute if you want to put this shipment on hold.
|
|
1445
1654
|
```
|
|
1446
1655
|
|
|
1447
1656
|
_See code: [src/commands/shipment/on_hold.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/on_hold.ts)_
|
|
@@ -1452,16 +1661,19 @@ Send this attribute if you want to start packing this shipment..
|
|
|
1452
1661
|
|
|
1453
1662
|
```
|
|
1454
1663
|
USAGE
|
|
1455
|
-
$ commercelayer shipment:packing ID
|
|
1664
|
+
$ commercelayer shipment:packing [ID] -o <value> [-u [-j -p]]
|
|
1456
1665
|
|
|
1457
1666
|
ARGUMENTS
|
|
1458
1667
|
ID the unique id of the resource
|
|
1459
1668
|
|
|
1460
|
-
|
|
1461
|
-
-j, --json
|
|
1462
|
-
-o, --organization
|
|
1463
|
-
-p, --print
|
|
1464
|
-
-u, --unformatted
|
|
1669
|
+
FLAGS
|
|
1670
|
+
-j, --json print result in JSON format
|
|
1671
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1672
|
+
-p, --print print out the modified resource
|
|
1673
|
+
-u, --unformatted print JSON output without indentation
|
|
1674
|
+
|
|
1675
|
+
DESCRIPTION
|
|
1676
|
+
Send this attribute if you want to start packing this shipment.
|
|
1465
1677
|
```
|
|
1466
1678
|
|
|
1467
1679
|
_See code: [src/commands/shipment/packing.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/packing.ts)_
|
|
@@ -1472,16 +1684,19 @@ Send this attribute if you want to start picking this shipment..
|
|
|
1472
1684
|
|
|
1473
1685
|
```
|
|
1474
1686
|
USAGE
|
|
1475
|
-
$ commercelayer shipment:picking ID
|
|
1687
|
+
$ commercelayer shipment:picking [ID] -o <value> [-u [-j -p]]
|
|
1476
1688
|
|
|
1477
1689
|
ARGUMENTS
|
|
1478
1690
|
ID the unique id of the resource
|
|
1479
1691
|
|
|
1480
|
-
|
|
1481
|
-
-j, --json
|
|
1482
|
-
-o, --organization
|
|
1483
|
-
-p, --print
|
|
1484
|
-
-u, --unformatted
|
|
1692
|
+
FLAGS
|
|
1693
|
+
-j, --json print result in JSON format
|
|
1694
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1695
|
+
-p, --print print out the modified resource
|
|
1696
|
+
-u, --unformatted print JSON output without indentation
|
|
1697
|
+
|
|
1698
|
+
DESCRIPTION
|
|
1699
|
+
Send this attribute if you want to start picking this shipment.
|
|
1485
1700
|
```
|
|
1486
1701
|
|
|
1487
1702
|
_See code: [src/commands/shipment/picking.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/picking.ts)_
|
|
@@ -1492,16 +1707,19 @@ Send this attribute if you want to purchase this shipment with the selected rate
|
|
|
1492
1707
|
|
|
1493
1708
|
```
|
|
1494
1709
|
USAGE
|
|
1495
|
-
$ commercelayer shipment:purchase ID
|
|
1710
|
+
$ commercelayer shipment:purchase [ID] -o <value> [-u [-j -p]]
|
|
1496
1711
|
|
|
1497
1712
|
ARGUMENTS
|
|
1498
1713
|
ID the unique id of the resource
|
|
1499
1714
|
|
|
1500
|
-
|
|
1501
|
-
-j, --json
|
|
1502
|
-
-o, --organization
|
|
1503
|
-
-p, --print
|
|
1504
|
-
-u, --unformatted
|
|
1715
|
+
FLAGS
|
|
1716
|
+
-j, --json print result in JSON format
|
|
1717
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1718
|
+
-p, --print print out the modified resource
|
|
1719
|
+
-u, --unformatted print JSON output without indentation
|
|
1720
|
+
|
|
1721
|
+
DESCRIPTION
|
|
1722
|
+
Send this attribute if you want to purchase this shipment with the selected rate.
|
|
1505
1723
|
```
|
|
1506
1724
|
|
|
1507
1725
|
_See code: [src/commands/shipment/purchase.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/purchase.ts)_
|
|
@@ -1512,16 +1730,19 @@ Send this attribute if you want to mark this shipment as ready to ship..
|
|
|
1512
1730
|
|
|
1513
1731
|
```
|
|
1514
1732
|
USAGE
|
|
1515
|
-
$ commercelayer shipment:ready_to_ship ID
|
|
1733
|
+
$ commercelayer shipment:ready_to_ship [ID] -o <value> [-u [-j -p]]
|
|
1516
1734
|
|
|
1517
1735
|
ARGUMENTS
|
|
1518
1736
|
ID the unique id of the resource
|
|
1519
1737
|
|
|
1520
|
-
|
|
1521
|
-
-j, --json
|
|
1522
|
-
-o, --organization
|
|
1523
|
-
-p, --print
|
|
1524
|
-
-u, --unformatted
|
|
1738
|
+
FLAGS
|
|
1739
|
+
-j, --json print result in JSON format
|
|
1740
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1741
|
+
-p, --print print out the modified resource
|
|
1742
|
+
-u, --unformatted print JSON output without indentation
|
|
1743
|
+
|
|
1744
|
+
DESCRIPTION
|
|
1745
|
+
Send this attribute if you want to mark this shipment as ready to ship.
|
|
1525
1746
|
```
|
|
1526
1747
|
|
|
1527
1748
|
_See code: [src/commands/shipment/ready_to_ship.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/ready_to_ship.ts)_
|
|
@@ -1532,16 +1753,19 @@ Send this attribute if you want to mark this shipment as shipped..
|
|
|
1532
1753
|
|
|
1533
1754
|
```
|
|
1534
1755
|
USAGE
|
|
1535
|
-
$ commercelayer shipment:ship ID
|
|
1756
|
+
$ commercelayer shipment:ship [ID] -o <value> [-u [-j -p]]
|
|
1536
1757
|
|
|
1537
1758
|
ARGUMENTS
|
|
1538
1759
|
ID the unique id of the resource
|
|
1539
1760
|
|
|
1540
|
-
|
|
1541
|
-
-j, --json
|
|
1542
|
-
-o, --organization
|
|
1543
|
-
-p, --print
|
|
1544
|
-
-u, --unformatted
|
|
1761
|
+
FLAGS
|
|
1762
|
+
-j, --json print result in JSON format
|
|
1763
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1764
|
+
-p, --print print out the modified resource
|
|
1765
|
+
-u, --unformatted print JSON output without indentation
|
|
1766
|
+
|
|
1767
|
+
DESCRIPTION
|
|
1768
|
+
Send this attribute if you want to mark this shipment as shipped.
|
|
1545
1769
|
```
|
|
1546
1770
|
|
|
1547
1771
|
_See code: [src/commands/shipment/ship.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/ship.ts)_
|
|
@@ -1552,16 +1776,19 @@ Execute an action on a resource of type stock_transfers.
|
|
|
1552
1776
|
|
|
1553
1777
|
```
|
|
1554
1778
|
USAGE
|
|
1555
|
-
$ commercelayer stock_transfer ID
|
|
1779
|
+
$ commercelayer stock_transfer [ID] -o <value> [-u [-j -p]]
|
|
1556
1780
|
|
|
1557
1781
|
ARGUMENTS
|
|
1558
1782
|
ID the unique id of the resource
|
|
1559
1783
|
|
|
1560
|
-
|
|
1561
|
-
-j, --json
|
|
1562
|
-
-o, --organization
|
|
1563
|
-
-p, --print
|
|
1564
|
-
-u, --unformatted
|
|
1784
|
+
FLAGS
|
|
1785
|
+
-j, --json print result in JSON format
|
|
1786
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1787
|
+
-p, --print print out the modified resource
|
|
1788
|
+
-u, --unformatted print JSON output without indentation
|
|
1789
|
+
|
|
1790
|
+
DESCRIPTION
|
|
1791
|
+
execute an action on a resource of type stock_transfers
|
|
1565
1792
|
```
|
|
1566
1793
|
|
|
1567
1794
|
_See code: [src/commands/stock_transfer/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stock_transfer/index.ts)_
|
|
@@ -1572,16 +1799,19 @@ Send this attribute if you want to cancel this stock transfer..
|
|
|
1572
1799
|
|
|
1573
1800
|
```
|
|
1574
1801
|
USAGE
|
|
1575
|
-
$ commercelayer stock_transfer:cancel ID
|
|
1802
|
+
$ commercelayer stock_transfer:cancel [ID] -o <value> [-u [-j -p]]
|
|
1576
1803
|
|
|
1577
1804
|
ARGUMENTS
|
|
1578
1805
|
ID the unique id of the resource
|
|
1579
1806
|
|
|
1580
|
-
|
|
1581
|
-
-j, --json
|
|
1582
|
-
-o, --organization
|
|
1583
|
-
-p, --print
|
|
1584
|
-
-u, --unformatted
|
|
1807
|
+
FLAGS
|
|
1808
|
+
-j, --json print result in JSON format
|
|
1809
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1810
|
+
-p, --print print out the modified resource
|
|
1811
|
+
-u, --unformatted print JSON output without indentation
|
|
1812
|
+
|
|
1813
|
+
DESCRIPTION
|
|
1814
|
+
Send this attribute if you want to cancel this stock transfer.
|
|
1585
1815
|
```
|
|
1586
1816
|
|
|
1587
1817
|
_See code: [src/commands/stock_transfer/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stock_transfer/cancel.ts)_
|
|
@@ -1592,16 +1822,19 @@ Send this attribute if you want to complete this stock transfer..
|
|
|
1592
1822
|
|
|
1593
1823
|
```
|
|
1594
1824
|
USAGE
|
|
1595
|
-
$ commercelayer stock_transfer:complete ID
|
|
1825
|
+
$ commercelayer stock_transfer:complete [ID] -o <value> [-u [-j -p]]
|
|
1596
1826
|
|
|
1597
1827
|
ARGUMENTS
|
|
1598
1828
|
ID the unique id of the resource
|
|
1599
1829
|
|
|
1600
|
-
|
|
1601
|
-
-j, --json
|
|
1602
|
-
-o, --organization
|
|
1603
|
-
-p, --print
|
|
1604
|
-
-u, --unformatted
|
|
1830
|
+
FLAGS
|
|
1831
|
+
-j, --json print result in JSON format
|
|
1832
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1833
|
+
-p, --print print out the modified resource
|
|
1834
|
+
-u, --unformatted print JSON output without indentation
|
|
1835
|
+
|
|
1836
|
+
DESCRIPTION
|
|
1837
|
+
Send this attribute if you want to complete this stock transfer.
|
|
1605
1838
|
```
|
|
1606
1839
|
|
|
1607
1840
|
_See code: [src/commands/stock_transfer/complete.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stock_transfer/complete.ts)_
|
|
@@ -1612,16 +1845,19 @@ Send this attribute if you want to mark this stock transfer as in transit..
|
|
|
1612
1845
|
|
|
1613
1846
|
```
|
|
1614
1847
|
USAGE
|
|
1615
|
-
$ commercelayer stock_transfer:in_transit ID
|
|
1848
|
+
$ commercelayer stock_transfer:in_transit [ID] -o <value> [-u [-j -p]]
|
|
1616
1849
|
|
|
1617
1850
|
ARGUMENTS
|
|
1618
1851
|
ID the unique id of the resource
|
|
1619
1852
|
|
|
1620
|
-
|
|
1621
|
-
-j, --json
|
|
1622
|
-
-o, --organization
|
|
1623
|
-
-p, --print
|
|
1624
|
-
-u, --unformatted
|
|
1853
|
+
FLAGS
|
|
1854
|
+
-j, --json print result in JSON format
|
|
1855
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1856
|
+
-p, --print print out the modified resource
|
|
1857
|
+
-u, --unformatted print JSON output without indentation
|
|
1858
|
+
|
|
1859
|
+
DESCRIPTION
|
|
1860
|
+
Send this attribute if you want to mark this stock transfer as in transit.
|
|
1625
1861
|
```
|
|
1626
1862
|
|
|
1627
1863
|
_See code: [src/commands/stock_transfer/in_transit.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stock_transfer/in_transit.ts)_
|
|
@@ -1632,16 +1868,19 @@ Send this attribute if you want to start picking this stock transfer..
|
|
|
1632
1868
|
|
|
1633
1869
|
```
|
|
1634
1870
|
USAGE
|
|
1635
|
-
$ commercelayer stock_transfer:picking ID
|
|
1871
|
+
$ commercelayer stock_transfer:picking [ID] -o <value> [-u [-j -p]]
|
|
1636
1872
|
|
|
1637
1873
|
ARGUMENTS
|
|
1638
1874
|
ID the unique id of the resource
|
|
1639
1875
|
|
|
1640
|
-
|
|
1641
|
-
-j, --json
|
|
1642
|
-
-o, --organization
|
|
1643
|
-
-p, --print
|
|
1644
|
-
-u, --unformatted
|
|
1876
|
+
FLAGS
|
|
1877
|
+
-j, --json print result in JSON format
|
|
1878
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1879
|
+
-p, --print print out the modified resource
|
|
1880
|
+
-u, --unformatted print JSON output without indentation
|
|
1881
|
+
|
|
1882
|
+
DESCRIPTION
|
|
1883
|
+
Send this attribute if you want to start picking this stock transfer.
|
|
1645
1884
|
```
|
|
1646
1885
|
|
|
1647
1886
|
_See code: [src/commands/stock_transfer/picking.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stock_transfer/picking.ts)_
|
|
@@ -1652,16 +1891,19 @@ Send this attribute if you want to mark this stock transfer as upcoming..
|
|
|
1652
1891
|
|
|
1653
1892
|
```
|
|
1654
1893
|
USAGE
|
|
1655
|
-
$ commercelayer stock_transfer:upcoming ID
|
|
1894
|
+
$ commercelayer stock_transfer:upcoming [ID] -o <value> [-u [-j -p]]
|
|
1656
1895
|
|
|
1657
1896
|
ARGUMENTS
|
|
1658
1897
|
ID the unique id of the resource
|
|
1659
1898
|
|
|
1660
|
-
|
|
1661
|
-
-j, --json
|
|
1662
|
-
-o, --organization
|
|
1663
|
-
-p, --print
|
|
1664
|
-
-u, --unformatted
|
|
1899
|
+
FLAGS
|
|
1900
|
+
-j, --json print result in JSON format
|
|
1901
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1902
|
+
-p, --print print out the modified resource
|
|
1903
|
+
-u, --unformatted print JSON output without indentation
|
|
1904
|
+
|
|
1905
|
+
DESCRIPTION
|
|
1906
|
+
Send this attribute if you want to mark this stock transfer as upcoming.
|
|
1665
1907
|
```
|
|
1666
1908
|
|
|
1667
1909
|
_See code: [src/commands/stock_transfer/upcoming.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stock_transfer/upcoming.ts)_
|
|
@@ -1672,16 +1914,19 @@ Execute an action on a resource of type stripe_payments.
|
|
|
1672
1914
|
|
|
1673
1915
|
```
|
|
1674
1916
|
USAGE
|
|
1675
|
-
$ commercelayer stripe_payment ID
|
|
1917
|
+
$ commercelayer stripe_payment [ID] -o <value> [-u [-j -p]]
|
|
1676
1918
|
|
|
1677
1919
|
ARGUMENTS
|
|
1678
1920
|
ID the unique id of the resource
|
|
1679
1921
|
|
|
1680
|
-
|
|
1681
|
-
-j, --json
|
|
1682
|
-
-o, --organization
|
|
1683
|
-
-p, --print
|
|
1684
|
-
-u, --unformatted
|
|
1922
|
+
FLAGS
|
|
1923
|
+
-j, --json print result in JSON format
|
|
1924
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1925
|
+
-p, --print print out the modified resource
|
|
1926
|
+
-u, --unformatted print JSON output without indentation
|
|
1927
|
+
|
|
1928
|
+
DESCRIPTION
|
|
1929
|
+
execute an action on a resource of type stripe_payments
|
|
1685
1930
|
```
|
|
1686
1931
|
|
|
1687
1932
|
_See code: [src/commands/stripe_payment/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stripe_payment/index.ts)_
|
|
@@ -1692,16 +1937,19 @@ Send this attribute if you want to refresh the payment status, can be used as we
|
|
|
1692
1937
|
|
|
1693
1938
|
```
|
|
1694
1939
|
USAGE
|
|
1695
|
-
$ commercelayer stripe_payment:refresh ID
|
|
1940
|
+
$ commercelayer stripe_payment:refresh [ID] -o <value> [-u [-j -p]]
|
|
1696
1941
|
|
|
1697
1942
|
ARGUMENTS
|
|
1698
1943
|
ID the unique id of the resource
|
|
1699
1944
|
|
|
1700
|
-
|
|
1701
|
-
-j, --json
|
|
1702
|
-
-o, --organization
|
|
1703
|
-
-p, --print
|
|
1704
|
-
-u, --unformatted
|
|
1945
|
+
FLAGS
|
|
1946
|
+
-j, --json print result in JSON format
|
|
1947
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1948
|
+
-p, --print print out the modified resource
|
|
1949
|
+
-u, --unformatted print JSON output without indentation
|
|
1950
|
+
|
|
1951
|
+
DESCRIPTION
|
|
1952
|
+
Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.
|
|
1705
1953
|
```
|
|
1706
1954
|
|
|
1707
1955
|
_See code: [src/commands/stripe_payment/refresh.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/stripe_payment/refresh.ts)_
|
|
@@ -1712,16 +1960,19 @@ Execute an action on a resource of type webhooks.
|
|
|
1712
1960
|
|
|
1713
1961
|
```
|
|
1714
1962
|
USAGE
|
|
1715
|
-
$ commercelayer webhook ID
|
|
1963
|
+
$ commercelayer webhook [ID] -o <value> [-u [-j -p]]
|
|
1716
1964
|
|
|
1717
1965
|
ARGUMENTS
|
|
1718
1966
|
ID the unique id of the resource
|
|
1719
1967
|
|
|
1720
|
-
|
|
1721
|
-
-j, --json
|
|
1722
|
-
-o, --organization
|
|
1723
|
-
-p, --print
|
|
1724
|
-
-u, --unformatted
|
|
1968
|
+
FLAGS
|
|
1969
|
+
-j, --json print result in JSON format
|
|
1970
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1971
|
+
-p, --print print out the modified resource
|
|
1972
|
+
-u, --unformatted print JSON output without indentation
|
|
1973
|
+
|
|
1974
|
+
DESCRIPTION
|
|
1975
|
+
execute an action on a resource of type webhooks
|
|
1725
1976
|
```
|
|
1726
1977
|
|
|
1727
1978
|
_See code: [src/commands/webhook/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/webhook/index.ts)_
|
|
@@ -1732,16 +1983,20 @@ Send this attribute if you want to reset the circuit breaker associated to this
|
|
|
1732
1983
|
|
|
1733
1984
|
```
|
|
1734
1985
|
USAGE
|
|
1735
|
-
$ commercelayer webhook:reset_circuit ID
|
|
1986
|
+
$ commercelayer webhook:reset_circuit [ID] -o <value> [-u [-j -p]]
|
|
1736
1987
|
|
|
1737
1988
|
ARGUMENTS
|
|
1738
1989
|
ID the unique id of the resource
|
|
1739
1990
|
|
|
1740
|
-
|
|
1741
|
-
-j, --json
|
|
1742
|
-
-o, --organization
|
|
1743
|
-
-p, --print
|
|
1744
|
-
-u, --unformatted
|
|
1991
|
+
FLAGS
|
|
1992
|
+
-j, --json print result in JSON format
|
|
1993
|
+
-o, --organization=<value> (required) the slug of your organization
|
|
1994
|
+
-p, --print print out the modified resource
|
|
1995
|
+
-u, --unformatted print JSON output without indentation
|
|
1996
|
+
|
|
1997
|
+
DESCRIPTION
|
|
1998
|
+
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero
|
|
1999
|
+
failures count.
|
|
1745
2000
|
```
|
|
1746
2001
|
|
|
1747
2002
|
_See code: [src/commands/webhook/reset_circuit.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/webhook/reset_circuit.ts)_
|