-
Notifications
You must be signed in to change notification settings - Fork 756
/
Copy pathvendorDirectFulfillmentSandboxData_2021-10-28.json
529 lines (529 loc) · 17.1 KB
/
vendorDirectFulfillmentSandboxData_2021-10-28.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
{
"swagger": "2.0",
"info": {
"description": "The Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data provides programmatic access to vendor direct fulfillment sandbox test data.",
"version": "2021-10-28",
"title": "Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sandbox.sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/vendor/directFulfillment/sandbox/2021-10-28/orders": {
"post": {
"tags": [
"vendorDFSandbox"
],
"description": "Submits a request to generate test order data for Vendor Direct Fulfillment API entities.",
"operationId": "generateOrderScenarios",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"description": "The request payload containing parameters for generating test order data scenarios.",
"schema": {
"$ref": "#/definitions/GenerateOrderScenarioRequest"
}
}
],
"responses": {
"202": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/TransactionReference"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
},
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true
}
},
"/vendor/directFulfillment/sandbox/2021-10-28/transactions/{transactionId}": {
"get": {
"tags": [
"vendorDFSandboxtransactionstatus"
],
"description": "Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.",
"operationId": "getOrderScenarios",
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"examples": {
"application/json": {
"transactionStatus": {
"transactionId": "ff35f39e-e69f-499e-903e-6c4f6c32609f-20210827003391",
"status": "Success",
"testCaseData": {
"scenarios": [
{
"scenarioId": "SCENARIO_1",
"orders": [
{
"orderId": "T11121"
},
{
"orderId": "T11123"
}
]
},
{
"scenarioId": "SCENARIO_2",
"orders": [
{
"orderId": "T22241"
},
{
"orderId": "T22244"
}
]
}
]
}
}
}
},
"schema": {
"$ref": "#/definitions/TransactionStatus"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
},
"parameters": [
{
"name": "transactionId",
"in": "path",
"description": "The transaction identifier returned in the response to the generateOrderScenarios operation.",
"required": true,
"type": "string"
}
],
"x-amzn-api-sandbox": {
"dynamic": {}
},
"x-amzn-api-sandbox-only": true
}
}
},
"definitions": {
"GenerateOrderScenarioRequest": {
"description": "The request body for the generateOrderScenarios operation.",
"type": "object",
"properties": {
"orders": {
"description": "The list of test orders requested as indicated by party identifiers.",
"type": "array",
"items": {
"$ref": "#/definitions/OrderScenarioRequest"
}
}
}
},
"OrderScenarioRequest": {
"description": "The party identifiers required to generate the test data.",
"type": "object",
"required": [
"sellingParty",
"shipFromParty"
],
"properties": {
"sellingParty": {
"description": "The identifier of the selling party or vendor.",
"$ref": "#/definitions/PartyIdentification"
},
"shipFromParty": {
"description": "The warehouse code of the vendor.",
"$ref": "#/definitions/PartyIdentification"
}
}
},
"PartyIdentification": {
"description": "The identification object for the party information. For example, warehouse code or vendor code. Please refer to specific party for more details.",
"type": "object",
"required": [
"partyId"
],
"properties": {
"partyId": {
"type": "string",
"description": "Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details."
}
}
},
"Pagination": {
"description": "A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.",
"type": "object",
"properties": {
"nextToken": {
"type": "string",
"description": "A generated token to be passed in the next request to retrieve the next set of results."
}
}
},
"TransactionReference": {
"description": "A GUID assigned by Amazon to identify this transaction.",
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "A GUID (Globally Unique Identifier) assigned by Amazon to uniquely identify the transaction."
}
}
},
"TransactionStatus": {
"description": "The payload for the getOrderScenarios operation.",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#/definitions/Transaction"
}
}
},
"Transaction": {
"description": "The transaction details including the status. If the transaction was successful, also includes the requested test order data.",
"type": "object",
"properties": {
"transactionId": {
"description": "The unique identifier returned in the response to the generateOrderScenarios request.",
"type": "string"
},
"status": {
"description": "The current processing status of the transaction.",
"type": "string",
"enum": [
"FAILURE",
"PROCESSING",
"SUCCESS"
],
"x-docgen-enum-table-extension": [
{
"value": "FAILURE",
"description": "Transaction has failed."
},
{
"value": "PROCESSING",
"description": "Transaction is in process."
},
{
"value": "SUCCESS",
"description": "Transaction has completed successfully."
}
]
},
"testCaseData": {
"description": "Test case data for the transaction. Only available when the transaction status is SUCCESS.",
"$ref": "#/definitions/TestCaseData"
}
},
"required": [
"transactionId",
"status"
]
},
"TestCaseData": {
"description": "The set of test case data returned in response to the test data request.",
"type": "object",
"properties": {
"scenarios": {
"description": "Set of use cases that describes the possible test scenarios.",
"type": "array",
"items": {
"$ref": "#/definitions/Scenario"
}
}
}
},
"Scenario": {
"description": "A scenario test case response returned when the request is successful.",
"properties": {
"scenarioId": {
"description": "An identifier that identifies the type of scenario that user can use for testing.",
"type": "string"
},
"orders": {
"description": "A list of orders that can be used by the caller to test each life cycle or scenario.",
"type": "array",
"items": {
"$ref": "#/definitions/TestOrder"
}
}
},
"required": [
"scenarioId",
"orders"
],
"type": "object"
},
"TestOrder": {
"description": "Error response returned when the request is unsuccessful.",
"properties": {
"orderId": {
"description": "An error code that identifies the type of error that occurred.",
"type": "string"
}
},
"required": [
"orderId"
],
"type": "object"
},
"ErrorList": {
"description": "A list of error responses returned when a request is unsuccessful.",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of individual error objects containing error details.",
"items": {
"$ref": "#/definitions/Error"
}
}
},
"required": [
"errors"
]
},
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An error code that identifies the type of error that occurred."
},
"message": {
"type": "string",
"description": "A message that describes the error condition."
},
"details": {
"type": "string",
"description": "Additional details that can help the caller understand or fix the issue."
}
},
"description": "Error response returned when the request is unsuccessful."
}
}
}