@n8n-dev/n8n-nodes-googleapis-shoppingcontent 1.0.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/README.md +263 -0
- package/dist/banner.svg +126 -0
- package/dist/credentials/GoogleapisShoppingcontentApi.credentials.d.ts +9 -0
- package/dist/credentials/GoogleapisShoppingcontentApi.credentials.js +49 -0
- package/dist/credentials/GoogleapisShoppingcontentApi.credentials.js.map +1 -0
- package/dist/icons/googleapis-shoppingcontent.dark.svg +21 -0
- package/dist/icons/googleapis-shoppingcontent.svg +21 -0
- package/dist/nodes/GoogleapisShoppingcontent/GoogleapisShoppingcontent.node.d.ts +4 -0
- package/dist/nodes/GoogleapisShoppingcontent/GoogleapisShoppingcontent.node.js +145 -0
- package/dist/nodes/GoogleapisShoppingcontent/GoogleapisShoppingcontent.node.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/GoogleapisShoppingcontent.node.json +20 -0
- package/dist/nodes/GoogleapisShoppingcontent/googleapis-shoppingcontent.dark.svg +21 -0
- package/dist/nodes/GoogleapisShoppingcontent/googleapis-shoppingcontent.svg +21 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accounts/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accounts/index.js +1417 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accounts/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accountstatuses/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accountstatuses/index.js +294 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accountstatuses/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accounttax/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accounttax/index.js +436 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/accounttax/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/datafeeds/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/datafeeds/index.js +1219 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/datafeeds/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/datafeedstatuses/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/datafeedstatuses/index.js +294 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/datafeedstatuses/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/index.d.ts +14 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/index.js +32 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/liasettings/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/liasettings/index.js +1026 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/liasettings/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderinvoices/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderinvoices/index.js +406 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderinvoices/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderreports/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderreports/index.js +338 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderreports/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderreturns/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderreturns/index.js +273 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orderreturns/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orders/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orders/index.js +3570 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/orders/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/pos/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/pos/index.js +1266 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/pos/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/products/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/products/index.js +2435 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/products/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/productstatuses/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/productstatuses/index.js +394 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/productstatuses/index.js.map +1 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/shippingsettings/index.d.ts +2 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/shippingsettings/index.js +608 -0
- package/dist/nodes/GoogleapisShoppingcontent/resources/shippingsettings/index.js.map +1 -0
- package/dist/package.json +62 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +62 -0
|
@@ -0,0 +1,3570 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ordersDescription = void 0;
|
|
4
|
+
exports.ordersDescription = [
|
|
5
|
+
{
|
|
6
|
+
"displayName": "Operation",
|
|
7
|
+
"name": "operation",
|
|
8
|
+
"type": "options",
|
|
9
|
+
"noDataExpression": true,
|
|
10
|
+
"displayOptions": {
|
|
11
|
+
"show": {
|
|
12
|
+
"resource": [
|
|
13
|
+
"Orders"
|
|
14
|
+
]
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"options": [
|
|
18
|
+
{
|
|
19
|
+
"name": "Content Orders Custombatch",
|
|
20
|
+
"value": "Content Orders Custombatch",
|
|
21
|
+
"action": "Content Orders Custombatch",
|
|
22
|
+
"description": "Retrieves or modifies multiple orders in a single request.",
|
|
23
|
+
"routing": {
|
|
24
|
+
"request": {
|
|
25
|
+
"method": "POST",
|
|
26
|
+
"url": "=/orders/batch"
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"name": "Content Orders List",
|
|
32
|
+
"value": "Content Orders List",
|
|
33
|
+
"action": "Content Orders List",
|
|
34
|
+
"description": "Lists the orders in your Merchant Center account.",
|
|
35
|
+
"routing": {
|
|
36
|
+
"request": {
|
|
37
|
+
"method": "GET",
|
|
38
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"name": "Content Orders Get",
|
|
44
|
+
"value": "Content Orders Get",
|
|
45
|
+
"action": "Content Orders Get",
|
|
46
|
+
"description": "Retrieves an order from your Merchant Center account.",
|
|
47
|
+
"routing": {
|
|
48
|
+
"request": {
|
|
49
|
+
"method": "GET",
|
|
50
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "Content Orders Acknowledge",
|
|
56
|
+
"value": "Content Orders Acknowledge",
|
|
57
|
+
"action": "Content Orders Acknowledge",
|
|
58
|
+
"description": "Marks an order as acknowledged.",
|
|
59
|
+
"routing": {
|
|
60
|
+
"request": {
|
|
61
|
+
"method": "POST",
|
|
62
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/acknowledge"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "Content Orders Cancel",
|
|
68
|
+
"value": "Content Orders Cancel",
|
|
69
|
+
"action": "Content Orders Cancel",
|
|
70
|
+
"description": "Cancels all line items in an order, making a full refund.",
|
|
71
|
+
"routing": {
|
|
72
|
+
"request": {
|
|
73
|
+
"method": "POST",
|
|
74
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/cancel"
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "Content Orders Cancellineitem",
|
|
80
|
+
"value": "Content Orders Cancellineitem",
|
|
81
|
+
"action": "Content Orders Cancellineitem",
|
|
82
|
+
"description": "Cancels a line item, making a full refund.",
|
|
83
|
+
"routing": {
|
|
84
|
+
"request": {
|
|
85
|
+
"method": "POST",
|
|
86
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/cancelLineItem"
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"name": "Content Orders Instorerefundlineitem",
|
|
92
|
+
"value": "Content Orders Instorerefundlineitem",
|
|
93
|
+
"action": "Content Orders Instorerefundlineitem",
|
|
94
|
+
"description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.",
|
|
95
|
+
"routing": {
|
|
96
|
+
"request": {
|
|
97
|
+
"method": "POST",
|
|
98
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/inStoreRefundLineItem"
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"name": "Content Orders Refund",
|
|
104
|
+
"value": "Content Orders Refund",
|
|
105
|
+
"action": "Content Orders Refund",
|
|
106
|
+
"description": "Deprecated, please use returnRefundLineItem instead.",
|
|
107
|
+
"routing": {
|
|
108
|
+
"request": {
|
|
109
|
+
"method": "POST",
|
|
110
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/refund"
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "Content Orders Rejectreturnlineitem",
|
|
116
|
+
"value": "Content Orders Rejectreturnlineitem",
|
|
117
|
+
"action": "Content Orders Rejectreturnlineitem",
|
|
118
|
+
"description": "Rejects return on an line item.",
|
|
119
|
+
"routing": {
|
|
120
|
+
"request": {
|
|
121
|
+
"method": "POST",
|
|
122
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/rejectReturnLineItem"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"name": "Content Orders Returnlineitem",
|
|
128
|
+
"value": "Content Orders Returnlineitem",
|
|
129
|
+
"action": "Content Orders Returnlineitem",
|
|
130
|
+
"description": "Returns a line item.",
|
|
131
|
+
"routing": {
|
|
132
|
+
"request": {
|
|
133
|
+
"method": "POST",
|
|
134
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/returnLineItem"
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "Content Orders Returnrefundlineitem",
|
|
140
|
+
"value": "Content Orders Returnrefundlineitem",
|
|
141
|
+
"action": "Content Orders Returnrefundlineitem",
|
|
142
|
+
"description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.",
|
|
143
|
+
"routing": {
|
|
144
|
+
"request": {
|
|
145
|
+
"method": "POST",
|
|
146
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/returnRefundLineItem"
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"name": "Content Orders Setlineitemmetadata",
|
|
152
|
+
"value": "Content Orders Setlineitemmetadata",
|
|
153
|
+
"action": "Content Orders Setlineitemmetadata",
|
|
154
|
+
"description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.",
|
|
155
|
+
"routing": {
|
|
156
|
+
"request": {
|
|
157
|
+
"method": "POST",
|
|
158
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/setLineItemMetadata"
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"name": "Content Orders Shiplineitems",
|
|
164
|
+
"value": "Content Orders Shiplineitems",
|
|
165
|
+
"action": "Content Orders Shiplineitems",
|
|
166
|
+
"description": "Marks line item(s) as shipped.",
|
|
167
|
+
"routing": {
|
|
168
|
+
"request": {
|
|
169
|
+
"method": "POST",
|
|
170
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/shipLineItems"
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"name": "Content Orders Createtestreturn",
|
|
176
|
+
"value": "Content Orders Createtestreturn",
|
|
177
|
+
"action": "Content Orders Createtestreturn",
|
|
178
|
+
"description": "Sandbox only. Creates a test return.",
|
|
179
|
+
"routing": {
|
|
180
|
+
"request": {
|
|
181
|
+
"method": "POST",
|
|
182
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/testreturn"
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"name": "Content Orders Updatelineitemshippingdetails",
|
|
188
|
+
"value": "Content Orders Updatelineitemshippingdetails",
|
|
189
|
+
"action": "Content Orders Updatelineitemshippingdetails",
|
|
190
|
+
"description": "Updates ship by and delivery by dates for a line item.",
|
|
191
|
+
"routing": {
|
|
192
|
+
"request": {
|
|
193
|
+
"method": "POST",
|
|
194
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/updateLineItemShippingDetails"
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "Content Orders Updatemerchantorderid",
|
|
200
|
+
"value": "Content Orders Updatemerchantorderid",
|
|
201
|
+
"action": "Content Orders Updatemerchantorderid",
|
|
202
|
+
"description": "Updates the merchant order ID for a given order.",
|
|
203
|
+
"routing": {
|
|
204
|
+
"request": {
|
|
205
|
+
"method": "POST",
|
|
206
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/updateMerchantOrderId"
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"name": "Content Orders Updateshipment",
|
|
212
|
+
"value": "Content Orders Updateshipment",
|
|
213
|
+
"action": "Content Orders Updateshipment",
|
|
214
|
+
"description": "Updates a shipment's status, carrier, and/or tracking ID.",
|
|
215
|
+
"routing": {
|
|
216
|
+
"request": {
|
|
217
|
+
"method": "POST",
|
|
218
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/orders/{{$parameter[\"orderId\"]}}/updateShipment"
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"name": "Content Orders Getbymerchantorderid",
|
|
224
|
+
"value": "Content Orders Getbymerchantorderid",
|
|
225
|
+
"action": "Content Orders Getbymerchantorderid",
|
|
226
|
+
"description": "Retrieves an order using merchant order ID.",
|
|
227
|
+
"routing": {
|
|
228
|
+
"request": {
|
|
229
|
+
"method": "GET",
|
|
230
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/ordersbymerchantid/{{$parameter[\"merchantOrderId\"]}}"
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "Content Orders Createtestorder",
|
|
236
|
+
"value": "Content Orders Createtestorder",
|
|
237
|
+
"action": "Content Orders Createtestorder",
|
|
238
|
+
"description": "Sandbox only. Creates a test order.",
|
|
239
|
+
"routing": {
|
|
240
|
+
"request": {
|
|
241
|
+
"method": "POST",
|
|
242
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/testorders"
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "Content Orders Advancetestorder",
|
|
248
|
+
"value": "Content Orders Advancetestorder",
|
|
249
|
+
"action": "Content Orders Advancetestorder",
|
|
250
|
+
"description": "Sandbox only. Moves a test order from state \"`inProgress`\" to state \"`pendingShipment`\".",
|
|
251
|
+
"routing": {
|
|
252
|
+
"request": {
|
|
253
|
+
"method": "POST",
|
|
254
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/testorders/{{$parameter[\"orderId\"]}}/advance"
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
"name": "Content Orders Canceltestorderbycustomer",
|
|
260
|
+
"value": "Content Orders Canceltestorderbycustomer",
|
|
261
|
+
"action": "Content Orders Canceltestorderbycustomer",
|
|
262
|
+
"description": "Sandbox only. Cancels a test order for customer-initiated cancellation.",
|
|
263
|
+
"routing": {
|
|
264
|
+
"request": {
|
|
265
|
+
"method": "POST",
|
|
266
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/testorders/{{$parameter[\"orderId\"]}}/cancelByCustomer"
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"name": "Content Orders Gettestordertemplate",
|
|
272
|
+
"value": "Content Orders Gettestordertemplate",
|
|
273
|
+
"action": "Content Orders Gettestordertemplate",
|
|
274
|
+
"description": "Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.",
|
|
275
|
+
"routing": {
|
|
276
|
+
"request": {
|
|
277
|
+
"method": "GET",
|
|
278
|
+
"url": "=/{{$parameter[\"merchantId\"]}}/testordertemplates/{{$parameter[\"templateName\"]}}"
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
],
|
|
283
|
+
"default": ""
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
"displayName": "POST /orders/batch",
|
|
287
|
+
"name": "operation",
|
|
288
|
+
"type": "notice",
|
|
289
|
+
"typeOptions": {
|
|
290
|
+
"theme": "info"
|
|
291
|
+
},
|
|
292
|
+
"default": "",
|
|
293
|
+
"displayOptions": {
|
|
294
|
+
"show": {
|
|
295
|
+
"resource": [
|
|
296
|
+
"Orders"
|
|
297
|
+
],
|
|
298
|
+
"operation": [
|
|
299
|
+
"Content Orders Custombatch"
|
|
300
|
+
]
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"displayName": "Entries",
|
|
306
|
+
"name": "entries",
|
|
307
|
+
"type": "json",
|
|
308
|
+
"default": "[\n {\n \"cancel\": {},\n \"cancelLineItem\": {\n \"amount\": {},\n \"amountPretax\": {},\n \"amountTax\": {}\n },\n \"inStoreRefundLineItem\": {\n \"amountPretax\": {},\n \"amountTax\": {}\n },\n \"refund\": {\n \"amount\": {},\n \"amountPretax\": {},\n \"amountTax\": {}\n },\n \"rejectReturnLineItem\": {},\n \"returnLineItem\": {},\n \"returnRefundLineItem\": {\n \"amountPretax\": {},\n \"amountTax\": {}\n },\n \"setLineItemMetadata\": {\n \"annotations\": [\n {}\n ]\n },\n \"shipLineItems\": {\n \"lineItems\": [\n {}\n ],\n \"shipmentInfos\": [\n {}\n ]\n },\n \"updateLineItemShippingDetails\": {},\n \"updateShipment\": {}\n }\n]",
|
|
309
|
+
"description": "The request entries to be processed in the batch.",
|
|
310
|
+
"routing": {
|
|
311
|
+
"send": {
|
|
312
|
+
"property": "entries",
|
|
313
|
+
"propertyInDotNotation": false,
|
|
314
|
+
"type": "body",
|
|
315
|
+
"value": "={{ JSON.parse($value) }}"
|
|
316
|
+
}
|
|
317
|
+
},
|
|
318
|
+
"displayOptions": {
|
|
319
|
+
"show": {
|
|
320
|
+
"resource": [
|
|
321
|
+
"Orders"
|
|
322
|
+
],
|
|
323
|
+
"operation": [
|
|
324
|
+
"Content Orders Custombatch"
|
|
325
|
+
]
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"displayName": "GET /{merchantId}/orders",
|
|
331
|
+
"name": "operation",
|
|
332
|
+
"type": "notice",
|
|
333
|
+
"typeOptions": {
|
|
334
|
+
"theme": "info"
|
|
335
|
+
},
|
|
336
|
+
"default": "",
|
|
337
|
+
"displayOptions": {
|
|
338
|
+
"show": {
|
|
339
|
+
"resource": [
|
|
340
|
+
"Orders"
|
|
341
|
+
],
|
|
342
|
+
"operation": [
|
|
343
|
+
"Content Orders List"
|
|
344
|
+
]
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
"displayName": "Merchant ID",
|
|
350
|
+
"name": "merchantId",
|
|
351
|
+
"required": true,
|
|
352
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
353
|
+
"default": "",
|
|
354
|
+
"type": "string",
|
|
355
|
+
"displayOptions": {
|
|
356
|
+
"show": {
|
|
357
|
+
"resource": [
|
|
358
|
+
"Orders"
|
|
359
|
+
],
|
|
360
|
+
"operation": [
|
|
361
|
+
"Content Orders List"
|
|
362
|
+
]
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
|
+
},
|
|
366
|
+
{
|
|
367
|
+
"displayName": "Acknowledged",
|
|
368
|
+
"name": "acknowledged",
|
|
369
|
+
"description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ",
|
|
370
|
+
"default": true,
|
|
371
|
+
"type": "boolean",
|
|
372
|
+
"routing": {
|
|
373
|
+
"send": {
|
|
374
|
+
"type": "query",
|
|
375
|
+
"property": "acknowledged",
|
|
376
|
+
"value": "={{ $value }}",
|
|
377
|
+
"propertyInDotNotation": false
|
|
378
|
+
}
|
|
379
|
+
},
|
|
380
|
+
"displayOptions": {
|
|
381
|
+
"show": {
|
|
382
|
+
"resource": [
|
|
383
|
+
"Orders"
|
|
384
|
+
],
|
|
385
|
+
"operation": [
|
|
386
|
+
"Content Orders List"
|
|
387
|
+
]
|
|
388
|
+
}
|
|
389
|
+
}
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"displayName": "Max Results",
|
|
393
|
+
"name": "maxResults",
|
|
394
|
+
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
|
|
395
|
+
"default": 0,
|
|
396
|
+
"type": "number",
|
|
397
|
+
"routing": {
|
|
398
|
+
"send": {
|
|
399
|
+
"type": "query",
|
|
400
|
+
"property": "maxResults",
|
|
401
|
+
"value": "={{ $value }}",
|
|
402
|
+
"propertyInDotNotation": false
|
|
403
|
+
}
|
|
404
|
+
},
|
|
405
|
+
"displayOptions": {
|
|
406
|
+
"show": {
|
|
407
|
+
"resource": [
|
|
408
|
+
"Orders"
|
|
409
|
+
],
|
|
410
|
+
"operation": [
|
|
411
|
+
"Content Orders List"
|
|
412
|
+
]
|
|
413
|
+
}
|
|
414
|
+
}
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"displayName": "Order By",
|
|
418
|
+
"name": "orderBy",
|
|
419
|
+
"description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc ",
|
|
420
|
+
"default": "",
|
|
421
|
+
"type": "string",
|
|
422
|
+
"routing": {
|
|
423
|
+
"send": {
|
|
424
|
+
"type": "query",
|
|
425
|
+
"property": "orderBy",
|
|
426
|
+
"value": "={{ $value }}",
|
|
427
|
+
"propertyInDotNotation": false
|
|
428
|
+
}
|
|
429
|
+
},
|
|
430
|
+
"displayOptions": {
|
|
431
|
+
"show": {
|
|
432
|
+
"resource": [
|
|
433
|
+
"Orders"
|
|
434
|
+
],
|
|
435
|
+
"operation": [
|
|
436
|
+
"Content Orders List"
|
|
437
|
+
]
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
"displayName": "Page Token",
|
|
443
|
+
"name": "pageToken",
|
|
444
|
+
"description": "The token returned by the previous request.",
|
|
445
|
+
"default": "",
|
|
446
|
+
"type": "string",
|
|
447
|
+
"routing": {
|
|
448
|
+
"send": {
|
|
449
|
+
"type": "query",
|
|
450
|
+
"property": "pageToken",
|
|
451
|
+
"value": "={{ $value }}",
|
|
452
|
+
"propertyInDotNotation": false
|
|
453
|
+
}
|
|
454
|
+
},
|
|
455
|
+
"displayOptions": {
|
|
456
|
+
"show": {
|
|
457
|
+
"resource": [
|
|
458
|
+
"Orders"
|
|
459
|
+
],
|
|
460
|
+
"operation": [
|
|
461
|
+
"Content Orders List"
|
|
462
|
+
]
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"displayName": "Placed Date End",
|
|
468
|
+
"name": "placedDateEnd",
|
|
469
|
+
"description": "Obtains orders placed before this date (exclusively), in ISO 8601 format.",
|
|
470
|
+
"default": "",
|
|
471
|
+
"type": "string",
|
|
472
|
+
"routing": {
|
|
473
|
+
"send": {
|
|
474
|
+
"type": "query",
|
|
475
|
+
"property": "placedDateEnd",
|
|
476
|
+
"value": "={{ $value }}",
|
|
477
|
+
"propertyInDotNotation": false
|
|
478
|
+
}
|
|
479
|
+
},
|
|
480
|
+
"displayOptions": {
|
|
481
|
+
"show": {
|
|
482
|
+
"resource": [
|
|
483
|
+
"Orders"
|
|
484
|
+
],
|
|
485
|
+
"operation": [
|
|
486
|
+
"Content Orders List"
|
|
487
|
+
]
|
|
488
|
+
}
|
|
489
|
+
}
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"displayName": "Placed Date Start",
|
|
493
|
+
"name": "placedDateStart",
|
|
494
|
+
"description": "Obtains orders placed after this date (inclusively), in ISO 8601 format.",
|
|
495
|
+
"default": "",
|
|
496
|
+
"type": "string",
|
|
497
|
+
"routing": {
|
|
498
|
+
"send": {
|
|
499
|
+
"type": "query",
|
|
500
|
+
"property": "placedDateStart",
|
|
501
|
+
"value": "={{ $value }}",
|
|
502
|
+
"propertyInDotNotation": false
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
"displayOptions": {
|
|
506
|
+
"show": {
|
|
507
|
+
"resource": [
|
|
508
|
+
"Orders"
|
|
509
|
+
],
|
|
510
|
+
"operation": [
|
|
511
|
+
"Content Orders List"
|
|
512
|
+
]
|
|
513
|
+
}
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"displayName": "Statuses",
|
|
518
|
+
"name": "statuses",
|
|
519
|
+
"description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.",
|
|
520
|
+
"default": "[\n null\n]",
|
|
521
|
+
"type": "json",
|
|
522
|
+
"routing": {
|
|
523
|
+
"send": {
|
|
524
|
+
"type": "query",
|
|
525
|
+
"property": "statuses",
|
|
526
|
+
"value": "={{ $value }}",
|
|
527
|
+
"propertyInDotNotation": false
|
|
528
|
+
}
|
|
529
|
+
},
|
|
530
|
+
"displayOptions": {
|
|
531
|
+
"show": {
|
|
532
|
+
"resource": [
|
|
533
|
+
"Orders"
|
|
534
|
+
],
|
|
535
|
+
"operation": [
|
|
536
|
+
"Content Orders List"
|
|
537
|
+
]
|
|
538
|
+
}
|
|
539
|
+
}
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"displayName": "GET /{merchantId}/orders/{orderId}",
|
|
543
|
+
"name": "operation",
|
|
544
|
+
"type": "notice",
|
|
545
|
+
"typeOptions": {
|
|
546
|
+
"theme": "info"
|
|
547
|
+
},
|
|
548
|
+
"default": "",
|
|
549
|
+
"displayOptions": {
|
|
550
|
+
"show": {
|
|
551
|
+
"resource": [
|
|
552
|
+
"Orders"
|
|
553
|
+
],
|
|
554
|
+
"operation": [
|
|
555
|
+
"Content Orders Get"
|
|
556
|
+
]
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"displayName": "Merchant ID",
|
|
562
|
+
"name": "merchantId",
|
|
563
|
+
"required": true,
|
|
564
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
565
|
+
"default": "",
|
|
566
|
+
"type": "string",
|
|
567
|
+
"displayOptions": {
|
|
568
|
+
"show": {
|
|
569
|
+
"resource": [
|
|
570
|
+
"Orders"
|
|
571
|
+
],
|
|
572
|
+
"operation": [
|
|
573
|
+
"Content Orders Get"
|
|
574
|
+
]
|
|
575
|
+
}
|
|
576
|
+
}
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"displayName": "Order ID",
|
|
580
|
+
"name": "orderId",
|
|
581
|
+
"required": true,
|
|
582
|
+
"description": "The ID of the order.",
|
|
583
|
+
"default": "",
|
|
584
|
+
"type": "string",
|
|
585
|
+
"displayOptions": {
|
|
586
|
+
"show": {
|
|
587
|
+
"resource": [
|
|
588
|
+
"Orders"
|
|
589
|
+
],
|
|
590
|
+
"operation": [
|
|
591
|
+
"Content Orders Get"
|
|
592
|
+
]
|
|
593
|
+
}
|
|
594
|
+
}
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/acknowledge",
|
|
598
|
+
"name": "operation",
|
|
599
|
+
"type": "notice",
|
|
600
|
+
"typeOptions": {
|
|
601
|
+
"theme": "info"
|
|
602
|
+
},
|
|
603
|
+
"default": "",
|
|
604
|
+
"displayOptions": {
|
|
605
|
+
"show": {
|
|
606
|
+
"resource": [
|
|
607
|
+
"Orders"
|
|
608
|
+
],
|
|
609
|
+
"operation": [
|
|
610
|
+
"Content Orders Acknowledge"
|
|
611
|
+
]
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
},
|
|
615
|
+
{
|
|
616
|
+
"displayName": "Merchant ID",
|
|
617
|
+
"name": "merchantId",
|
|
618
|
+
"required": true,
|
|
619
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
620
|
+
"default": "",
|
|
621
|
+
"type": "string",
|
|
622
|
+
"displayOptions": {
|
|
623
|
+
"show": {
|
|
624
|
+
"resource": [
|
|
625
|
+
"Orders"
|
|
626
|
+
],
|
|
627
|
+
"operation": [
|
|
628
|
+
"Content Orders Acknowledge"
|
|
629
|
+
]
|
|
630
|
+
}
|
|
631
|
+
}
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"displayName": "Order ID",
|
|
635
|
+
"name": "orderId",
|
|
636
|
+
"required": true,
|
|
637
|
+
"description": "The ID of the order.",
|
|
638
|
+
"default": "",
|
|
639
|
+
"type": "string",
|
|
640
|
+
"displayOptions": {
|
|
641
|
+
"show": {
|
|
642
|
+
"resource": [
|
|
643
|
+
"Orders"
|
|
644
|
+
],
|
|
645
|
+
"operation": [
|
|
646
|
+
"Content Orders Acknowledge"
|
|
647
|
+
]
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
"displayName": "Operation ID",
|
|
653
|
+
"name": "operationId",
|
|
654
|
+
"type": "string",
|
|
655
|
+
"default": "",
|
|
656
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
657
|
+
"routing": {
|
|
658
|
+
"send": {
|
|
659
|
+
"property": "operationId",
|
|
660
|
+
"propertyInDotNotation": false,
|
|
661
|
+
"type": "body",
|
|
662
|
+
"value": "={{ $value }}"
|
|
663
|
+
}
|
|
664
|
+
},
|
|
665
|
+
"displayOptions": {
|
|
666
|
+
"show": {
|
|
667
|
+
"resource": [
|
|
668
|
+
"Orders"
|
|
669
|
+
],
|
|
670
|
+
"operation": [
|
|
671
|
+
"Content Orders Acknowledge"
|
|
672
|
+
]
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/cancel",
|
|
678
|
+
"name": "operation",
|
|
679
|
+
"type": "notice",
|
|
680
|
+
"typeOptions": {
|
|
681
|
+
"theme": "info"
|
|
682
|
+
},
|
|
683
|
+
"default": "",
|
|
684
|
+
"displayOptions": {
|
|
685
|
+
"show": {
|
|
686
|
+
"resource": [
|
|
687
|
+
"Orders"
|
|
688
|
+
],
|
|
689
|
+
"operation": [
|
|
690
|
+
"Content Orders Cancel"
|
|
691
|
+
]
|
|
692
|
+
}
|
|
693
|
+
}
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
"displayName": "Merchant ID",
|
|
697
|
+
"name": "merchantId",
|
|
698
|
+
"required": true,
|
|
699
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
700
|
+
"default": "",
|
|
701
|
+
"type": "string",
|
|
702
|
+
"displayOptions": {
|
|
703
|
+
"show": {
|
|
704
|
+
"resource": [
|
|
705
|
+
"Orders"
|
|
706
|
+
],
|
|
707
|
+
"operation": [
|
|
708
|
+
"Content Orders Cancel"
|
|
709
|
+
]
|
|
710
|
+
}
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"displayName": "Order ID",
|
|
715
|
+
"name": "orderId",
|
|
716
|
+
"required": true,
|
|
717
|
+
"description": "The ID of the order to cancel.",
|
|
718
|
+
"default": "",
|
|
719
|
+
"type": "string",
|
|
720
|
+
"displayOptions": {
|
|
721
|
+
"show": {
|
|
722
|
+
"resource": [
|
|
723
|
+
"Orders"
|
|
724
|
+
],
|
|
725
|
+
"operation": [
|
|
726
|
+
"Content Orders Cancel"
|
|
727
|
+
]
|
|
728
|
+
}
|
|
729
|
+
}
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
"displayName": "Operation ID",
|
|
733
|
+
"name": "operationId",
|
|
734
|
+
"type": "string",
|
|
735
|
+
"default": "",
|
|
736
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
737
|
+
"routing": {
|
|
738
|
+
"send": {
|
|
739
|
+
"property": "operationId",
|
|
740
|
+
"propertyInDotNotation": false,
|
|
741
|
+
"type": "body",
|
|
742
|
+
"value": "={{ $value }}"
|
|
743
|
+
}
|
|
744
|
+
},
|
|
745
|
+
"displayOptions": {
|
|
746
|
+
"show": {
|
|
747
|
+
"resource": [
|
|
748
|
+
"Orders"
|
|
749
|
+
],
|
|
750
|
+
"operation": [
|
|
751
|
+
"Content Orders Cancel"
|
|
752
|
+
]
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"displayName": "Reason",
|
|
758
|
+
"name": "reason",
|
|
759
|
+
"type": "string",
|
|
760
|
+
"default": "",
|
|
761
|
+
"description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
|
|
762
|
+
"routing": {
|
|
763
|
+
"send": {
|
|
764
|
+
"property": "reason",
|
|
765
|
+
"propertyInDotNotation": false,
|
|
766
|
+
"type": "body",
|
|
767
|
+
"value": "={{ $value }}"
|
|
768
|
+
}
|
|
769
|
+
},
|
|
770
|
+
"displayOptions": {
|
|
771
|
+
"show": {
|
|
772
|
+
"resource": [
|
|
773
|
+
"Orders"
|
|
774
|
+
],
|
|
775
|
+
"operation": [
|
|
776
|
+
"Content Orders Cancel"
|
|
777
|
+
]
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
},
|
|
781
|
+
{
|
|
782
|
+
"displayName": "Reason Text",
|
|
783
|
+
"name": "reasonText",
|
|
784
|
+
"type": "string",
|
|
785
|
+
"default": "",
|
|
786
|
+
"description": "The explanation of the reason.",
|
|
787
|
+
"routing": {
|
|
788
|
+
"send": {
|
|
789
|
+
"property": "reasonText",
|
|
790
|
+
"propertyInDotNotation": false,
|
|
791
|
+
"type": "body",
|
|
792
|
+
"value": "={{ $value }}"
|
|
793
|
+
}
|
|
794
|
+
},
|
|
795
|
+
"displayOptions": {
|
|
796
|
+
"show": {
|
|
797
|
+
"resource": [
|
|
798
|
+
"Orders"
|
|
799
|
+
],
|
|
800
|
+
"operation": [
|
|
801
|
+
"Content Orders Cancel"
|
|
802
|
+
]
|
|
803
|
+
}
|
|
804
|
+
}
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/cancelLineItem",
|
|
808
|
+
"name": "operation",
|
|
809
|
+
"type": "notice",
|
|
810
|
+
"typeOptions": {
|
|
811
|
+
"theme": "info"
|
|
812
|
+
},
|
|
813
|
+
"default": "",
|
|
814
|
+
"displayOptions": {
|
|
815
|
+
"show": {
|
|
816
|
+
"resource": [
|
|
817
|
+
"Orders"
|
|
818
|
+
],
|
|
819
|
+
"operation": [
|
|
820
|
+
"Content Orders Cancellineitem"
|
|
821
|
+
]
|
|
822
|
+
}
|
|
823
|
+
}
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"displayName": "Merchant ID",
|
|
827
|
+
"name": "merchantId",
|
|
828
|
+
"required": true,
|
|
829
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
830
|
+
"default": "",
|
|
831
|
+
"type": "string",
|
|
832
|
+
"displayOptions": {
|
|
833
|
+
"show": {
|
|
834
|
+
"resource": [
|
|
835
|
+
"Orders"
|
|
836
|
+
],
|
|
837
|
+
"operation": [
|
|
838
|
+
"Content Orders Cancellineitem"
|
|
839
|
+
]
|
|
840
|
+
}
|
|
841
|
+
}
|
|
842
|
+
},
|
|
843
|
+
{
|
|
844
|
+
"displayName": "Order ID",
|
|
845
|
+
"name": "orderId",
|
|
846
|
+
"required": true,
|
|
847
|
+
"description": "The ID of the order.",
|
|
848
|
+
"default": "",
|
|
849
|
+
"type": "string",
|
|
850
|
+
"displayOptions": {
|
|
851
|
+
"show": {
|
|
852
|
+
"resource": [
|
|
853
|
+
"Orders"
|
|
854
|
+
],
|
|
855
|
+
"operation": [
|
|
856
|
+
"Content Orders Cancellineitem"
|
|
857
|
+
]
|
|
858
|
+
}
|
|
859
|
+
}
|
|
860
|
+
},
|
|
861
|
+
{
|
|
862
|
+
"displayName": "Amount",
|
|
863
|
+
"name": "amount",
|
|
864
|
+
"type": "json",
|
|
865
|
+
"default": "{}",
|
|
866
|
+
"description": "Deprecated. Please use amountPretax and amountTax instead.",
|
|
867
|
+
"routing": {
|
|
868
|
+
"send": {
|
|
869
|
+
"property": "amount",
|
|
870
|
+
"propertyInDotNotation": false,
|
|
871
|
+
"type": "body",
|
|
872
|
+
"value": "={{ JSON.parse($value) }}"
|
|
873
|
+
}
|
|
874
|
+
},
|
|
875
|
+
"displayOptions": {
|
|
876
|
+
"show": {
|
|
877
|
+
"resource": [
|
|
878
|
+
"Orders"
|
|
879
|
+
],
|
|
880
|
+
"operation": [
|
|
881
|
+
"Content Orders Cancellineitem"
|
|
882
|
+
]
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
},
|
|
886
|
+
{
|
|
887
|
+
"displayName": "Amount Pretax",
|
|
888
|
+
"name": "amountPretax",
|
|
889
|
+
"type": "json",
|
|
890
|
+
"default": "{}",
|
|
891
|
+
"description": "Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.",
|
|
892
|
+
"routing": {
|
|
893
|
+
"send": {
|
|
894
|
+
"property": "amountPretax",
|
|
895
|
+
"propertyInDotNotation": false,
|
|
896
|
+
"type": "body",
|
|
897
|
+
"value": "={{ JSON.parse($value) }}"
|
|
898
|
+
}
|
|
899
|
+
},
|
|
900
|
+
"displayOptions": {
|
|
901
|
+
"show": {
|
|
902
|
+
"resource": [
|
|
903
|
+
"Orders"
|
|
904
|
+
],
|
|
905
|
+
"operation": [
|
|
906
|
+
"Content Orders Cancellineitem"
|
|
907
|
+
]
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
},
|
|
911
|
+
{
|
|
912
|
+
"displayName": "Amount Tax",
|
|
913
|
+
"name": "amountTax",
|
|
914
|
+
"type": "json",
|
|
915
|
+
"default": "{}",
|
|
916
|
+
"description": "Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.",
|
|
917
|
+
"routing": {
|
|
918
|
+
"send": {
|
|
919
|
+
"property": "amountTax",
|
|
920
|
+
"propertyInDotNotation": false,
|
|
921
|
+
"type": "body",
|
|
922
|
+
"value": "={{ JSON.parse($value) }}"
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"displayOptions": {
|
|
926
|
+
"show": {
|
|
927
|
+
"resource": [
|
|
928
|
+
"Orders"
|
|
929
|
+
],
|
|
930
|
+
"operation": [
|
|
931
|
+
"Content Orders Cancellineitem"
|
|
932
|
+
]
|
|
933
|
+
}
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"displayName": "Line Item ID",
|
|
938
|
+
"name": "lineItemId",
|
|
939
|
+
"type": "string",
|
|
940
|
+
"default": "",
|
|
941
|
+
"description": "The ID of the line item to cancel. Either lineItemId or productId is required.",
|
|
942
|
+
"routing": {
|
|
943
|
+
"send": {
|
|
944
|
+
"property": "lineItemId",
|
|
945
|
+
"propertyInDotNotation": false,
|
|
946
|
+
"type": "body",
|
|
947
|
+
"value": "={{ $value }}"
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
"displayOptions": {
|
|
951
|
+
"show": {
|
|
952
|
+
"resource": [
|
|
953
|
+
"Orders"
|
|
954
|
+
],
|
|
955
|
+
"operation": [
|
|
956
|
+
"Content Orders Cancellineitem"
|
|
957
|
+
]
|
|
958
|
+
}
|
|
959
|
+
}
|
|
960
|
+
},
|
|
961
|
+
{
|
|
962
|
+
"displayName": "Operation ID",
|
|
963
|
+
"name": "operationId",
|
|
964
|
+
"type": "string",
|
|
965
|
+
"default": "",
|
|
966
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
967
|
+
"routing": {
|
|
968
|
+
"send": {
|
|
969
|
+
"property": "operationId",
|
|
970
|
+
"propertyInDotNotation": false,
|
|
971
|
+
"type": "body",
|
|
972
|
+
"value": "={{ $value }}"
|
|
973
|
+
}
|
|
974
|
+
},
|
|
975
|
+
"displayOptions": {
|
|
976
|
+
"show": {
|
|
977
|
+
"resource": [
|
|
978
|
+
"Orders"
|
|
979
|
+
],
|
|
980
|
+
"operation": [
|
|
981
|
+
"Content Orders Cancellineitem"
|
|
982
|
+
]
|
|
983
|
+
}
|
|
984
|
+
}
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"displayName": "Product ID",
|
|
988
|
+
"name": "productId",
|
|
989
|
+
"type": "string",
|
|
990
|
+
"default": "",
|
|
991
|
+
"description": "The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
992
|
+
"routing": {
|
|
993
|
+
"send": {
|
|
994
|
+
"property": "productId",
|
|
995
|
+
"propertyInDotNotation": false,
|
|
996
|
+
"type": "body",
|
|
997
|
+
"value": "={{ $value }}"
|
|
998
|
+
}
|
|
999
|
+
},
|
|
1000
|
+
"displayOptions": {
|
|
1001
|
+
"show": {
|
|
1002
|
+
"resource": [
|
|
1003
|
+
"Orders"
|
|
1004
|
+
],
|
|
1005
|
+
"operation": [
|
|
1006
|
+
"Content Orders Cancellineitem"
|
|
1007
|
+
]
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
},
|
|
1011
|
+
{
|
|
1012
|
+
"displayName": "Quantity",
|
|
1013
|
+
"name": "quantity",
|
|
1014
|
+
"type": "number",
|
|
1015
|
+
"default": 0,
|
|
1016
|
+
"description": "The quantity to cancel.",
|
|
1017
|
+
"routing": {
|
|
1018
|
+
"send": {
|
|
1019
|
+
"property": "quantity",
|
|
1020
|
+
"propertyInDotNotation": false,
|
|
1021
|
+
"type": "body",
|
|
1022
|
+
"value": "={{ $value }}"
|
|
1023
|
+
}
|
|
1024
|
+
},
|
|
1025
|
+
"displayOptions": {
|
|
1026
|
+
"show": {
|
|
1027
|
+
"resource": [
|
|
1028
|
+
"Orders"
|
|
1029
|
+
],
|
|
1030
|
+
"operation": [
|
|
1031
|
+
"Content Orders Cancellineitem"
|
|
1032
|
+
]
|
|
1033
|
+
}
|
|
1034
|
+
}
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"displayName": "Reason",
|
|
1038
|
+
"name": "reason",
|
|
1039
|
+
"type": "string",
|
|
1040
|
+
"default": "",
|
|
1041
|
+
"description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ",
|
|
1042
|
+
"routing": {
|
|
1043
|
+
"send": {
|
|
1044
|
+
"property": "reason",
|
|
1045
|
+
"propertyInDotNotation": false,
|
|
1046
|
+
"type": "body",
|
|
1047
|
+
"value": "={{ $value }}"
|
|
1048
|
+
}
|
|
1049
|
+
},
|
|
1050
|
+
"displayOptions": {
|
|
1051
|
+
"show": {
|
|
1052
|
+
"resource": [
|
|
1053
|
+
"Orders"
|
|
1054
|
+
],
|
|
1055
|
+
"operation": [
|
|
1056
|
+
"Content Orders Cancellineitem"
|
|
1057
|
+
]
|
|
1058
|
+
}
|
|
1059
|
+
}
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"displayName": "Reason Text",
|
|
1063
|
+
"name": "reasonText",
|
|
1064
|
+
"type": "string",
|
|
1065
|
+
"default": "",
|
|
1066
|
+
"description": "The explanation of the reason.",
|
|
1067
|
+
"routing": {
|
|
1068
|
+
"send": {
|
|
1069
|
+
"property": "reasonText",
|
|
1070
|
+
"propertyInDotNotation": false,
|
|
1071
|
+
"type": "body",
|
|
1072
|
+
"value": "={{ $value }}"
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
"displayOptions": {
|
|
1076
|
+
"show": {
|
|
1077
|
+
"resource": [
|
|
1078
|
+
"Orders"
|
|
1079
|
+
],
|
|
1080
|
+
"operation": [
|
|
1081
|
+
"Content Orders Cancellineitem"
|
|
1082
|
+
]
|
|
1083
|
+
}
|
|
1084
|
+
}
|
|
1085
|
+
},
|
|
1086
|
+
{
|
|
1087
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/inStoreRefundLineItem",
|
|
1088
|
+
"name": "operation",
|
|
1089
|
+
"type": "notice",
|
|
1090
|
+
"typeOptions": {
|
|
1091
|
+
"theme": "info"
|
|
1092
|
+
},
|
|
1093
|
+
"default": "",
|
|
1094
|
+
"displayOptions": {
|
|
1095
|
+
"show": {
|
|
1096
|
+
"resource": [
|
|
1097
|
+
"Orders"
|
|
1098
|
+
],
|
|
1099
|
+
"operation": [
|
|
1100
|
+
"Content Orders Instorerefundlineitem"
|
|
1101
|
+
]
|
|
1102
|
+
}
|
|
1103
|
+
}
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"displayName": "Merchant ID",
|
|
1107
|
+
"name": "merchantId",
|
|
1108
|
+
"required": true,
|
|
1109
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
1110
|
+
"default": "",
|
|
1111
|
+
"type": "string",
|
|
1112
|
+
"displayOptions": {
|
|
1113
|
+
"show": {
|
|
1114
|
+
"resource": [
|
|
1115
|
+
"Orders"
|
|
1116
|
+
],
|
|
1117
|
+
"operation": [
|
|
1118
|
+
"Content Orders Instorerefundlineitem"
|
|
1119
|
+
]
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
"displayName": "Order ID",
|
|
1125
|
+
"name": "orderId",
|
|
1126
|
+
"required": true,
|
|
1127
|
+
"description": "The ID of the order.",
|
|
1128
|
+
"default": "",
|
|
1129
|
+
"type": "string",
|
|
1130
|
+
"displayOptions": {
|
|
1131
|
+
"show": {
|
|
1132
|
+
"resource": [
|
|
1133
|
+
"Orders"
|
|
1134
|
+
],
|
|
1135
|
+
"operation": [
|
|
1136
|
+
"Content Orders Instorerefundlineitem"
|
|
1137
|
+
]
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"displayName": "Amount Pretax",
|
|
1143
|
+
"name": "amountPretax",
|
|
1144
|
+
"type": "json",
|
|
1145
|
+
"default": "{}",
|
|
1146
|
+
"description": "The amount that is refunded. Required.",
|
|
1147
|
+
"routing": {
|
|
1148
|
+
"send": {
|
|
1149
|
+
"property": "amountPretax",
|
|
1150
|
+
"propertyInDotNotation": false,
|
|
1151
|
+
"type": "body",
|
|
1152
|
+
"value": "={{ JSON.parse($value) }}"
|
|
1153
|
+
}
|
|
1154
|
+
},
|
|
1155
|
+
"displayOptions": {
|
|
1156
|
+
"show": {
|
|
1157
|
+
"resource": [
|
|
1158
|
+
"Orders"
|
|
1159
|
+
],
|
|
1160
|
+
"operation": [
|
|
1161
|
+
"Content Orders Instorerefundlineitem"
|
|
1162
|
+
]
|
|
1163
|
+
}
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
"displayName": "Amount Tax",
|
|
1168
|
+
"name": "amountTax",
|
|
1169
|
+
"type": "json",
|
|
1170
|
+
"default": "{}",
|
|
1171
|
+
"description": "Tax amount that correspond to refund amount in amountPretax. Required.",
|
|
1172
|
+
"routing": {
|
|
1173
|
+
"send": {
|
|
1174
|
+
"property": "amountTax",
|
|
1175
|
+
"propertyInDotNotation": false,
|
|
1176
|
+
"type": "body",
|
|
1177
|
+
"value": "={{ JSON.parse($value) }}"
|
|
1178
|
+
}
|
|
1179
|
+
},
|
|
1180
|
+
"displayOptions": {
|
|
1181
|
+
"show": {
|
|
1182
|
+
"resource": [
|
|
1183
|
+
"Orders"
|
|
1184
|
+
],
|
|
1185
|
+
"operation": [
|
|
1186
|
+
"Content Orders Instorerefundlineitem"
|
|
1187
|
+
]
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
},
|
|
1191
|
+
{
|
|
1192
|
+
"displayName": "Line Item ID",
|
|
1193
|
+
"name": "lineItemId",
|
|
1194
|
+
"type": "string",
|
|
1195
|
+
"default": "",
|
|
1196
|
+
"description": "The ID of the line item to return. Either lineItemId or productId is required.",
|
|
1197
|
+
"routing": {
|
|
1198
|
+
"send": {
|
|
1199
|
+
"property": "lineItemId",
|
|
1200
|
+
"propertyInDotNotation": false,
|
|
1201
|
+
"type": "body",
|
|
1202
|
+
"value": "={{ $value }}"
|
|
1203
|
+
}
|
|
1204
|
+
},
|
|
1205
|
+
"displayOptions": {
|
|
1206
|
+
"show": {
|
|
1207
|
+
"resource": [
|
|
1208
|
+
"Orders"
|
|
1209
|
+
],
|
|
1210
|
+
"operation": [
|
|
1211
|
+
"Content Orders Instorerefundlineitem"
|
|
1212
|
+
]
|
|
1213
|
+
}
|
|
1214
|
+
}
|
|
1215
|
+
},
|
|
1216
|
+
{
|
|
1217
|
+
"displayName": "Operation ID",
|
|
1218
|
+
"name": "operationId",
|
|
1219
|
+
"type": "string",
|
|
1220
|
+
"default": "",
|
|
1221
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
1222
|
+
"routing": {
|
|
1223
|
+
"send": {
|
|
1224
|
+
"property": "operationId",
|
|
1225
|
+
"propertyInDotNotation": false,
|
|
1226
|
+
"type": "body",
|
|
1227
|
+
"value": "={{ $value }}"
|
|
1228
|
+
}
|
|
1229
|
+
},
|
|
1230
|
+
"displayOptions": {
|
|
1231
|
+
"show": {
|
|
1232
|
+
"resource": [
|
|
1233
|
+
"Orders"
|
|
1234
|
+
],
|
|
1235
|
+
"operation": [
|
|
1236
|
+
"Content Orders Instorerefundlineitem"
|
|
1237
|
+
]
|
|
1238
|
+
}
|
|
1239
|
+
}
|
|
1240
|
+
},
|
|
1241
|
+
{
|
|
1242
|
+
"displayName": "Product ID",
|
|
1243
|
+
"name": "productId",
|
|
1244
|
+
"type": "string",
|
|
1245
|
+
"default": "",
|
|
1246
|
+
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
1247
|
+
"routing": {
|
|
1248
|
+
"send": {
|
|
1249
|
+
"property": "productId",
|
|
1250
|
+
"propertyInDotNotation": false,
|
|
1251
|
+
"type": "body",
|
|
1252
|
+
"value": "={{ $value }}"
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
"displayOptions": {
|
|
1256
|
+
"show": {
|
|
1257
|
+
"resource": [
|
|
1258
|
+
"Orders"
|
|
1259
|
+
],
|
|
1260
|
+
"operation": [
|
|
1261
|
+
"Content Orders Instorerefundlineitem"
|
|
1262
|
+
]
|
|
1263
|
+
}
|
|
1264
|
+
}
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
"displayName": "Quantity",
|
|
1268
|
+
"name": "quantity",
|
|
1269
|
+
"type": "number",
|
|
1270
|
+
"default": 0,
|
|
1271
|
+
"description": "The quantity to return and refund.",
|
|
1272
|
+
"routing": {
|
|
1273
|
+
"send": {
|
|
1274
|
+
"property": "quantity",
|
|
1275
|
+
"propertyInDotNotation": false,
|
|
1276
|
+
"type": "body",
|
|
1277
|
+
"value": "={{ $value }}"
|
|
1278
|
+
}
|
|
1279
|
+
},
|
|
1280
|
+
"displayOptions": {
|
|
1281
|
+
"show": {
|
|
1282
|
+
"resource": [
|
|
1283
|
+
"Orders"
|
|
1284
|
+
],
|
|
1285
|
+
"operation": [
|
|
1286
|
+
"Content Orders Instorerefundlineitem"
|
|
1287
|
+
]
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1290
|
+
},
|
|
1291
|
+
{
|
|
1292
|
+
"displayName": "Reason",
|
|
1293
|
+
"name": "reason",
|
|
1294
|
+
"type": "string",
|
|
1295
|
+
"default": "",
|
|
1296
|
+
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
|
|
1297
|
+
"routing": {
|
|
1298
|
+
"send": {
|
|
1299
|
+
"property": "reason",
|
|
1300
|
+
"propertyInDotNotation": false,
|
|
1301
|
+
"type": "body",
|
|
1302
|
+
"value": "={{ $value }}"
|
|
1303
|
+
}
|
|
1304
|
+
},
|
|
1305
|
+
"displayOptions": {
|
|
1306
|
+
"show": {
|
|
1307
|
+
"resource": [
|
|
1308
|
+
"Orders"
|
|
1309
|
+
],
|
|
1310
|
+
"operation": [
|
|
1311
|
+
"Content Orders Instorerefundlineitem"
|
|
1312
|
+
]
|
|
1313
|
+
}
|
|
1314
|
+
}
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"displayName": "Reason Text",
|
|
1318
|
+
"name": "reasonText",
|
|
1319
|
+
"type": "string",
|
|
1320
|
+
"default": "",
|
|
1321
|
+
"description": "The explanation of the reason.",
|
|
1322
|
+
"routing": {
|
|
1323
|
+
"send": {
|
|
1324
|
+
"property": "reasonText",
|
|
1325
|
+
"propertyInDotNotation": false,
|
|
1326
|
+
"type": "body",
|
|
1327
|
+
"value": "={{ $value }}"
|
|
1328
|
+
}
|
|
1329
|
+
},
|
|
1330
|
+
"displayOptions": {
|
|
1331
|
+
"show": {
|
|
1332
|
+
"resource": [
|
|
1333
|
+
"Orders"
|
|
1334
|
+
],
|
|
1335
|
+
"operation": [
|
|
1336
|
+
"Content Orders Instorerefundlineitem"
|
|
1337
|
+
]
|
|
1338
|
+
}
|
|
1339
|
+
}
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/refund",
|
|
1343
|
+
"name": "operation",
|
|
1344
|
+
"type": "notice",
|
|
1345
|
+
"typeOptions": {
|
|
1346
|
+
"theme": "info"
|
|
1347
|
+
},
|
|
1348
|
+
"default": "",
|
|
1349
|
+
"displayOptions": {
|
|
1350
|
+
"show": {
|
|
1351
|
+
"resource": [
|
|
1352
|
+
"Orders"
|
|
1353
|
+
],
|
|
1354
|
+
"operation": [
|
|
1355
|
+
"Content Orders Refund"
|
|
1356
|
+
]
|
|
1357
|
+
}
|
|
1358
|
+
}
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"displayName": "Merchant ID",
|
|
1362
|
+
"name": "merchantId",
|
|
1363
|
+
"required": true,
|
|
1364
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
1365
|
+
"default": "",
|
|
1366
|
+
"type": "string",
|
|
1367
|
+
"displayOptions": {
|
|
1368
|
+
"show": {
|
|
1369
|
+
"resource": [
|
|
1370
|
+
"Orders"
|
|
1371
|
+
],
|
|
1372
|
+
"operation": [
|
|
1373
|
+
"Content Orders Refund"
|
|
1374
|
+
]
|
|
1375
|
+
}
|
|
1376
|
+
}
|
|
1377
|
+
},
|
|
1378
|
+
{
|
|
1379
|
+
"displayName": "Order ID",
|
|
1380
|
+
"name": "orderId",
|
|
1381
|
+
"required": true,
|
|
1382
|
+
"description": "The ID of the order to refund.",
|
|
1383
|
+
"default": "",
|
|
1384
|
+
"type": "string",
|
|
1385
|
+
"displayOptions": {
|
|
1386
|
+
"show": {
|
|
1387
|
+
"resource": [
|
|
1388
|
+
"Orders"
|
|
1389
|
+
],
|
|
1390
|
+
"operation": [
|
|
1391
|
+
"Content Orders Refund"
|
|
1392
|
+
]
|
|
1393
|
+
}
|
|
1394
|
+
}
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
"displayName": "Amount",
|
|
1398
|
+
"name": "amount",
|
|
1399
|
+
"type": "json",
|
|
1400
|
+
"default": "{}",
|
|
1401
|
+
"description": "Deprecated. Please use amountPretax and amountTax instead.",
|
|
1402
|
+
"routing": {
|
|
1403
|
+
"send": {
|
|
1404
|
+
"property": "amount",
|
|
1405
|
+
"propertyInDotNotation": false,
|
|
1406
|
+
"type": "body",
|
|
1407
|
+
"value": "={{ JSON.parse($value) }}"
|
|
1408
|
+
}
|
|
1409
|
+
},
|
|
1410
|
+
"displayOptions": {
|
|
1411
|
+
"show": {
|
|
1412
|
+
"resource": [
|
|
1413
|
+
"Orders"
|
|
1414
|
+
],
|
|
1415
|
+
"operation": [
|
|
1416
|
+
"Content Orders Refund"
|
|
1417
|
+
]
|
|
1418
|
+
}
|
|
1419
|
+
}
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
"displayName": "Amount Pretax",
|
|
1423
|
+
"name": "amountPretax",
|
|
1424
|
+
"type": "json",
|
|
1425
|
+
"default": "{}",
|
|
1426
|
+
"description": "The amount that is refunded. Either amount or amountPretax should be filled.",
|
|
1427
|
+
"routing": {
|
|
1428
|
+
"send": {
|
|
1429
|
+
"property": "amountPretax",
|
|
1430
|
+
"propertyInDotNotation": false,
|
|
1431
|
+
"type": "body",
|
|
1432
|
+
"value": "={{ JSON.parse($value) }}"
|
|
1433
|
+
}
|
|
1434
|
+
},
|
|
1435
|
+
"displayOptions": {
|
|
1436
|
+
"show": {
|
|
1437
|
+
"resource": [
|
|
1438
|
+
"Orders"
|
|
1439
|
+
],
|
|
1440
|
+
"operation": [
|
|
1441
|
+
"Content Orders Refund"
|
|
1442
|
+
]
|
|
1443
|
+
}
|
|
1444
|
+
}
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"displayName": "Amount Tax",
|
|
1448
|
+
"name": "amountTax",
|
|
1449
|
+
"type": "json",
|
|
1450
|
+
"default": "{}",
|
|
1451
|
+
"description": "Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, amountPretax must be set. Calculated automatically if not provided.",
|
|
1452
|
+
"routing": {
|
|
1453
|
+
"send": {
|
|
1454
|
+
"property": "amountTax",
|
|
1455
|
+
"propertyInDotNotation": false,
|
|
1456
|
+
"type": "body",
|
|
1457
|
+
"value": "={{ JSON.parse($value) }}"
|
|
1458
|
+
}
|
|
1459
|
+
},
|
|
1460
|
+
"displayOptions": {
|
|
1461
|
+
"show": {
|
|
1462
|
+
"resource": [
|
|
1463
|
+
"Orders"
|
|
1464
|
+
],
|
|
1465
|
+
"operation": [
|
|
1466
|
+
"Content Orders Refund"
|
|
1467
|
+
]
|
|
1468
|
+
}
|
|
1469
|
+
}
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
"displayName": "Operation ID",
|
|
1473
|
+
"name": "operationId",
|
|
1474
|
+
"type": "string",
|
|
1475
|
+
"default": "",
|
|
1476
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
1477
|
+
"routing": {
|
|
1478
|
+
"send": {
|
|
1479
|
+
"property": "operationId",
|
|
1480
|
+
"propertyInDotNotation": false,
|
|
1481
|
+
"type": "body",
|
|
1482
|
+
"value": "={{ $value }}"
|
|
1483
|
+
}
|
|
1484
|
+
},
|
|
1485
|
+
"displayOptions": {
|
|
1486
|
+
"show": {
|
|
1487
|
+
"resource": [
|
|
1488
|
+
"Orders"
|
|
1489
|
+
],
|
|
1490
|
+
"operation": [
|
|
1491
|
+
"Content Orders Refund"
|
|
1492
|
+
]
|
|
1493
|
+
}
|
|
1494
|
+
}
|
|
1495
|
+
},
|
|
1496
|
+
{
|
|
1497
|
+
"displayName": "Reason",
|
|
1498
|
+
"name": "reason",
|
|
1499
|
+
"type": "string",
|
|
1500
|
+
"default": "",
|
|
1501
|
+
"description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`deliveredLateByCarrier`\" - \"`feeAdjustment`\" - \"`lateShipmentCredit`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`shippingCostAdjustment`\" - \"`taxAdjustment`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" ",
|
|
1502
|
+
"routing": {
|
|
1503
|
+
"send": {
|
|
1504
|
+
"property": "reason",
|
|
1505
|
+
"propertyInDotNotation": false,
|
|
1506
|
+
"type": "body",
|
|
1507
|
+
"value": "={{ $value }}"
|
|
1508
|
+
}
|
|
1509
|
+
},
|
|
1510
|
+
"displayOptions": {
|
|
1511
|
+
"show": {
|
|
1512
|
+
"resource": [
|
|
1513
|
+
"Orders"
|
|
1514
|
+
],
|
|
1515
|
+
"operation": [
|
|
1516
|
+
"Content Orders Refund"
|
|
1517
|
+
]
|
|
1518
|
+
}
|
|
1519
|
+
}
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
"displayName": "Reason Text",
|
|
1523
|
+
"name": "reasonText",
|
|
1524
|
+
"type": "string",
|
|
1525
|
+
"default": "",
|
|
1526
|
+
"description": "The explanation of the reason.",
|
|
1527
|
+
"routing": {
|
|
1528
|
+
"send": {
|
|
1529
|
+
"property": "reasonText",
|
|
1530
|
+
"propertyInDotNotation": false,
|
|
1531
|
+
"type": "body",
|
|
1532
|
+
"value": "={{ $value }}"
|
|
1533
|
+
}
|
|
1534
|
+
},
|
|
1535
|
+
"displayOptions": {
|
|
1536
|
+
"show": {
|
|
1537
|
+
"resource": [
|
|
1538
|
+
"Orders"
|
|
1539
|
+
],
|
|
1540
|
+
"operation": [
|
|
1541
|
+
"Content Orders Refund"
|
|
1542
|
+
]
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/rejectReturnLineItem",
|
|
1548
|
+
"name": "operation",
|
|
1549
|
+
"type": "notice",
|
|
1550
|
+
"typeOptions": {
|
|
1551
|
+
"theme": "info"
|
|
1552
|
+
},
|
|
1553
|
+
"default": "",
|
|
1554
|
+
"displayOptions": {
|
|
1555
|
+
"show": {
|
|
1556
|
+
"resource": [
|
|
1557
|
+
"Orders"
|
|
1558
|
+
],
|
|
1559
|
+
"operation": [
|
|
1560
|
+
"Content Orders Rejectreturnlineitem"
|
|
1561
|
+
]
|
|
1562
|
+
}
|
|
1563
|
+
}
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
"displayName": "Merchant ID",
|
|
1567
|
+
"name": "merchantId",
|
|
1568
|
+
"required": true,
|
|
1569
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
1570
|
+
"default": "",
|
|
1571
|
+
"type": "string",
|
|
1572
|
+
"displayOptions": {
|
|
1573
|
+
"show": {
|
|
1574
|
+
"resource": [
|
|
1575
|
+
"Orders"
|
|
1576
|
+
],
|
|
1577
|
+
"operation": [
|
|
1578
|
+
"Content Orders Rejectreturnlineitem"
|
|
1579
|
+
]
|
|
1580
|
+
}
|
|
1581
|
+
}
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"displayName": "Order ID",
|
|
1585
|
+
"name": "orderId",
|
|
1586
|
+
"required": true,
|
|
1587
|
+
"description": "The ID of the order.",
|
|
1588
|
+
"default": "",
|
|
1589
|
+
"type": "string",
|
|
1590
|
+
"displayOptions": {
|
|
1591
|
+
"show": {
|
|
1592
|
+
"resource": [
|
|
1593
|
+
"Orders"
|
|
1594
|
+
],
|
|
1595
|
+
"operation": [
|
|
1596
|
+
"Content Orders Rejectreturnlineitem"
|
|
1597
|
+
]
|
|
1598
|
+
}
|
|
1599
|
+
}
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"displayName": "Line Item ID",
|
|
1603
|
+
"name": "lineItemId",
|
|
1604
|
+
"type": "string",
|
|
1605
|
+
"default": "",
|
|
1606
|
+
"description": "The ID of the line item to return. Either lineItemId or productId is required.",
|
|
1607
|
+
"routing": {
|
|
1608
|
+
"send": {
|
|
1609
|
+
"property": "lineItemId",
|
|
1610
|
+
"propertyInDotNotation": false,
|
|
1611
|
+
"type": "body",
|
|
1612
|
+
"value": "={{ $value }}"
|
|
1613
|
+
}
|
|
1614
|
+
},
|
|
1615
|
+
"displayOptions": {
|
|
1616
|
+
"show": {
|
|
1617
|
+
"resource": [
|
|
1618
|
+
"Orders"
|
|
1619
|
+
],
|
|
1620
|
+
"operation": [
|
|
1621
|
+
"Content Orders Rejectreturnlineitem"
|
|
1622
|
+
]
|
|
1623
|
+
}
|
|
1624
|
+
}
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
"displayName": "Operation ID",
|
|
1628
|
+
"name": "operationId",
|
|
1629
|
+
"type": "string",
|
|
1630
|
+
"default": "",
|
|
1631
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
1632
|
+
"routing": {
|
|
1633
|
+
"send": {
|
|
1634
|
+
"property": "operationId",
|
|
1635
|
+
"propertyInDotNotation": false,
|
|
1636
|
+
"type": "body",
|
|
1637
|
+
"value": "={{ $value }}"
|
|
1638
|
+
}
|
|
1639
|
+
},
|
|
1640
|
+
"displayOptions": {
|
|
1641
|
+
"show": {
|
|
1642
|
+
"resource": [
|
|
1643
|
+
"Orders"
|
|
1644
|
+
],
|
|
1645
|
+
"operation": [
|
|
1646
|
+
"Content Orders Rejectreturnlineitem"
|
|
1647
|
+
]
|
|
1648
|
+
}
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
{
|
|
1652
|
+
"displayName": "Product ID",
|
|
1653
|
+
"name": "productId",
|
|
1654
|
+
"type": "string",
|
|
1655
|
+
"default": "",
|
|
1656
|
+
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
1657
|
+
"routing": {
|
|
1658
|
+
"send": {
|
|
1659
|
+
"property": "productId",
|
|
1660
|
+
"propertyInDotNotation": false,
|
|
1661
|
+
"type": "body",
|
|
1662
|
+
"value": "={{ $value }}"
|
|
1663
|
+
}
|
|
1664
|
+
},
|
|
1665
|
+
"displayOptions": {
|
|
1666
|
+
"show": {
|
|
1667
|
+
"resource": [
|
|
1668
|
+
"Orders"
|
|
1669
|
+
],
|
|
1670
|
+
"operation": [
|
|
1671
|
+
"Content Orders Rejectreturnlineitem"
|
|
1672
|
+
]
|
|
1673
|
+
}
|
|
1674
|
+
}
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
"displayName": "Quantity",
|
|
1678
|
+
"name": "quantity",
|
|
1679
|
+
"type": "number",
|
|
1680
|
+
"default": 0,
|
|
1681
|
+
"description": "The quantity to return and refund.",
|
|
1682
|
+
"routing": {
|
|
1683
|
+
"send": {
|
|
1684
|
+
"property": "quantity",
|
|
1685
|
+
"propertyInDotNotation": false,
|
|
1686
|
+
"type": "body",
|
|
1687
|
+
"value": "={{ $value }}"
|
|
1688
|
+
}
|
|
1689
|
+
},
|
|
1690
|
+
"displayOptions": {
|
|
1691
|
+
"show": {
|
|
1692
|
+
"resource": [
|
|
1693
|
+
"Orders"
|
|
1694
|
+
],
|
|
1695
|
+
"operation": [
|
|
1696
|
+
"Content Orders Rejectreturnlineitem"
|
|
1697
|
+
]
|
|
1698
|
+
}
|
|
1699
|
+
}
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
"displayName": "Reason",
|
|
1703
|
+
"name": "reason",
|
|
1704
|
+
"type": "string",
|
|
1705
|
+
"default": "",
|
|
1706
|
+
"description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" ",
|
|
1707
|
+
"routing": {
|
|
1708
|
+
"send": {
|
|
1709
|
+
"property": "reason",
|
|
1710
|
+
"propertyInDotNotation": false,
|
|
1711
|
+
"type": "body",
|
|
1712
|
+
"value": "={{ $value }}"
|
|
1713
|
+
}
|
|
1714
|
+
},
|
|
1715
|
+
"displayOptions": {
|
|
1716
|
+
"show": {
|
|
1717
|
+
"resource": [
|
|
1718
|
+
"Orders"
|
|
1719
|
+
],
|
|
1720
|
+
"operation": [
|
|
1721
|
+
"Content Orders Rejectreturnlineitem"
|
|
1722
|
+
]
|
|
1723
|
+
}
|
|
1724
|
+
}
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
"displayName": "Reason Text",
|
|
1728
|
+
"name": "reasonText",
|
|
1729
|
+
"type": "string",
|
|
1730
|
+
"default": "",
|
|
1731
|
+
"description": "The explanation of the reason.",
|
|
1732
|
+
"routing": {
|
|
1733
|
+
"send": {
|
|
1734
|
+
"property": "reasonText",
|
|
1735
|
+
"propertyInDotNotation": false,
|
|
1736
|
+
"type": "body",
|
|
1737
|
+
"value": "={{ $value }}"
|
|
1738
|
+
}
|
|
1739
|
+
},
|
|
1740
|
+
"displayOptions": {
|
|
1741
|
+
"show": {
|
|
1742
|
+
"resource": [
|
|
1743
|
+
"Orders"
|
|
1744
|
+
],
|
|
1745
|
+
"operation": [
|
|
1746
|
+
"Content Orders Rejectreturnlineitem"
|
|
1747
|
+
]
|
|
1748
|
+
}
|
|
1749
|
+
}
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/returnLineItem",
|
|
1753
|
+
"name": "operation",
|
|
1754
|
+
"type": "notice",
|
|
1755
|
+
"typeOptions": {
|
|
1756
|
+
"theme": "info"
|
|
1757
|
+
},
|
|
1758
|
+
"default": "",
|
|
1759
|
+
"displayOptions": {
|
|
1760
|
+
"show": {
|
|
1761
|
+
"resource": [
|
|
1762
|
+
"Orders"
|
|
1763
|
+
],
|
|
1764
|
+
"operation": [
|
|
1765
|
+
"Content Orders Returnlineitem"
|
|
1766
|
+
]
|
|
1767
|
+
}
|
|
1768
|
+
}
|
|
1769
|
+
},
|
|
1770
|
+
{
|
|
1771
|
+
"displayName": "Merchant ID",
|
|
1772
|
+
"name": "merchantId",
|
|
1773
|
+
"required": true,
|
|
1774
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
1775
|
+
"default": "",
|
|
1776
|
+
"type": "string",
|
|
1777
|
+
"displayOptions": {
|
|
1778
|
+
"show": {
|
|
1779
|
+
"resource": [
|
|
1780
|
+
"Orders"
|
|
1781
|
+
],
|
|
1782
|
+
"operation": [
|
|
1783
|
+
"Content Orders Returnlineitem"
|
|
1784
|
+
]
|
|
1785
|
+
}
|
|
1786
|
+
}
|
|
1787
|
+
},
|
|
1788
|
+
{
|
|
1789
|
+
"displayName": "Order ID",
|
|
1790
|
+
"name": "orderId",
|
|
1791
|
+
"required": true,
|
|
1792
|
+
"description": "The ID of the order.",
|
|
1793
|
+
"default": "",
|
|
1794
|
+
"type": "string",
|
|
1795
|
+
"displayOptions": {
|
|
1796
|
+
"show": {
|
|
1797
|
+
"resource": [
|
|
1798
|
+
"Orders"
|
|
1799
|
+
],
|
|
1800
|
+
"operation": [
|
|
1801
|
+
"Content Orders Returnlineitem"
|
|
1802
|
+
]
|
|
1803
|
+
}
|
|
1804
|
+
}
|
|
1805
|
+
},
|
|
1806
|
+
{
|
|
1807
|
+
"displayName": "Line Item ID",
|
|
1808
|
+
"name": "lineItemId",
|
|
1809
|
+
"type": "string",
|
|
1810
|
+
"default": "",
|
|
1811
|
+
"description": "The ID of the line item to return. Either lineItemId or productId is required.",
|
|
1812
|
+
"routing": {
|
|
1813
|
+
"send": {
|
|
1814
|
+
"property": "lineItemId",
|
|
1815
|
+
"propertyInDotNotation": false,
|
|
1816
|
+
"type": "body",
|
|
1817
|
+
"value": "={{ $value }}"
|
|
1818
|
+
}
|
|
1819
|
+
},
|
|
1820
|
+
"displayOptions": {
|
|
1821
|
+
"show": {
|
|
1822
|
+
"resource": [
|
|
1823
|
+
"Orders"
|
|
1824
|
+
],
|
|
1825
|
+
"operation": [
|
|
1826
|
+
"Content Orders Returnlineitem"
|
|
1827
|
+
]
|
|
1828
|
+
}
|
|
1829
|
+
}
|
|
1830
|
+
},
|
|
1831
|
+
{
|
|
1832
|
+
"displayName": "Operation ID",
|
|
1833
|
+
"name": "operationId",
|
|
1834
|
+
"type": "string",
|
|
1835
|
+
"default": "",
|
|
1836
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
1837
|
+
"routing": {
|
|
1838
|
+
"send": {
|
|
1839
|
+
"property": "operationId",
|
|
1840
|
+
"propertyInDotNotation": false,
|
|
1841
|
+
"type": "body",
|
|
1842
|
+
"value": "={{ $value }}"
|
|
1843
|
+
}
|
|
1844
|
+
},
|
|
1845
|
+
"displayOptions": {
|
|
1846
|
+
"show": {
|
|
1847
|
+
"resource": [
|
|
1848
|
+
"Orders"
|
|
1849
|
+
],
|
|
1850
|
+
"operation": [
|
|
1851
|
+
"Content Orders Returnlineitem"
|
|
1852
|
+
]
|
|
1853
|
+
}
|
|
1854
|
+
}
|
|
1855
|
+
},
|
|
1856
|
+
{
|
|
1857
|
+
"displayName": "Product ID",
|
|
1858
|
+
"name": "productId",
|
|
1859
|
+
"type": "string",
|
|
1860
|
+
"default": "",
|
|
1861
|
+
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
1862
|
+
"routing": {
|
|
1863
|
+
"send": {
|
|
1864
|
+
"property": "productId",
|
|
1865
|
+
"propertyInDotNotation": false,
|
|
1866
|
+
"type": "body",
|
|
1867
|
+
"value": "={{ $value }}"
|
|
1868
|
+
}
|
|
1869
|
+
},
|
|
1870
|
+
"displayOptions": {
|
|
1871
|
+
"show": {
|
|
1872
|
+
"resource": [
|
|
1873
|
+
"Orders"
|
|
1874
|
+
],
|
|
1875
|
+
"operation": [
|
|
1876
|
+
"Content Orders Returnlineitem"
|
|
1877
|
+
]
|
|
1878
|
+
}
|
|
1879
|
+
}
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"displayName": "Quantity",
|
|
1883
|
+
"name": "quantity",
|
|
1884
|
+
"type": "number",
|
|
1885
|
+
"default": 0,
|
|
1886
|
+
"description": "The quantity to return.",
|
|
1887
|
+
"routing": {
|
|
1888
|
+
"send": {
|
|
1889
|
+
"property": "quantity",
|
|
1890
|
+
"propertyInDotNotation": false,
|
|
1891
|
+
"type": "body",
|
|
1892
|
+
"value": "={{ $value }}"
|
|
1893
|
+
}
|
|
1894
|
+
},
|
|
1895
|
+
"displayOptions": {
|
|
1896
|
+
"show": {
|
|
1897
|
+
"resource": [
|
|
1898
|
+
"Orders"
|
|
1899
|
+
],
|
|
1900
|
+
"operation": [
|
|
1901
|
+
"Content Orders Returnlineitem"
|
|
1902
|
+
]
|
|
1903
|
+
}
|
|
1904
|
+
}
|
|
1905
|
+
},
|
|
1906
|
+
{
|
|
1907
|
+
"displayName": "Reason",
|
|
1908
|
+
"name": "reason",
|
|
1909
|
+
"type": "string",
|
|
1910
|
+
"default": "",
|
|
1911
|
+
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
|
|
1912
|
+
"routing": {
|
|
1913
|
+
"send": {
|
|
1914
|
+
"property": "reason",
|
|
1915
|
+
"propertyInDotNotation": false,
|
|
1916
|
+
"type": "body",
|
|
1917
|
+
"value": "={{ $value }}"
|
|
1918
|
+
}
|
|
1919
|
+
},
|
|
1920
|
+
"displayOptions": {
|
|
1921
|
+
"show": {
|
|
1922
|
+
"resource": [
|
|
1923
|
+
"Orders"
|
|
1924
|
+
],
|
|
1925
|
+
"operation": [
|
|
1926
|
+
"Content Orders Returnlineitem"
|
|
1927
|
+
]
|
|
1928
|
+
}
|
|
1929
|
+
}
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
"displayName": "Reason Text",
|
|
1933
|
+
"name": "reasonText",
|
|
1934
|
+
"type": "string",
|
|
1935
|
+
"default": "",
|
|
1936
|
+
"description": "The explanation of the reason.",
|
|
1937
|
+
"routing": {
|
|
1938
|
+
"send": {
|
|
1939
|
+
"property": "reasonText",
|
|
1940
|
+
"propertyInDotNotation": false,
|
|
1941
|
+
"type": "body",
|
|
1942
|
+
"value": "={{ $value }}"
|
|
1943
|
+
}
|
|
1944
|
+
},
|
|
1945
|
+
"displayOptions": {
|
|
1946
|
+
"show": {
|
|
1947
|
+
"resource": [
|
|
1948
|
+
"Orders"
|
|
1949
|
+
],
|
|
1950
|
+
"operation": [
|
|
1951
|
+
"Content Orders Returnlineitem"
|
|
1952
|
+
]
|
|
1953
|
+
}
|
|
1954
|
+
}
|
|
1955
|
+
},
|
|
1956
|
+
{
|
|
1957
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/returnRefundLineItem",
|
|
1958
|
+
"name": "operation",
|
|
1959
|
+
"type": "notice",
|
|
1960
|
+
"typeOptions": {
|
|
1961
|
+
"theme": "info"
|
|
1962
|
+
},
|
|
1963
|
+
"default": "",
|
|
1964
|
+
"displayOptions": {
|
|
1965
|
+
"show": {
|
|
1966
|
+
"resource": [
|
|
1967
|
+
"Orders"
|
|
1968
|
+
],
|
|
1969
|
+
"operation": [
|
|
1970
|
+
"Content Orders Returnrefundlineitem"
|
|
1971
|
+
]
|
|
1972
|
+
}
|
|
1973
|
+
}
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
"displayName": "Merchant ID",
|
|
1977
|
+
"name": "merchantId",
|
|
1978
|
+
"required": true,
|
|
1979
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
1980
|
+
"default": "",
|
|
1981
|
+
"type": "string",
|
|
1982
|
+
"displayOptions": {
|
|
1983
|
+
"show": {
|
|
1984
|
+
"resource": [
|
|
1985
|
+
"Orders"
|
|
1986
|
+
],
|
|
1987
|
+
"operation": [
|
|
1988
|
+
"Content Orders Returnrefundlineitem"
|
|
1989
|
+
]
|
|
1990
|
+
}
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"displayName": "Order ID",
|
|
1995
|
+
"name": "orderId",
|
|
1996
|
+
"required": true,
|
|
1997
|
+
"description": "The ID of the order.",
|
|
1998
|
+
"default": "",
|
|
1999
|
+
"type": "string",
|
|
2000
|
+
"displayOptions": {
|
|
2001
|
+
"show": {
|
|
2002
|
+
"resource": [
|
|
2003
|
+
"Orders"
|
|
2004
|
+
],
|
|
2005
|
+
"operation": [
|
|
2006
|
+
"Content Orders Returnrefundlineitem"
|
|
2007
|
+
]
|
|
2008
|
+
}
|
|
2009
|
+
}
|
|
2010
|
+
},
|
|
2011
|
+
{
|
|
2012
|
+
"displayName": "Amount Pretax",
|
|
2013
|
+
"name": "amountPretax",
|
|
2014
|
+
"type": "json",
|
|
2015
|
+
"default": "{}",
|
|
2016
|
+
"description": "The amount that is refunded. If omitted, refundless return is assumed (same as calling returnLineItem method).",
|
|
2017
|
+
"routing": {
|
|
2018
|
+
"send": {
|
|
2019
|
+
"property": "amountPretax",
|
|
2020
|
+
"propertyInDotNotation": false,
|
|
2021
|
+
"type": "body",
|
|
2022
|
+
"value": "={{ JSON.parse($value) }}"
|
|
2023
|
+
}
|
|
2024
|
+
},
|
|
2025
|
+
"displayOptions": {
|
|
2026
|
+
"show": {
|
|
2027
|
+
"resource": [
|
|
2028
|
+
"Orders"
|
|
2029
|
+
],
|
|
2030
|
+
"operation": [
|
|
2031
|
+
"Content Orders Returnrefundlineitem"
|
|
2032
|
+
]
|
|
2033
|
+
}
|
|
2034
|
+
}
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"displayName": "Amount Tax",
|
|
2038
|
+
"name": "amountTax",
|
|
2039
|
+
"type": "json",
|
|
2040
|
+
"default": "{}",
|
|
2041
|
+
"description": "Tax amount that corresponds to refund amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.",
|
|
2042
|
+
"routing": {
|
|
2043
|
+
"send": {
|
|
2044
|
+
"property": "amountTax",
|
|
2045
|
+
"propertyInDotNotation": false,
|
|
2046
|
+
"type": "body",
|
|
2047
|
+
"value": "={{ JSON.parse($value) }}"
|
|
2048
|
+
}
|
|
2049
|
+
},
|
|
2050
|
+
"displayOptions": {
|
|
2051
|
+
"show": {
|
|
2052
|
+
"resource": [
|
|
2053
|
+
"Orders"
|
|
2054
|
+
],
|
|
2055
|
+
"operation": [
|
|
2056
|
+
"Content Orders Returnrefundlineitem"
|
|
2057
|
+
]
|
|
2058
|
+
}
|
|
2059
|
+
}
|
|
2060
|
+
},
|
|
2061
|
+
{
|
|
2062
|
+
"displayName": "Line Item ID",
|
|
2063
|
+
"name": "lineItemId",
|
|
2064
|
+
"type": "string",
|
|
2065
|
+
"default": "",
|
|
2066
|
+
"description": "The ID of the line item to return. Either lineItemId or productId is required.",
|
|
2067
|
+
"routing": {
|
|
2068
|
+
"send": {
|
|
2069
|
+
"property": "lineItemId",
|
|
2070
|
+
"propertyInDotNotation": false,
|
|
2071
|
+
"type": "body",
|
|
2072
|
+
"value": "={{ $value }}"
|
|
2073
|
+
}
|
|
2074
|
+
},
|
|
2075
|
+
"displayOptions": {
|
|
2076
|
+
"show": {
|
|
2077
|
+
"resource": [
|
|
2078
|
+
"Orders"
|
|
2079
|
+
],
|
|
2080
|
+
"operation": [
|
|
2081
|
+
"Content Orders Returnrefundlineitem"
|
|
2082
|
+
]
|
|
2083
|
+
}
|
|
2084
|
+
}
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
"displayName": "Operation ID",
|
|
2088
|
+
"name": "operationId",
|
|
2089
|
+
"type": "string",
|
|
2090
|
+
"default": "",
|
|
2091
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
2092
|
+
"routing": {
|
|
2093
|
+
"send": {
|
|
2094
|
+
"property": "operationId",
|
|
2095
|
+
"propertyInDotNotation": false,
|
|
2096
|
+
"type": "body",
|
|
2097
|
+
"value": "={{ $value }}"
|
|
2098
|
+
}
|
|
2099
|
+
},
|
|
2100
|
+
"displayOptions": {
|
|
2101
|
+
"show": {
|
|
2102
|
+
"resource": [
|
|
2103
|
+
"Orders"
|
|
2104
|
+
],
|
|
2105
|
+
"operation": [
|
|
2106
|
+
"Content Orders Returnrefundlineitem"
|
|
2107
|
+
]
|
|
2108
|
+
}
|
|
2109
|
+
}
|
|
2110
|
+
},
|
|
2111
|
+
{
|
|
2112
|
+
"displayName": "Product ID",
|
|
2113
|
+
"name": "productId",
|
|
2114
|
+
"type": "string",
|
|
2115
|
+
"default": "",
|
|
2116
|
+
"description": "The ID of the product to return. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
2117
|
+
"routing": {
|
|
2118
|
+
"send": {
|
|
2119
|
+
"property": "productId",
|
|
2120
|
+
"propertyInDotNotation": false,
|
|
2121
|
+
"type": "body",
|
|
2122
|
+
"value": "={{ $value }}"
|
|
2123
|
+
}
|
|
2124
|
+
},
|
|
2125
|
+
"displayOptions": {
|
|
2126
|
+
"show": {
|
|
2127
|
+
"resource": [
|
|
2128
|
+
"Orders"
|
|
2129
|
+
],
|
|
2130
|
+
"operation": [
|
|
2131
|
+
"Content Orders Returnrefundlineitem"
|
|
2132
|
+
]
|
|
2133
|
+
}
|
|
2134
|
+
}
|
|
2135
|
+
},
|
|
2136
|
+
{
|
|
2137
|
+
"displayName": "Quantity",
|
|
2138
|
+
"name": "quantity",
|
|
2139
|
+
"type": "number",
|
|
2140
|
+
"default": 0,
|
|
2141
|
+
"description": "The quantity to return and refund. Quantity is required.",
|
|
2142
|
+
"routing": {
|
|
2143
|
+
"send": {
|
|
2144
|
+
"property": "quantity",
|
|
2145
|
+
"propertyInDotNotation": false,
|
|
2146
|
+
"type": "body",
|
|
2147
|
+
"value": "={{ $value }}"
|
|
2148
|
+
}
|
|
2149
|
+
},
|
|
2150
|
+
"displayOptions": {
|
|
2151
|
+
"show": {
|
|
2152
|
+
"resource": [
|
|
2153
|
+
"Orders"
|
|
2154
|
+
],
|
|
2155
|
+
"operation": [
|
|
2156
|
+
"Content Orders Returnrefundlineitem"
|
|
2157
|
+
]
|
|
2158
|
+
}
|
|
2159
|
+
}
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
"displayName": "Reason",
|
|
2163
|
+
"name": "reason",
|
|
2164
|
+
"type": "string",
|
|
2165
|
+
"default": "",
|
|
2166
|
+
"description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ",
|
|
2167
|
+
"routing": {
|
|
2168
|
+
"send": {
|
|
2169
|
+
"property": "reason",
|
|
2170
|
+
"propertyInDotNotation": false,
|
|
2171
|
+
"type": "body",
|
|
2172
|
+
"value": "={{ $value }}"
|
|
2173
|
+
}
|
|
2174
|
+
},
|
|
2175
|
+
"displayOptions": {
|
|
2176
|
+
"show": {
|
|
2177
|
+
"resource": [
|
|
2178
|
+
"Orders"
|
|
2179
|
+
],
|
|
2180
|
+
"operation": [
|
|
2181
|
+
"Content Orders Returnrefundlineitem"
|
|
2182
|
+
]
|
|
2183
|
+
}
|
|
2184
|
+
}
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"displayName": "Reason Text",
|
|
2188
|
+
"name": "reasonText",
|
|
2189
|
+
"type": "string",
|
|
2190
|
+
"default": "",
|
|
2191
|
+
"description": "The explanation of the reason.",
|
|
2192
|
+
"routing": {
|
|
2193
|
+
"send": {
|
|
2194
|
+
"property": "reasonText",
|
|
2195
|
+
"propertyInDotNotation": false,
|
|
2196
|
+
"type": "body",
|
|
2197
|
+
"value": "={{ $value }}"
|
|
2198
|
+
}
|
|
2199
|
+
},
|
|
2200
|
+
"displayOptions": {
|
|
2201
|
+
"show": {
|
|
2202
|
+
"resource": [
|
|
2203
|
+
"Orders"
|
|
2204
|
+
],
|
|
2205
|
+
"operation": [
|
|
2206
|
+
"Content Orders Returnrefundlineitem"
|
|
2207
|
+
]
|
|
2208
|
+
}
|
|
2209
|
+
}
|
|
2210
|
+
},
|
|
2211
|
+
{
|
|
2212
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/setLineItemMetadata",
|
|
2213
|
+
"name": "operation",
|
|
2214
|
+
"type": "notice",
|
|
2215
|
+
"typeOptions": {
|
|
2216
|
+
"theme": "info"
|
|
2217
|
+
},
|
|
2218
|
+
"default": "",
|
|
2219
|
+
"displayOptions": {
|
|
2220
|
+
"show": {
|
|
2221
|
+
"resource": [
|
|
2222
|
+
"Orders"
|
|
2223
|
+
],
|
|
2224
|
+
"operation": [
|
|
2225
|
+
"Content Orders Setlineitemmetadata"
|
|
2226
|
+
]
|
|
2227
|
+
}
|
|
2228
|
+
}
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
"displayName": "Merchant ID",
|
|
2232
|
+
"name": "merchantId",
|
|
2233
|
+
"required": true,
|
|
2234
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
2235
|
+
"default": "",
|
|
2236
|
+
"type": "string",
|
|
2237
|
+
"displayOptions": {
|
|
2238
|
+
"show": {
|
|
2239
|
+
"resource": [
|
|
2240
|
+
"Orders"
|
|
2241
|
+
],
|
|
2242
|
+
"operation": [
|
|
2243
|
+
"Content Orders Setlineitemmetadata"
|
|
2244
|
+
]
|
|
2245
|
+
}
|
|
2246
|
+
}
|
|
2247
|
+
},
|
|
2248
|
+
{
|
|
2249
|
+
"displayName": "Order ID",
|
|
2250
|
+
"name": "orderId",
|
|
2251
|
+
"required": true,
|
|
2252
|
+
"description": "The ID of the order.",
|
|
2253
|
+
"default": "",
|
|
2254
|
+
"type": "string",
|
|
2255
|
+
"displayOptions": {
|
|
2256
|
+
"show": {
|
|
2257
|
+
"resource": [
|
|
2258
|
+
"Orders"
|
|
2259
|
+
],
|
|
2260
|
+
"operation": [
|
|
2261
|
+
"Content Orders Setlineitemmetadata"
|
|
2262
|
+
]
|
|
2263
|
+
}
|
|
2264
|
+
}
|
|
2265
|
+
},
|
|
2266
|
+
{
|
|
2267
|
+
"displayName": "Annotations",
|
|
2268
|
+
"name": "annotations",
|
|
2269
|
+
"type": "json",
|
|
2270
|
+
"default": "[\n {}\n]",
|
|
2271
|
+
"routing": {
|
|
2272
|
+
"send": {
|
|
2273
|
+
"property": "annotations",
|
|
2274
|
+
"propertyInDotNotation": false,
|
|
2275
|
+
"type": "body",
|
|
2276
|
+
"value": "={{ JSON.parse($value) }}"
|
|
2277
|
+
}
|
|
2278
|
+
},
|
|
2279
|
+
"displayOptions": {
|
|
2280
|
+
"show": {
|
|
2281
|
+
"resource": [
|
|
2282
|
+
"Orders"
|
|
2283
|
+
],
|
|
2284
|
+
"operation": [
|
|
2285
|
+
"Content Orders Setlineitemmetadata"
|
|
2286
|
+
]
|
|
2287
|
+
}
|
|
2288
|
+
}
|
|
2289
|
+
},
|
|
2290
|
+
{
|
|
2291
|
+
"displayName": "Line Item ID",
|
|
2292
|
+
"name": "lineItemId",
|
|
2293
|
+
"type": "string",
|
|
2294
|
+
"default": "",
|
|
2295
|
+
"description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
|
|
2296
|
+
"routing": {
|
|
2297
|
+
"send": {
|
|
2298
|
+
"property": "lineItemId",
|
|
2299
|
+
"propertyInDotNotation": false,
|
|
2300
|
+
"type": "body",
|
|
2301
|
+
"value": "={{ $value }}"
|
|
2302
|
+
}
|
|
2303
|
+
},
|
|
2304
|
+
"displayOptions": {
|
|
2305
|
+
"show": {
|
|
2306
|
+
"resource": [
|
|
2307
|
+
"Orders"
|
|
2308
|
+
],
|
|
2309
|
+
"operation": [
|
|
2310
|
+
"Content Orders Setlineitemmetadata"
|
|
2311
|
+
]
|
|
2312
|
+
}
|
|
2313
|
+
}
|
|
2314
|
+
},
|
|
2315
|
+
{
|
|
2316
|
+
"displayName": "Operation ID",
|
|
2317
|
+
"name": "operationId",
|
|
2318
|
+
"type": "string",
|
|
2319
|
+
"default": "",
|
|
2320
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
2321
|
+
"routing": {
|
|
2322
|
+
"send": {
|
|
2323
|
+
"property": "operationId",
|
|
2324
|
+
"propertyInDotNotation": false,
|
|
2325
|
+
"type": "body",
|
|
2326
|
+
"value": "={{ $value }}"
|
|
2327
|
+
}
|
|
2328
|
+
},
|
|
2329
|
+
"displayOptions": {
|
|
2330
|
+
"show": {
|
|
2331
|
+
"resource": [
|
|
2332
|
+
"Orders"
|
|
2333
|
+
],
|
|
2334
|
+
"operation": [
|
|
2335
|
+
"Content Orders Setlineitemmetadata"
|
|
2336
|
+
]
|
|
2337
|
+
}
|
|
2338
|
+
}
|
|
2339
|
+
},
|
|
2340
|
+
{
|
|
2341
|
+
"displayName": "Product ID",
|
|
2342
|
+
"name": "productId",
|
|
2343
|
+
"type": "string",
|
|
2344
|
+
"default": "",
|
|
2345
|
+
"description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
2346
|
+
"routing": {
|
|
2347
|
+
"send": {
|
|
2348
|
+
"property": "productId",
|
|
2349
|
+
"propertyInDotNotation": false,
|
|
2350
|
+
"type": "body",
|
|
2351
|
+
"value": "={{ $value }}"
|
|
2352
|
+
}
|
|
2353
|
+
},
|
|
2354
|
+
"displayOptions": {
|
|
2355
|
+
"show": {
|
|
2356
|
+
"resource": [
|
|
2357
|
+
"Orders"
|
|
2358
|
+
],
|
|
2359
|
+
"operation": [
|
|
2360
|
+
"Content Orders Setlineitemmetadata"
|
|
2361
|
+
]
|
|
2362
|
+
}
|
|
2363
|
+
}
|
|
2364
|
+
},
|
|
2365
|
+
{
|
|
2366
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/shipLineItems",
|
|
2367
|
+
"name": "operation",
|
|
2368
|
+
"type": "notice",
|
|
2369
|
+
"typeOptions": {
|
|
2370
|
+
"theme": "info"
|
|
2371
|
+
},
|
|
2372
|
+
"default": "",
|
|
2373
|
+
"displayOptions": {
|
|
2374
|
+
"show": {
|
|
2375
|
+
"resource": [
|
|
2376
|
+
"Orders"
|
|
2377
|
+
],
|
|
2378
|
+
"operation": [
|
|
2379
|
+
"Content Orders Shiplineitems"
|
|
2380
|
+
]
|
|
2381
|
+
}
|
|
2382
|
+
}
|
|
2383
|
+
},
|
|
2384
|
+
{
|
|
2385
|
+
"displayName": "Merchant ID",
|
|
2386
|
+
"name": "merchantId",
|
|
2387
|
+
"required": true,
|
|
2388
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
2389
|
+
"default": "",
|
|
2390
|
+
"type": "string",
|
|
2391
|
+
"displayOptions": {
|
|
2392
|
+
"show": {
|
|
2393
|
+
"resource": [
|
|
2394
|
+
"Orders"
|
|
2395
|
+
],
|
|
2396
|
+
"operation": [
|
|
2397
|
+
"Content Orders Shiplineitems"
|
|
2398
|
+
]
|
|
2399
|
+
}
|
|
2400
|
+
}
|
|
2401
|
+
},
|
|
2402
|
+
{
|
|
2403
|
+
"displayName": "Order ID",
|
|
2404
|
+
"name": "orderId",
|
|
2405
|
+
"required": true,
|
|
2406
|
+
"description": "The ID of the order.",
|
|
2407
|
+
"default": "",
|
|
2408
|
+
"type": "string",
|
|
2409
|
+
"displayOptions": {
|
|
2410
|
+
"show": {
|
|
2411
|
+
"resource": [
|
|
2412
|
+
"Orders"
|
|
2413
|
+
],
|
|
2414
|
+
"operation": [
|
|
2415
|
+
"Content Orders Shiplineitems"
|
|
2416
|
+
]
|
|
2417
|
+
}
|
|
2418
|
+
}
|
|
2419
|
+
},
|
|
2420
|
+
{
|
|
2421
|
+
"displayName": "Carrier",
|
|
2422
|
+
"name": "carrier",
|
|
2423
|
+
"type": "string",
|
|
2424
|
+
"default": "",
|
|
2425
|
+
"description": "Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
|
|
2426
|
+
"routing": {
|
|
2427
|
+
"send": {
|
|
2428
|
+
"property": "carrier",
|
|
2429
|
+
"propertyInDotNotation": false,
|
|
2430
|
+
"type": "body",
|
|
2431
|
+
"value": "={{ $value }}"
|
|
2432
|
+
}
|
|
2433
|
+
},
|
|
2434
|
+
"displayOptions": {
|
|
2435
|
+
"show": {
|
|
2436
|
+
"resource": [
|
|
2437
|
+
"Orders"
|
|
2438
|
+
],
|
|
2439
|
+
"operation": [
|
|
2440
|
+
"Content Orders Shiplineitems"
|
|
2441
|
+
]
|
|
2442
|
+
}
|
|
2443
|
+
}
|
|
2444
|
+
},
|
|
2445
|
+
{
|
|
2446
|
+
"displayName": "Line Items",
|
|
2447
|
+
"name": "lineItems",
|
|
2448
|
+
"type": "json",
|
|
2449
|
+
"default": "[\n {}\n]",
|
|
2450
|
+
"description": "Line items to ship.",
|
|
2451
|
+
"routing": {
|
|
2452
|
+
"send": {
|
|
2453
|
+
"property": "lineItems",
|
|
2454
|
+
"propertyInDotNotation": false,
|
|
2455
|
+
"type": "body",
|
|
2456
|
+
"value": "={{ JSON.parse($value) }}"
|
|
2457
|
+
}
|
|
2458
|
+
},
|
|
2459
|
+
"displayOptions": {
|
|
2460
|
+
"show": {
|
|
2461
|
+
"resource": [
|
|
2462
|
+
"Orders"
|
|
2463
|
+
],
|
|
2464
|
+
"operation": [
|
|
2465
|
+
"Content Orders Shiplineitems"
|
|
2466
|
+
]
|
|
2467
|
+
}
|
|
2468
|
+
}
|
|
2469
|
+
},
|
|
2470
|
+
{
|
|
2471
|
+
"displayName": "Operation ID",
|
|
2472
|
+
"name": "operationId",
|
|
2473
|
+
"type": "string",
|
|
2474
|
+
"default": "",
|
|
2475
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
2476
|
+
"routing": {
|
|
2477
|
+
"send": {
|
|
2478
|
+
"property": "operationId",
|
|
2479
|
+
"propertyInDotNotation": false,
|
|
2480
|
+
"type": "body",
|
|
2481
|
+
"value": "={{ $value }}"
|
|
2482
|
+
}
|
|
2483
|
+
},
|
|
2484
|
+
"displayOptions": {
|
|
2485
|
+
"show": {
|
|
2486
|
+
"resource": [
|
|
2487
|
+
"Orders"
|
|
2488
|
+
],
|
|
2489
|
+
"operation": [
|
|
2490
|
+
"Content Orders Shiplineitems"
|
|
2491
|
+
]
|
|
2492
|
+
}
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
"displayName": "Shipment Group ID",
|
|
2497
|
+
"name": "shipmentGroupId",
|
|
2498
|
+
"type": "string",
|
|
2499
|
+
"default": "",
|
|
2500
|
+
"description": "ID of the shipment group. Required for orders that use the orderinvoices service.",
|
|
2501
|
+
"routing": {
|
|
2502
|
+
"send": {
|
|
2503
|
+
"property": "shipmentGroupId",
|
|
2504
|
+
"propertyInDotNotation": false,
|
|
2505
|
+
"type": "body",
|
|
2506
|
+
"value": "={{ $value }}"
|
|
2507
|
+
}
|
|
2508
|
+
},
|
|
2509
|
+
"displayOptions": {
|
|
2510
|
+
"show": {
|
|
2511
|
+
"resource": [
|
|
2512
|
+
"Orders"
|
|
2513
|
+
],
|
|
2514
|
+
"operation": [
|
|
2515
|
+
"Content Orders Shiplineitems"
|
|
2516
|
+
]
|
|
2517
|
+
}
|
|
2518
|
+
}
|
|
2519
|
+
},
|
|
2520
|
+
{
|
|
2521
|
+
"displayName": "Shipment ID",
|
|
2522
|
+
"name": "shipmentId",
|
|
2523
|
+
"type": "string",
|
|
2524
|
+
"default": "",
|
|
2525
|
+
"description": "Deprecated. Please use shipmentInfo instead. The ID of the shipment.",
|
|
2526
|
+
"routing": {
|
|
2527
|
+
"send": {
|
|
2528
|
+
"property": "shipmentId",
|
|
2529
|
+
"propertyInDotNotation": false,
|
|
2530
|
+
"type": "body",
|
|
2531
|
+
"value": "={{ $value }}"
|
|
2532
|
+
}
|
|
2533
|
+
},
|
|
2534
|
+
"displayOptions": {
|
|
2535
|
+
"show": {
|
|
2536
|
+
"resource": [
|
|
2537
|
+
"Orders"
|
|
2538
|
+
],
|
|
2539
|
+
"operation": [
|
|
2540
|
+
"Content Orders Shiplineitems"
|
|
2541
|
+
]
|
|
2542
|
+
}
|
|
2543
|
+
}
|
|
2544
|
+
},
|
|
2545
|
+
{
|
|
2546
|
+
"displayName": "Shipment Infos",
|
|
2547
|
+
"name": "shipmentInfos",
|
|
2548
|
+
"type": "json",
|
|
2549
|
+
"default": "[\n {}\n]",
|
|
2550
|
+
"description": "Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).",
|
|
2551
|
+
"routing": {
|
|
2552
|
+
"send": {
|
|
2553
|
+
"property": "shipmentInfos",
|
|
2554
|
+
"propertyInDotNotation": false,
|
|
2555
|
+
"type": "body",
|
|
2556
|
+
"value": "={{ JSON.parse($value) }}"
|
|
2557
|
+
}
|
|
2558
|
+
},
|
|
2559
|
+
"displayOptions": {
|
|
2560
|
+
"show": {
|
|
2561
|
+
"resource": [
|
|
2562
|
+
"Orders"
|
|
2563
|
+
],
|
|
2564
|
+
"operation": [
|
|
2565
|
+
"Content Orders Shiplineitems"
|
|
2566
|
+
]
|
|
2567
|
+
}
|
|
2568
|
+
}
|
|
2569
|
+
},
|
|
2570
|
+
{
|
|
2571
|
+
"displayName": "Tracking ID",
|
|
2572
|
+
"name": "trackingId",
|
|
2573
|
+
"type": "string",
|
|
2574
|
+
"default": "",
|
|
2575
|
+
"description": "Deprecated. Please use shipmentInfo instead. The tracking ID for the shipment.",
|
|
2576
|
+
"routing": {
|
|
2577
|
+
"send": {
|
|
2578
|
+
"property": "trackingId",
|
|
2579
|
+
"propertyInDotNotation": false,
|
|
2580
|
+
"type": "body",
|
|
2581
|
+
"value": "={{ $value }}"
|
|
2582
|
+
}
|
|
2583
|
+
},
|
|
2584
|
+
"displayOptions": {
|
|
2585
|
+
"show": {
|
|
2586
|
+
"resource": [
|
|
2587
|
+
"Orders"
|
|
2588
|
+
],
|
|
2589
|
+
"operation": [
|
|
2590
|
+
"Content Orders Shiplineitems"
|
|
2591
|
+
]
|
|
2592
|
+
}
|
|
2593
|
+
}
|
|
2594
|
+
},
|
|
2595
|
+
{
|
|
2596
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/testreturn",
|
|
2597
|
+
"name": "operation",
|
|
2598
|
+
"type": "notice",
|
|
2599
|
+
"typeOptions": {
|
|
2600
|
+
"theme": "info"
|
|
2601
|
+
},
|
|
2602
|
+
"default": "",
|
|
2603
|
+
"displayOptions": {
|
|
2604
|
+
"show": {
|
|
2605
|
+
"resource": [
|
|
2606
|
+
"Orders"
|
|
2607
|
+
],
|
|
2608
|
+
"operation": [
|
|
2609
|
+
"Content Orders Createtestreturn"
|
|
2610
|
+
]
|
|
2611
|
+
}
|
|
2612
|
+
}
|
|
2613
|
+
},
|
|
2614
|
+
{
|
|
2615
|
+
"displayName": "Merchant ID",
|
|
2616
|
+
"name": "merchantId",
|
|
2617
|
+
"required": true,
|
|
2618
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
2619
|
+
"default": "",
|
|
2620
|
+
"type": "string",
|
|
2621
|
+
"displayOptions": {
|
|
2622
|
+
"show": {
|
|
2623
|
+
"resource": [
|
|
2624
|
+
"Orders"
|
|
2625
|
+
],
|
|
2626
|
+
"operation": [
|
|
2627
|
+
"Content Orders Createtestreturn"
|
|
2628
|
+
]
|
|
2629
|
+
}
|
|
2630
|
+
}
|
|
2631
|
+
},
|
|
2632
|
+
{
|
|
2633
|
+
"displayName": "Order ID",
|
|
2634
|
+
"name": "orderId",
|
|
2635
|
+
"required": true,
|
|
2636
|
+
"description": "The ID of the order.",
|
|
2637
|
+
"default": "",
|
|
2638
|
+
"type": "string",
|
|
2639
|
+
"displayOptions": {
|
|
2640
|
+
"show": {
|
|
2641
|
+
"resource": [
|
|
2642
|
+
"Orders"
|
|
2643
|
+
],
|
|
2644
|
+
"operation": [
|
|
2645
|
+
"Content Orders Createtestreturn"
|
|
2646
|
+
]
|
|
2647
|
+
}
|
|
2648
|
+
}
|
|
2649
|
+
},
|
|
2650
|
+
{
|
|
2651
|
+
"displayName": "Items",
|
|
2652
|
+
"name": "items",
|
|
2653
|
+
"type": "json",
|
|
2654
|
+
"default": "[\n {}\n]",
|
|
2655
|
+
"description": "Returned items.",
|
|
2656
|
+
"routing": {
|
|
2657
|
+
"send": {
|
|
2658
|
+
"property": "items",
|
|
2659
|
+
"propertyInDotNotation": false,
|
|
2660
|
+
"type": "body",
|
|
2661
|
+
"value": "={{ JSON.parse($value) }}"
|
|
2662
|
+
}
|
|
2663
|
+
},
|
|
2664
|
+
"displayOptions": {
|
|
2665
|
+
"show": {
|
|
2666
|
+
"resource": [
|
|
2667
|
+
"Orders"
|
|
2668
|
+
],
|
|
2669
|
+
"operation": [
|
|
2670
|
+
"Content Orders Createtestreturn"
|
|
2671
|
+
]
|
|
2672
|
+
}
|
|
2673
|
+
}
|
|
2674
|
+
},
|
|
2675
|
+
{
|
|
2676
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/updateLineItemShippingDetails",
|
|
2677
|
+
"name": "operation",
|
|
2678
|
+
"type": "notice",
|
|
2679
|
+
"typeOptions": {
|
|
2680
|
+
"theme": "info"
|
|
2681
|
+
},
|
|
2682
|
+
"default": "",
|
|
2683
|
+
"displayOptions": {
|
|
2684
|
+
"show": {
|
|
2685
|
+
"resource": [
|
|
2686
|
+
"Orders"
|
|
2687
|
+
],
|
|
2688
|
+
"operation": [
|
|
2689
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2690
|
+
]
|
|
2691
|
+
}
|
|
2692
|
+
}
|
|
2693
|
+
},
|
|
2694
|
+
{
|
|
2695
|
+
"displayName": "Merchant ID",
|
|
2696
|
+
"name": "merchantId",
|
|
2697
|
+
"required": true,
|
|
2698
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
2699
|
+
"default": "",
|
|
2700
|
+
"type": "string",
|
|
2701
|
+
"displayOptions": {
|
|
2702
|
+
"show": {
|
|
2703
|
+
"resource": [
|
|
2704
|
+
"Orders"
|
|
2705
|
+
],
|
|
2706
|
+
"operation": [
|
|
2707
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2708
|
+
]
|
|
2709
|
+
}
|
|
2710
|
+
}
|
|
2711
|
+
},
|
|
2712
|
+
{
|
|
2713
|
+
"displayName": "Order ID",
|
|
2714
|
+
"name": "orderId",
|
|
2715
|
+
"required": true,
|
|
2716
|
+
"description": "The ID of the order.",
|
|
2717
|
+
"default": "",
|
|
2718
|
+
"type": "string",
|
|
2719
|
+
"displayOptions": {
|
|
2720
|
+
"show": {
|
|
2721
|
+
"resource": [
|
|
2722
|
+
"Orders"
|
|
2723
|
+
],
|
|
2724
|
+
"operation": [
|
|
2725
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2726
|
+
]
|
|
2727
|
+
}
|
|
2728
|
+
}
|
|
2729
|
+
},
|
|
2730
|
+
{
|
|
2731
|
+
"displayName": "Deliver By Date",
|
|
2732
|
+
"name": "deliverByDate",
|
|
2733
|
+
"type": "string",
|
|
2734
|
+
"default": "",
|
|
2735
|
+
"description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
|
|
2736
|
+
"routing": {
|
|
2737
|
+
"send": {
|
|
2738
|
+
"property": "deliverByDate",
|
|
2739
|
+
"propertyInDotNotation": false,
|
|
2740
|
+
"type": "body",
|
|
2741
|
+
"value": "={{ $value }}"
|
|
2742
|
+
}
|
|
2743
|
+
},
|
|
2744
|
+
"displayOptions": {
|
|
2745
|
+
"show": {
|
|
2746
|
+
"resource": [
|
|
2747
|
+
"Orders"
|
|
2748
|
+
],
|
|
2749
|
+
"operation": [
|
|
2750
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2751
|
+
]
|
|
2752
|
+
}
|
|
2753
|
+
}
|
|
2754
|
+
},
|
|
2755
|
+
{
|
|
2756
|
+
"displayName": "Line Item ID",
|
|
2757
|
+
"name": "lineItemId",
|
|
2758
|
+
"type": "string",
|
|
2759
|
+
"default": "",
|
|
2760
|
+
"description": "The ID of the line item to set metadata. Either lineItemId or productId is required.",
|
|
2761
|
+
"routing": {
|
|
2762
|
+
"send": {
|
|
2763
|
+
"property": "lineItemId",
|
|
2764
|
+
"propertyInDotNotation": false,
|
|
2765
|
+
"type": "body",
|
|
2766
|
+
"value": "={{ $value }}"
|
|
2767
|
+
}
|
|
2768
|
+
},
|
|
2769
|
+
"displayOptions": {
|
|
2770
|
+
"show": {
|
|
2771
|
+
"resource": [
|
|
2772
|
+
"Orders"
|
|
2773
|
+
],
|
|
2774
|
+
"operation": [
|
|
2775
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2776
|
+
]
|
|
2777
|
+
}
|
|
2778
|
+
}
|
|
2779
|
+
},
|
|
2780
|
+
{
|
|
2781
|
+
"displayName": "Operation ID",
|
|
2782
|
+
"name": "operationId",
|
|
2783
|
+
"type": "string",
|
|
2784
|
+
"default": "",
|
|
2785
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
2786
|
+
"routing": {
|
|
2787
|
+
"send": {
|
|
2788
|
+
"property": "operationId",
|
|
2789
|
+
"propertyInDotNotation": false,
|
|
2790
|
+
"type": "body",
|
|
2791
|
+
"value": "={{ $value }}"
|
|
2792
|
+
}
|
|
2793
|
+
},
|
|
2794
|
+
"displayOptions": {
|
|
2795
|
+
"show": {
|
|
2796
|
+
"resource": [
|
|
2797
|
+
"Orders"
|
|
2798
|
+
],
|
|
2799
|
+
"operation": [
|
|
2800
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2801
|
+
]
|
|
2802
|
+
}
|
|
2803
|
+
}
|
|
2804
|
+
},
|
|
2805
|
+
{
|
|
2806
|
+
"displayName": "Product ID",
|
|
2807
|
+
"name": "productId",
|
|
2808
|
+
"type": "string",
|
|
2809
|
+
"default": "",
|
|
2810
|
+
"description": "The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.",
|
|
2811
|
+
"routing": {
|
|
2812
|
+
"send": {
|
|
2813
|
+
"property": "productId",
|
|
2814
|
+
"propertyInDotNotation": false,
|
|
2815
|
+
"type": "body",
|
|
2816
|
+
"value": "={{ $value }}"
|
|
2817
|
+
}
|
|
2818
|
+
},
|
|
2819
|
+
"displayOptions": {
|
|
2820
|
+
"show": {
|
|
2821
|
+
"resource": [
|
|
2822
|
+
"Orders"
|
|
2823
|
+
],
|
|
2824
|
+
"operation": [
|
|
2825
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2826
|
+
]
|
|
2827
|
+
}
|
|
2828
|
+
}
|
|
2829
|
+
},
|
|
2830
|
+
{
|
|
2831
|
+
"displayName": "Ship By Date",
|
|
2832
|
+
"name": "shipByDate",
|
|
2833
|
+
"type": "string",
|
|
2834
|
+
"default": "",
|
|
2835
|
+
"description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.",
|
|
2836
|
+
"routing": {
|
|
2837
|
+
"send": {
|
|
2838
|
+
"property": "shipByDate",
|
|
2839
|
+
"propertyInDotNotation": false,
|
|
2840
|
+
"type": "body",
|
|
2841
|
+
"value": "={{ $value }}"
|
|
2842
|
+
}
|
|
2843
|
+
},
|
|
2844
|
+
"displayOptions": {
|
|
2845
|
+
"show": {
|
|
2846
|
+
"resource": [
|
|
2847
|
+
"Orders"
|
|
2848
|
+
],
|
|
2849
|
+
"operation": [
|
|
2850
|
+
"Content Orders Updatelineitemshippingdetails"
|
|
2851
|
+
]
|
|
2852
|
+
}
|
|
2853
|
+
}
|
|
2854
|
+
},
|
|
2855
|
+
{
|
|
2856
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/updateMerchantOrderId",
|
|
2857
|
+
"name": "operation",
|
|
2858
|
+
"type": "notice",
|
|
2859
|
+
"typeOptions": {
|
|
2860
|
+
"theme": "info"
|
|
2861
|
+
},
|
|
2862
|
+
"default": "",
|
|
2863
|
+
"displayOptions": {
|
|
2864
|
+
"show": {
|
|
2865
|
+
"resource": [
|
|
2866
|
+
"Orders"
|
|
2867
|
+
],
|
|
2868
|
+
"operation": [
|
|
2869
|
+
"Content Orders Updatemerchantorderid"
|
|
2870
|
+
]
|
|
2871
|
+
}
|
|
2872
|
+
}
|
|
2873
|
+
},
|
|
2874
|
+
{
|
|
2875
|
+
"displayName": "Merchant ID",
|
|
2876
|
+
"name": "merchantId",
|
|
2877
|
+
"required": true,
|
|
2878
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
2879
|
+
"default": "",
|
|
2880
|
+
"type": "string",
|
|
2881
|
+
"displayOptions": {
|
|
2882
|
+
"show": {
|
|
2883
|
+
"resource": [
|
|
2884
|
+
"Orders"
|
|
2885
|
+
],
|
|
2886
|
+
"operation": [
|
|
2887
|
+
"Content Orders Updatemerchantorderid"
|
|
2888
|
+
]
|
|
2889
|
+
}
|
|
2890
|
+
}
|
|
2891
|
+
},
|
|
2892
|
+
{
|
|
2893
|
+
"displayName": "Order ID",
|
|
2894
|
+
"name": "orderId",
|
|
2895
|
+
"required": true,
|
|
2896
|
+
"description": "The ID of the order.",
|
|
2897
|
+
"default": "",
|
|
2898
|
+
"type": "string",
|
|
2899
|
+
"displayOptions": {
|
|
2900
|
+
"show": {
|
|
2901
|
+
"resource": [
|
|
2902
|
+
"Orders"
|
|
2903
|
+
],
|
|
2904
|
+
"operation": [
|
|
2905
|
+
"Content Orders Updatemerchantorderid"
|
|
2906
|
+
]
|
|
2907
|
+
}
|
|
2908
|
+
}
|
|
2909
|
+
},
|
|
2910
|
+
{
|
|
2911
|
+
"displayName": "Merchant Order ID",
|
|
2912
|
+
"name": "merchantOrderId",
|
|
2913
|
+
"type": "string",
|
|
2914
|
+
"default": "",
|
|
2915
|
+
"description": "The merchant order id to be assigned to the order. Must be unique per merchant.",
|
|
2916
|
+
"routing": {
|
|
2917
|
+
"send": {
|
|
2918
|
+
"property": "merchantOrderId",
|
|
2919
|
+
"propertyInDotNotation": false,
|
|
2920
|
+
"type": "body",
|
|
2921
|
+
"value": "={{ $value }}"
|
|
2922
|
+
}
|
|
2923
|
+
},
|
|
2924
|
+
"displayOptions": {
|
|
2925
|
+
"show": {
|
|
2926
|
+
"resource": [
|
|
2927
|
+
"Orders"
|
|
2928
|
+
],
|
|
2929
|
+
"operation": [
|
|
2930
|
+
"Content Orders Updatemerchantorderid"
|
|
2931
|
+
]
|
|
2932
|
+
}
|
|
2933
|
+
}
|
|
2934
|
+
},
|
|
2935
|
+
{
|
|
2936
|
+
"displayName": "Operation ID",
|
|
2937
|
+
"name": "operationId",
|
|
2938
|
+
"type": "string",
|
|
2939
|
+
"default": "",
|
|
2940
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
2941
|
+
"routing": {
|
|
2942
|
+
"send": {
|
|
2943
|
+
"property": "operationId",
|
|
2944
|
+
"propertyInDotNotation": false,
|
|
2945
|
+
"type": "body",
|
|
2946
|
+
"value": "={{ $value }}"
|
|
2947
|
+
}
|
|
2948
|
+
},
|
|
2949
|
+
"displayOptions": {
|
|
2950
|
+
"show": {
|
|
2951
|
+
"resource": [
|
|
2952
|
+
"Orders"
|
|
2953
|
+
],
|
|
2954
|
+
"operation": [
|
|
2955
|
+
"Content Orders Updatemerchantorderid"
|
|
2956
|
+
]
|
|
2957
|
+
}
|
|
2958
|
+
}
|
|
2959
|
+
},
|
|
2960
|
+
{
|
|
2961
|
+
"displayName": "POST /{merchantId}/orders/{orderId}/updateShipment",
|
|
2962
|
+
"name": "operation",
|
|
2963
|
+
"type": "notice",
|
|
2964
|
+
"typeOptions": {
|
|
2965
|
+
"theme": "info"
|
|
2966
|
+
},
|
|
2967
|
+
"default": "",
|
|
2968
|
+
"displayOptions": {
|
|
2969
|
+
"show": {
|
|
2970
|
+
"resource": [
|
|
2971
|
+
"Orders"
|
|
2972
|
+
],
|
|
2973
|
+
"operation": [
|
|
2974
|
+
"Content Orders Updateshipment"
|
|
2975
|
+
]
|
|
2976
|
+
}
|
|
2977
|
+
}
|
|
2978
|
+
},
|
|
2979
|
+
{
|
|
2980
|
+
"displayName": "Merchant ID",
|
|
2981
|
+
"name": "merchantId",
|
|
2982
|
+
"required": true,
|
|
2983
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
2984
|
+
"default": "",
|
|
2985
|
+
"type": "string",
|
|
2986
|
+
"displayOptions": {
|
|
2987
|
+
"show": {
|
|
2988
|
+
"resource": [
|
|
2989
|
+
"Orders"
|
|
2990
|
+
],
|
|
2991
|
+
"operation": [
|
|
2992
|
+
"Content Orders Updateshipment"
|
|
2993
|
+
]
|
|
2994
|
+
}
|
|
2995
|
+
}
|
|
2996
|
+
},
|
|
2997
|
+
{
|
|
2998
|
+
"displayName": "Order ID",
|
|
2999
|
+
"name": "orderId",
|
|
3000
|
+
"required": true,
|
|
3001
|
+
"description": "The ID of the order.",
|
|
3002
|
+
"default": "",
|
|
3003
|
+
"type": "string",
|
|
3004
|
+
"displayOptions": {
|
|
3005
|
+
"show": {
|
|
3006
|
+
"resource": [
|
|
3007
|
+
"Orders"
|
|
3008
|
+
],
|
|
3009
|
+
"operation": [
|
|
3010
|
+
"Content Orders Updateshipment"
|
|
3011
|
+
]
|
|
3012
|
+
}
|
|
3013
|
+
}
|
|
3014
|
+
},
|
|
3015
|
+
{
|
|
3016
|
+
"displayName": "Carrier",
|
|
3017
|
+
"name": "carrier",
|
|
3018
|
+
"type": "string",
|
|
3019
|
+
"default": "",
|
|
3020
|
+
"description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.",
|
|
3021
|
+
"routing": {
|
|
3022
|
+
"send": {
|
|
3023
|
+
"property": "carrier",
|
|
3024
|
+
"propertyInDotNotation": false,
|
|
3025
|
+
"type": "body",
|
|
3026
|
+
"value": "={{ $value }}"
|
|
3027
|
+
}
|
|
3028
|
+
},
|
|
3029
|
+
"displayOptions": {
|
|
3030
|
+
"show": {
|
|
3031
|
+
"resource": [
|
|
3032
|
+
"Orders"
|
|
3033
|
+
],
|
|
3034
|
+
"operation": [
|
|
3035
|
+
"Content Orders Updateshipment"
|
|
3036
|
+
]
|
|
3037
|
+
}
|
|
3038
|
+
}
|
|
3039
|
+
},
|
|
3040
|
+
{
|
|
3041
|
+
"displayName": "Delivery Date",
|
|
3042
|
+
"name": "deliveryDate",
|
|
3043
|
+
"type": "string",
|
|
3044
|
+
"default": "",
|
|
3045
|
+
"description": "Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`.",
|
|
3046
|
+
"routing": {
|
|
3047
|
+
"send": {
|
|
3048
|
+
"property": "deliveryDate",
|
|
3049
|
+
"propertyInDotNotation": false,
|
|
3050
|
+
"type": "body",
|
|
3051
|
+
"value": "={{ $value }}"
|
|
3052
|
+
}
|
|
3053
|
+
},
|
|
3054
|
+
"displayOptions": {
|
|
3055
|
+
"show": {
|
|
3056
|
+
"resource": [
|
|
3057
|
+
"Orders"
|
|
3058
|
+
],
|
|
3059
|
+
"operation": [
|
|
3060
|
+
"Content Orders Updateshipment"
|
|
3061
|
+
]
|
|
3062
|
+
}
|
|
3063
|
+
}
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
"displayName": "Operation ID",
|
|
3067
|
+
"name": "operationId",
|
|
3068
|
+
"type": "string",
|
|
3069
|
+
"default": "",
|
|
3070
|
+
"description": "The ID of the operation. Unique across all operations for a given order.",
|
|
3071
|
+
"routing": {
|
|
3072
|
+
"send": {
|
|
3073
|
+
"property": "operationId",
|
|
3074
|
+
"propertyInDotNotation": false,
|
|
3075
|
+
"type": "body",
|
|
3076
|
+
"value": "={{ $value }}"
|
|
3077
|
+
}
|
|
3078
|
+
},
|
|
3079
|
+
"displayOptions": {
|
|
3080
|
+
"show": {
|
|
3081
|
+
"resource": [
|
|
3082
|
+
"Orders"
|
|
3083
|
+
],
|
|
3084
|
+
"operation": [
|
|
3085
|
+
"Content Orders Updateshipment"
|
|
3086
|
+
]
|
|
3087
|
+
}
|
|
3088
|
+
}
|
|
3089
|
+
},
|
|
3090
|
+
{
|
|
3091
|
+
"displayName": "Shipment ID",
|
|
3092
|
+
"name": "shipmentId",
|
|
3093
|
+
"type": "string",
|
|
3094
|
+
"default": "",
|
|
3095
|
+
"description": "The ID of the shipment.",
|
|
3096
|
+
"routing": {
|
|
3097
|
+
"send": {
|
|
3098
|
+
"property": "shipmentId",
|
|
3099
|
+
"propertyInDotNotation": false,
|
|
3100
|
+
"type": "body",
|
|
3101
|
+
"value": "={{ $value }}"
|
|
3102
|
+
}
|
|
3103
|
+
},
|
|
3104
|
+
"displayOptions": {
|
|
3105
|
+
"show": {
|
|
3106
|
+
"resource": [
|
|
3107
|
+
"Orders"
|
|
3108
|
+
],
|
|
3109
|
+
"operation": [
|
|
3110
|
+
"Content Orders Updateshipment"
|
|
3111
|
+
]
|
|
3112
|
+
}
|
|
3113
|
+
}
|
|
3114
|
+
},
|
|
3115
|
+
{
|
|
3116
|
+
"displayName": "Status",
|
|
3117
|
+
"name": "status",
|
|
3118
|
+
"type": "string",
|
|
3119
|
+
"default": "",
|
|
3120
|
+
"description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" ",
|
|
3121
|
+
"routing": {
|
|
3122
|
+
"send": {
|
|
3123
|
+
"property": "status",
|
|
3124
|
+
"propertyInDotNotation": false,
|
|
3125
|
+
"type": "body",
|
|
3126
|
+
"value": "={{ $value }}"
|
|
3127
|
+
}
|
|
3128
|
+
},
|
|
3129
|
+
"displayOptions": {
|
|
3130
|
+
"show": {
|
|
3131
|
+
"resource": [
|
|
3132
|
+
"Orders"
|
|
3133
|
+
],
|
|
3134
|
+
"operation": [
|
|
3135
|
+
"Content Orders Updateshipment"
|
|
3136
|
+
]
|
|
3137
|
+
}
|
|
3138
|
+
}
|
|
3139
|
+
},
|
|
3140
|
+
{
|
|
3141
|
+
"displayName": "Tracking ID",
|
|
3142
|
+
"name": "trackingId",
|
|
3143
|
+
"type": "string",
|
|
3144
|
+
"default": "",
|
|
3145
|
+
"description": "The tracking ID for the shipment. Not updated if missing.",
|
|
3146
|
+
"routing": {
|
|
3147
|
+
"send": {
|
|
3148
|
+
"property": "trackingId",
|
|
3149
|
+
"propertyInDotNotation": false,
|
|
3150
|
+
"type": "body",
|
|
3151
|
+
"value": "={{ $value }}"
|
|
3152
|
+
}
|
|
3153
|
+
},
|
|
3154
|
+
"displayOptions": {
|
|
3155
|
+
"show": {
|
|
3156
|
+
"resource": [
|
|
3157
|
+
"Orders"
|
|
3158
|
+
],
|
|
3159
|
+
"operation": [
|
|
3160
|
+
"Content Orders Updateshipment"
|
|
3161
|
+
]
|
|
3162
|
+
}
|
|
3163
|
+
}
|
|
3164
|
+
},
|
|
3165
|
+
{
|
|
3166
|
+
"displayName": "GET /{merchantId}/ordersbymerchantid/{merchantOrderId}",
|
|
3167
|
+
"name": "operation",
|
|
3168
|
+
"type": "notice",
|
|
3169
|
+
"typeOptions": {
|
|
3170
|
+
"theme": "info"
|
|
3171
|
+
},
|
|
3172
|
+
"default": "",
|
|
3173
|
+
"displayOptions": {
|
|
3174
|
+
"show": {
|
|
3175
|
+
"resource": [
|
|
3176
|
+
"Orders"
|
|
3177
|
+
],
|
|
3178
|
+
"operation": [
|
|
3179
|
+
"Content Orders Getbymerchantorderid"
|
|
3180
|
+
]
|
|
3181
|
+
}
|
|
3182
|
+
}
|
|
3183
|
+
},
|
|
3184
|
+
{
|
|
3185
|
+
"displayName": "Merchant ID",
|
|
3186
|
+
"name": "merchantId",
|
|
3187
|
+
"required": true,
|
|
3188
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
3189
|
+
"default": "",
|
|
3190
|
+
"type": "string",
|
|
3191
|
+
"displayOptions": {
|
|
3192
|
+
"show": {
|
|
3193
|
+
"resource": [
|
|
3194
|
+
"Orders"
|
|
3195
|
+
],
|
|
3196
|
+
"operation": [
|
|
3197
|
+
"Content Orders Getbymerchantorderid"
|
|
3198
|
+
]
|
|
3199
|
+
}
|
|
3200
|
+
}
|
|
3201
|
+
},
|
|
3202
|
+
{
|
|
3203
|
+
"displayName": "Merchant Order ID",
|
|
3204
|
+
"name": "merchantOrderId",
|
|
3205
|
+
"required": true,
|
|
3206
|
+
"description": "The merchant order ID to be looked for.",
|
|
3207
|
+
"default": "",
|
|
3208
|
+
"type": "string",
|
|
3209
|
+
"displayOptions": {
|
|
3210
|
+
"show": {
|
|
3211
|
+
"resource": [
|
|
3212
|
+
"Orders"
|
|
3213
|
+
],
|
|
3214
|
+
"operation": [
|
|
3215
|
+
"Content Orders Getbymerchantorderid"
|
|
3216
|
+
]
|
|
3217
|
+
}
|
|
3218
|
+
}
|
|
3219
|
+
},
|
|
3220
|
+
{
|
|
3221
|
+
"displayName": "POST /{merchantId}/testorders",
|
|
3222
|
+
"name": "operation",
|
|
3223
|
+
"type": "notice",
|
|
3224
|
+
"typeOptions": {
|
|
3225
|
+
"theme": "info"
|
|
3226
|
+
},
|
|
3227
|
+
"default": "",
|
|
3228
|
+
"displayOptions": {
|
|
3229
|
+
"show": {
|
|
3230
|
+
"resource": [
|
|
3231
|
+
"Orders"
|
|
3232
|
+
],
|
|
3233
|
+
"operation": [
|
|
3234
|
+
"Content Orders Createtestorder"
|
|
3235
|
+
]
|
|
3236
|
+
}
|
|
3237
|
+
}
|
|
3238
|
+
},
|
|
3239
|
+
{
|
|
3240
|
+
"displayName": "Merchant ID",
|
|
3241
|
+
"name": "merchantId",
|
|
3242
|
+
"required": true,
|
|
3243
|
+
"description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
|
|
3244
|
+
"default": "",
|
|
3245
|
+
"type": "string",
|
|
3246
|
+
"displayOptions": {
|
|
3247
|
+
"show": {
|
|
3248
|
+
"resource": [
|
|
3249
|
+
"Orders"
|
|
3250
|
+
],
|
|
3251
|
+
"operation": [
|
|
3252
|
+
"Content Orders Createtestorder"
|
|
3253
|
+
]
|
|
3254
|
+
}
|
|
3255
|
+
}
|
|
3256
|
+
},
|
|
3257
|
+
{
|
|
3258
|
+
"displayName": "Country",
|
|
3259
|
+
"name": "country",
|
|
3260
|
+
"type": "string",
|
|
3261
|
+
"default": "",
|
|
3262
|
+
"description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to `US`.",
|
|
3263
|
+
"routing": {
|
|
3264
|
+
"send": {
|
|
3265
|
+
"property": "country",
|
|
3266
|
+
"propertyInDotNotation": false,
|
|
3267
|
+
"type": "body",
|
|
3268
|
+
"value": "={{ $value }}"
|
|
3269
|
+
}
|
|
3270
|
+
},
|
|
3271
|
+
"displayOptions": {
|
|
3272
|
+
"show": {
|
|
3273
|
+
"resource": [
|
|
3274
|
+
"Orders"
|
|
3275
|
+
],
|
|
3276
|
+
"operation": [
|
|
3277
|
+
"Content Orders Createtestorder"
|
|
3278
|
+
]
|
|
3279
|
+
}
|
|
3280
|
+
}
|
|
3281
|
+
},
|
|
3282
|
+
{
|
|
3283
|
+
"displayName": "Template Name",
|
|
3284
|
+
"name": "templateName",
|
|
3285
|
+
"type": "string",
|
|
3286
|
+
"default": "",
|
|
3287
|
+
"description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - \"`template1`\" - \"`template1a`\" - \"`template1b`\" - \"`template2`\" - \"`template3`\" ",
|
|
3288
|
+
"routing": {
|
|
3289
|
+
"send": {
|
|
3290
|
+
"property": "templateName",
|
|
3291
|
+
"propertyInDotNotation": false,
|
|
3292
|
+
"type": "body",
|
|
3293
|
+
"value": "={{ $value }}"
|
|
3294
|
+
}
|
|
3295
|
+
},
|
|
3296
|
+
"displayOptions": {
|
|
3297
|
+
"show": {
|
|
3298
|
+
"resource": [
|
|
3299
|
+
"Orders"
|
|
3300
|
+
],
|
|
3301
|
+
"operation": [
|
|
3302
|
+
"Content Orders Createtestorder"
|
|
3303
|
+
]
|
|
3304
|
+
}
|
|
3305
|
+
}
|
|
3306
|
+
},
|
|
3307
|
+
{
|
|
3308
|
+
"displayName": "Test Order",
|
|
3309
|
+
"name": "testOrder",
|
|
3310
|
+
"type": "json",
|
|
3311
|
+
"default": "{\n \"customer\": {\n \"marketingRightsInfo\": {}\n },\n \"lineItems\": [\n {\n \"product\": {\n \"fees\": [\n {\n \"amount\": {}\n }\n ],\n \"price\": {},\n \"variantAttributes\": [\n {}\n ]\n },\n \"returnInfo\": {},\n \"shippingDetails\": {\n \"method\": {}\n },\n \"unitTax\": {}\n }\n ],\n \"paymentMethod\": {},\n \"promotions\": [\n {\n \"benefits\": [\n {\n \"discount\": {},\n \"offerIds\": [\n null\n ],\n \"taxImpact\": {}\n }\n ]\n }\n ],\n \"shippingCost\": {},\n \"shippingCostTax\": {}\n}",
|
|
3312
|
+
"description": "The test order to create.",
|
|
3313
|
+
"routing": {
|
|
3314
|
+
"send": {
|
|
3315
|
+
"property": "testOrder",
|
|
3316
|
+
"propertyInDotNotation": false,
|
|
3317
|
+
"type": "body",
|
|
3318
|
+
"value": "={{ JSON.parse($value) }}"
|
|
3319
|
+
}
|
|
3320
|
+
},
|
|
3321
|
+
"displayOptions": {
|
|
3322
|
+
"show": {
|
|
3323
|
+
"resource": [
|
|
3324
|
+
"Orders"
|
|
3325
|
+
],
|
|
3326
|
+
"operation": [
|
|
3327
|
+
"Content Orders Createtestorder"
|
|
3328
|
+
]
|
|
3329
|
+
}
|
|
3330
|
+
}
|
|
3331
|
+
},
|
|
3332
|
+
{
|
|
3333
|
+
"displayName": "POST /{merchantId}/testorders/{orderId}/advance",
|
|
3334
|
+
"name": "operation",
|
|
3335
|
+
"type": "notice",
|
|
3336
|
+
"typeOptions": {
|
|
3337
|
+
"theme": "info"
|
|
3338
|
+
},
|
|
3339
|
+
"default": "",
|
|
3340
|
+
"displayOptions": {
|
|
3341
|
+
"show": {
|
|
3342
|
+
"resource": [
|
|
3343
|
+
"Orders"
|
|
3344
|
+
],
|
|
3345
|
+
"operation": [
|
|
3346
|
+
"Content Orders Advancetestorder"
|
|
3347
|
+
]
|
|
3348
|
+
}
|
|
3349
|
+
}
|
|
3350
|
+
},
|
|
3351
|
+
{
|
|
3352
|
+
"displayName": "Merchant ID",
|
|
3353
|
+
"name": "merchantId",
|
|
3354
|
+
"required": true,
|
|
3355
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
3356
|
+
"default": "",
|
|
3357
|
+
"type": "string",
|
|
3358
|
+
"displayOptions": {
|
|
3359
|
+
"show": {
|
|
3360
|
+
"resource": [
|
|
3361
|
+
"Orders"
|
|
3362
|
+
],
|
|
3363
|
+
"operation": [
|
|
3364
|
+
"Content Orders Advancetestorder"
|
|
3365
|
+
]
|
|
3366
|
+
}
|
|
3367
|
+
}
|
|
3368
|
+
},
|
|
3369
|
+
{
|
|
3370
|
+
"displayName": "Order ID",
|
|
3371
|
+
"name": "orderId",
|
|
3372
|
+
"required": true,
|
|
3373
|
+
"description": "The ID of the test order to modify.",
|
|
3374
|
+
"default": "",
|
|
3375
|
+
"type": "string",
|
|
3376
|
+
"displayOptions": {
|
|
3377
|
+
"show": {
|
|
3378
|
+
"resource": [
|
|
3379
|
+
"Orders"
|
|
3380
|
+
],
|
|
3381
|
+
"operation": [
|
|
3382
|
+
"Content Orders Advancetestorder"
|
|
3383
|
+
]
|
|
3384
|
+
}
|
|
3385
|
+
}
|
|
3386
|
+
},
|
|
3387
|
+
{
|
|
3388
|
+
"displayName": "POST /{merchantId}/testorders/{orderId}/cancelByCustomer",
|
|
3389
|
+
"name": "operation",
|
|
3390
|
+
"type": "notice",
|
|
3391
|
+
"typeOptions": {
|
|
3392
|
+
"theme": "info"
|
|
3393
|
+
},
|
|
3394
|
+
"default": "",
|
|
3395
|
+
"displayOptions": {
|
|
3396
|
+
"show": {
|
|
3397
|
+
"resource": [
|
|
3398
|
+
"Orders"
|
|
3399
|
+
],
|
|
3400
|
+
"operation": [
|
|
3401
|
+
"Content Orders Canceltestorderbycustomer"
|
|
3402
|
+
]
|
|
3403
|
+
}
|
|
3404
|
+
}
|
|
3405
|
+
},
|
|
3406
|
+
{
|
|
3407
|
+
"displayName": "Merchant ID",
|
|
3408
|
+
"name": "merchantId",
|
|
3409
|
+
"required": true,
|
|
3410
|
+
"description": "The ID of the account that manages the order. This cannot be a multi-client account.",
|
|
3411
|
+
"default": "",
|
|
3412
|
+
"type": "string",
|
|
3413
|
+
"displayOptions": {
|
|
3414
|
+
"show": {
|
|
3415
|
+
"resource": [
|
|
3416
|
+
"Orders"
|
|
3417
|
+
],
|
|
3418
|
+
"operation": [
|
|
3419
|
+
"Content Orders Canceltestorderbycustomer"
|
|
3420
|
+
]
|
|
3421
|
+
}
|
|
3422
|
+
}
|
|
3423
|
+
},
|
|
3424
|
+
{
|
|
3425
|
+
"displayName": "Order ID",
|
|
3426
|
+
"name": "orderId",
|
|
3427
|
+
"required": true,
|
|
3428
|
+
"description": "The ID of the test order to cancel.",
|
|
3429
|
+
"default": "",
|
|
3430
|
+
"type": "string",
|
|
3431
|
+
"displayOptions": {
|
|
3432
|
+
"show": {
|
|
3433
|
+
"resource": [
|
|
3434
|
+
"Orders"
|
|
3435
|
+
],
|
|
3436
|
+
"operation": [
|
|
3437
|
+
"Content Orders Canceltestorderbycustomer"
|
|
3438
|
+
]
|
|
3439
|
+
}
|
|
3440
|
+
}
|
|
3441
|
+
},
|
|
3442
|
+
{
|
|
3443
|
+
"displayName": "Reason",
|
|
3444
|
+
"name": "reason",
|
|
3445
|
+
"type": "string",
|
|
3446
|
+
"default": "",
|
|
3447
|
+
"description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" ",
|
|
3448
|
+
"routing": {
|
|
3449
|
+
"send": {
|
|
3450
|
+
"property": "reason",
|
|
3451
|
+
"propertyInDotNotation": false,
|
|
3452
|
+
"type": "body",
|
|
3453
|
+
"value": "={{ $value }}"
|
|
3454
|
+
}
|
|
3455
|
+
},
|
|
3456
|
+
"displayOptions": {
|
|
3457
|
+
"show": {
|
|
3458
|
+
"resource": [
|
|
3459
|
+
"Orders"
|
|
3460
|
+
],
|
|
3461
|
+
"operation": [
|
|
3462
|
+
"Content Orders Canceltestorderbycustomer"
|
|
3463
|
+
]
|
|
3464
|
+
}
|
|
3465
|
+
}
|
|
3466
|
+
},
|
|
3467
|
+
{
|
|
3468
|
+
"displayName": "GET /{merchantId}/testordertemplates/{templateName}",
|
|
3469
|
+
"name": "operation",
|
|
3470
|
+
"type": "notice",
|
|
3471
|
+
"typeOptions": {
|
|
3472
|
+
"theme": "info"
|
|
3473
|
+
},
|
|
3474
|
+
"default": "",
|
|
3475
|
+
"displayOptions": {
|
|
3476
|
+
"show": {
|
|
3477
|
+
"resource": [
|
|
3478
|
+
"Orders"
|
|
3479
|
+
],
|
|
3480
|
+
"operation": [
|
|
3481
|
+
"Content Orders Gettestordertemplate"
|
|
3482
|
+
]
|
|
3483
|
+
}
|
|
3484
|
+
}
|
|
3485
|
+
},
|
|
3486
|
+
{
|
|
3487
|
+
"displayName": "Merchant ID",
|
|
3488
|
+
"name": "merchantId",
|
|
3489
|
+
"required": true,
|
|
3490
|
+
"description": "The ID of the account that should manage the order. This cannot be a multi-client account.",
|
|
3491
|
+
"default": "",
|
|
3492
|
+
"type": "string",
|
|
3493
|
+
"displayOptions": {
|
|
3494
|
+
"show": {
|
|
3495
|
+
"resource": [
|
|
3496
|
+
"Orders"
|
|
3497
|
+
],
|
|
3498
|
+
"operation": [
|
|
3499
|
+
"Content Orders Gettestordertemplate"
|
|
3500
|
+
]
|
|
3501
|
+
}
|
|
3502
|
+
}
|
|
3503
|
+
},
|
|
3504
|
+
{
|
|
3505
|
+
"displayName": "Template Name",
|
|
3506
|
+
"name": "templateName",
|
|
3507
|
+
"required": true,
|
|
3508
|
+
"description": "The name of the template to retrieve.",
|
|
3509
|
+
"default": "TEMPLATE1",
|
|
3510
|
+
"type": "options",
|
|
3511
|
+
"options": [
|
|
3512
|
+
{
|
|
3513
|
+
"name": "TEMPLATE 1",
|
|
3514
|
+
"value": "TEMPLATE1"
|
|
3515
|
+
},
|
|
3516
|
+
{
|
|
3517
|
+
"name": "TEMPLATE 2",
|
|
3518
|
+
"value": "TEMPLATE2"
|
|
3519
|
+
},
|
|
3520
|
+
{
|
|
3521
|
+
"name": "TEMPLATE 1 A",
|
|
3522
|
+
"value": "TEMPLATE1A"
|
|
3523
|
+
},
|
|
3524
|
+
{
|
|
3525
|
+
"name": "TEMPLATE 1 B",
|
|
3526
|
+
"value": "TEMPLATE1B"
|
|
3527
|
+
},
|
|
3528
|
+
{
|
|
3529
|
+
"name": "TEMPLATE 3",
|
|
3530
|
+
"value": "TEMPLATE3"
|
|
3531
|
+
}
|
|
3532
|
+
],
|
|
3533
|
+
"displayOptions": {
|
|
3534
|
+
"show": {
|
|
3535
|
+
"resource": [
|
|
3536
|
+
"Orders"
|
|
3537
|
+
],
|
|
3538
|
+
"operation": [
|
|
3539
|
+
"Content Orders Gettestordertemplate"
|
|
3540
|
+
]
|
|
3541
|
+
}
|
|
3542
|
+
}
|
|
3543
|
+
},
|
|
3544
|
+
{
|
|
3545
|
+
"displayName": "Country",
|
|
3546
|
+
"name": "country",
|
|
3547
|
+
"description": "The country of the template to retrieve. Defaults to `US`.",
|
|
3548
|
+
"default": "",
|
|
3549
|
+
"type": "string",
|
|
3550
|
+
"routing": {
|
|
3551
|
+
"send": {
|
|
3552
|
+
"type": "query",
|
|
3553
|
+
"property": "country",
|
|
3554
|
+
"value": "={{ $value }}",
|
|
3555
|
+
"propertyInDotNotation": false
|
|
3556
|
+
}
|
|
3557
|
+
},
|
|
3558
|
+
"displayOptions": {
|
|
3559
|
+
"show": {
|
|
3560
|
+
"resource": [
|
|
3561
|
+
"Orders"
|
|
3562
|
+
],
|
|
3563
|
+
"operation": [
|
|
3564
|
+
"Content Orders Gettestordertemplate"
|
|
3565
|
+
]
|
|
3566
|
+
}
|
|
3567
|
+
}
|
|
3568
|
+
},
|
|
3569
|
+
];
|
|
3570
|
+
//# sourceMappingURL=index.js.map
|