@shipengine/connect-fulfillment-provider-api 0.7.0 → 4.0.0-beta

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.
Files changed (93) hide show
  1. package/lib/app/build-app-deployment.d.ts +3 -0
  2. package/lib/app/build-app-deployment.js +11 -0
  3. package/lib/app/build-app-deployment.js.map +1 -0
  4. package/lib/app/create-endpoint-mapping.d.ts +3 -0
  5. package/lib/app/create-endpoint-mapping.js +15 -0
  6. package/lib/app/create-endpoint-mapping.js.map +1 -0
  7. package/lib/app/fulfillment-provider-app-definition.d.ts +1 -1
  8. package/lib/app/fulfillment-provider-app-metadata.d.ts +6 -6
  9. package/lib/app/index.d.ts +2 -1
  10. package/lib/app/index.js +7 -2
  11. package/lib/app/index.js.map +1 -1
  12. package/lib/index.js +5 -1
  13. package/lib/index.js.map +1 -1
  14. package/lib/models/auth.d.ts +1 -1
  15. package/lib/models/carrier/addresses/index.js +5 -1
  16. package/lib/models/carrier/addresses/index.js.map +1 -1
  17. package/lib/models/carrier/billing/index.js +5 -1
  18. package/lib/models/carrier/billing/index.js.map +1 -1
  19. package/lib/models/carrier/customs/index.js +5 -1
  20. package/lib/models/carrier/customs/index.js.map +1 -1
  21. package/lib/models/carrier/fulfillment-plans/index.js +5 -1
  22. package/lib/models/carrier/fulfillment-plans/index.js.map +1 -1
  23. package/lib/models/carrier/index.js +5 -1
  24. package/lib/models/carrier/index.js.map +1 -1
  25. package/lib/models/carrier/labels/index.js +5 -1
  26. package/lib/models/carrier/labels/index.js.map +1 -1
  27. package/lib/models/carrier/manifests/index.js +5 -1
  28. package/lib/models/carrier/manifests/index.js.map +1 -1
  29. package/lib/models/carrier/pickup/index.js +5 -1
  30. package/lib/models/carrier/pickup/index.js.map +1 -1
  31. package/lib/models/carrier/rates/index.js +5 -1
  32. package/lib/models/carrier/rates/index.js.map +1 -1
  33. package/lib/models/carrier/taxes/index.js +5 -1
  34. package/lib/models/carrier/taxes/index.js.map +1 -1
  35. package/lib/models/documents/index.js +5 -1
  36. package/lib/models/documents/index.js.map +1 -1
  37. package/lib/models/error.d.ts +1 -1
  38. package/lib/models/errors/index.js +5 -1
  39. package/lib/models/errors/index.js.map +1 -1
  40. package/lib/models/index.js +5 -1
  41. package/lib/models/index.js.map +1 -1
  42. package/lib/models/order-source/index.js +5 -1
  43. package/lib/models/order-source/index.js.map +1 -1
  44. package/lib/models/sales-order-fulfillments.d.ts +4 -4
  45. package/lib/models/units/index.js +5 -1
  46. package/lib/models/units/index.js.map +1 -1
  47. package/lib/requests/cancel-fulfillment-request.d.ts +2 -1
  48. package/lib/requests/connect-request.d.ts +2 -1
  49. package/lib/requests/delegate-fulfillment-request.d.ts +2 -2
  50. package/lib/requests/get-fulfillments-request.d.ts +2 -1
  51. package/lib/requests/get-inventory-request.d.ts +3 -1
  52. package/lib/requests/get-rates-request.d.ts +1 -0
  53. package/lib/requests/get-recent-changes-request.d.ts +2 -1
  54. package/lib/requests/index.js +5 -1
  55. package/lib/requests/index.js.map +1 -1
  56. package/lib/requests/reconnect-request.d.ts +2 -1
  57. package/lib/responses/cancel-fulfillment-response.d.ts +1 -1
  58. package/lib/responses/connect-response.d.ts +3 -3
  59. package/lib/responses/delegate-fulfillment-response.d.ts +1 -1
  60. package/lib/responses/get-fulfillments-response.d.ts +3 -3
  61. package/lib/responses/get-inventory-response.d.ts +2 -2
  62. package/lib/responses/get-recent-changes-response.d.ts +1 -1
  63. package/lib/responses/index.js +5 -1
  64. package/lib/responses/index.js.map +1 -1
  65. package/lib/responses/reconnect-response.d.ts +1 -1
  66. package/package.json +9 -8
  67. package/spec.json +402 -496
  68. package/tsconfig.tsbuildinfo +1 -1
  69. package/jest.config.ts +0 -5
  70. package/lib/app/fulfillment-provider-app.d.ts +0 -9
  71. package/lib/app/fulfillment-provider-app.js +0 -64
  72. package/lib/app/fulfillment-provider-app.js.map +0 -1
  73. package/lib/app/internal/branded-images.d.ts +0 -9
  74. package/lib/app/internal/branded-images.js +0 -3
  75. package/lib/app/internal/branded-images.js.map +0 -1
  76. package/lib/app/internal/connect-runtime-app.d.ts +0 -12
  77. package/lib/app/internal/connect-runtime-app.js +0 -3
  78. package/lib/app/internal/connect-runtime-app.js.map +0 -1
  79. package/lib/app/internal/index.d.ts +0 -5
  80. package/lib/app/internal/index.js +0 -18
  81. package/lib/app/internal/index.js.map +0 -1
  82. package/lib/app/internal/metadata.d.ts +0 -12
  83. package/lib/app/internal/metadata.js +0 -29
  84. package/lib/app/internal/metadata.js.map +0 -1
  85. package/lib/app/internal/method.d.ts +0 -7
  86. package/lib/app/internal/method.js +0 -12
  87. package/lib/app/internal/method.js.map +0 -1
  88. package/lib/app/internal/route.d.ts +0 -6
  89. package/lib/app/internal/route.js +0 -3
  90. package/lib/app/internal/route.js.map +0 -1
  91. package/lib/spec.test.d.ts +0 -1
  92. package/lib/spec.test.js +0 -12
  93. package/lib/spec.test.js.map +0 -1
package/spec.json CHANGED
@@ -1,52 +1,67 @@
1
1
  {
2
- "openapi": "3.1.0",
2
+ "openapi": "3.0.1",
3
3
  "info": {
4
- "title": "fulfillment-delegation-api",
5
- "version": "1.0"
4
+ "title": "Fulfillment Provider API",
5
+ "description": "This API specification describes the canonical ShipEngine Fulfillmen Provider module. A module which implements this specification can be integrated with the ShipEngine Fulfillments Platform as a Fulfillment Provider.",
6
+ "contact": {
7
+ "name": "ShipEngine Connect",
8
+ "url": "https://connect.shipengine.com/",
9
+ "email": "connect@shipengine.com"
10
+ },
11
+ "license": {
12
+ "name": "Apache-2.0",
13
+ "url": "https://www.apache.org/licenses/LICENSE-2.0"
14
+ },
15
+ "version": "2.0.0"
6
16
  },
7
17
  "paths": {
8
18
  "/cancel_fulfillment": {
9
19
  "post": {
10
- "summary": "Request Fulfillment Cancellation",
11
- "operationId": "post-fulfillment-cancellation",
20
+ "summary": "Cancel Fulfillment",
21
+ "operationId": "post-cancel-fulfillment",
12
22
  "responses": {
13
23
  "200": {
14
24
  "description": "OK",
15
25
  "content": {
16
26
  "application/json": {
17
27
  "schema": {
18
- "type": "object"
28
+ "type": "object",
29
+ "example": {
30
+
31
+ }
19
32
  }
20
33
  }
21
34
  }
22
35
  }
23
36
  },
24
- "parameters": [
25
- {
26
- "schema": {
27
- "type": "string"
28
- },
29
- "in": "header",
30
- "name": "tenant-id"
31
- }
32
- ],
33
37
  "requestBody": {
34
38
  "content": {
35
39
  "application/json": {
36
40
  "schema": {
37
41
  "type": "object",
38
42
  "properties": {
43
+ "transaction_id": {
44
+ "type": "string",
45
+ "description": "A randomly generated transaction ID, used to correlate the request and response.",
46
+ "format": "guid",
47
+ "example": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b"
48
+ },
39
49
  "auth": {
40
50
  "$ref": "#/components/schemas/Auth"
41
51
  },
42
52
  "fulfillment_provider_order_id": {
43
- "type": "string"
53
+ "type": "string",
54
+ "description": "Fulfillment provider order ID of the fulfillment to request to be cancelled.",
55
+ "example": "3b5aa32d-c082-4058-9c7a-1b523d431b52"
44
56
  },
45
57
  "reason": {
46
- "type": "string"
58
+ "type": "string",
59
+ "description": "The reason for requesting a cancellation.",
60
+ "example": "Customer changed their order"
47
61
  }
48
62
  },
49
63
  "required": [
64
+ "transaction_id",
50
65
  "auth",
51
66
  "fulfillment_provider_order_id",
52
67
  "reason"
@@ -55,69 +70,14 @@
55
70
  }
56
71
  }
57
72
  },
58
- "description": "Request the cancellation of a requested fulfillment send using the /delegate_fulfillment path. This will likely only start the cancellation process. Status updates via /get_fulfillments and /get_recent_changes will return the cancellation status when it is completed."
73
+ "description": "Starts the cancellation process for a requested fulfillment. Fulfillment Provider Order ID was originally returned from the delegate fulfillment method. Status code 200 means the cancellation request was accepted."
59
74
  },
60
75
  "parameters": []
61
76
  },
62
- "/connect": {
63
- "post": {
64
- "summary": "Connect to Fulfillment Provider",
65
- "operationId": "post-connect",
66
- "responses": {
67
- "200": {
68
- "description": "OK",
69
- "content": {
70
- "application/json": {
71
- "schema": {
72
- "type": "object",
73
- "properties": {
74
- "auth": {
75
- "$ref": "#/components/schemas/Auth"
76
- },
77
- "errors": {
78
- "type": "array",
79
- "items": {
80
- "$ref": "#/components/schemas/ConnectError"
81
- }
82
- }
83
- }
84
- }
85
- }
86
- }
87
- }
88
- },
89
- "parameters": [
90
- {
91
- "schema": {
92
- "type": "string"
93
- },
94
- "in": "header",
95
- "name": "tenant-id"
96
- }
97
- ],
98
- "requestBody": {
99
- "content": {
100
- "application/json": {
101
- "schema": {
102
- "type": "object",
103
- "description": "",
104
- "properties": {
105
- "auth": {
106
- "$ref": "#/components/schemas/Auth"
107
- }
108
- }
109
- }
110
- }
111
- },
112
- "description": "Contains form data for connecting to the app"
113
- },
114
- "description": "Verify credentials are valid for a new connection to a fulfillment provider"
115
- }
116
- },
117
77
  "/delegate_fulfillment": {
118
78
  "post": {
119
79
  "summary": "Delegate Fulfillment",
120
- "operationId": "post-fulfillment-delegation",
80
+ "operationId": "post-delegate-fulfillment",
121
81
  "responses": {
122
82
  "200": {
123
83
  "description": "OK",
@@ -127,7 +87,8 @@
127
87
  "type": "object",
128
88
  "properties": {
129
89
  "fulfillment_provider_order_id": {
130
- "type": "string"
90
+ "type": "string",
91
+ "example": "3b5aa32d-c082-4058-9c7a-1b523d431b52"
131
92
  }
132
93
  }
133
94
  }
@@ -135,13 +96,19 @@
135
96
  }
136
97
  }
137
98
  },
138
- "description": "Delegate a sales order to a fulfillment provider. The fulfillment provider will attempt to fulfill the shipment of all line items. Returns the identifier used by the fulfillment provider for subsequent status updates for the order and it's fulfillments. Often this is the same as the order_id.",
99
+ "description": "Send an order to the fulfillment provider. Returns a Fufillment Provider Order ID used on other methods referencing this requested fulfillment.",
139
100
  "requestBody": {
140
101
  "content": {
141
102
  "application/json": {
142
103
  "schema": {
143
104
  "type": "object",
144
105
  "properties": {
106
+ "transaction_id": {
107
+ "type": "string",
108
+ "description": "A randomly generated transaction ID, used to correlate the request and response",
109
+ "format": "guid",
110
+ "example": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b"
111
+ },
145
112
  "auth": {
146
113
  "$ref": "#/components/schemas/Auth"
147
114
  },
@@ -229,220 +196,163 @@
229
196
  }
230
197
  },
231
198
  "required": [
199
+ "transaction_id",
232
200
  "auth",
233
201
  "requested_fulfillments",
234
202
  "status"
235
203
  ]
236
204
  },
237
- "examples": {
238
- "example-1": {
239
- "value": {
240
- "bill_to": {
241
- "address_line_1": "string",
242
- "address_line_2": "string",
243
- "address_line_3": "string",
244
- "city": "string",
245
- "company": "string",
246
- "country_code": "US,MX,CA",
247
- "email": "string",
248
- "is_verified": true,
249
- "name": "string",
250
- "phone": "string",
251
- "pickup_location": {
252
- "carrier_id": "string",
253
- "relay_id": "string"
254
- },
255
- "postal_code": "string",
256
- "residential_indicator": "R",
257
- "state_province": "string"
258
- },
259
- "buyer": {
260
- "buyer_id": "string",
261
- "email": "string",
262
- "name": "string",
263
- "phone": "string"
264
- },
265
- "created_date_time": "2021-03-31T18:21:14.858Z",
266
- "currency": "USD,EUR,NZD",
267
- "fulfilled_date": "2021-03-31T18:21:14.858Z",
268
- "integration_context": "string",
269
- "modified_date_time": "2021-03-31T18:21:14.858Z",
270
- "notes": [
271
- {
272
- "text": "string",
273
- "type": "BackOrderMessage"
205
+ "example": {
206
+ "bill_to": {
207
+ "address_line_1": "string",
208
+ "address_line_2": "string",
209
+ "address_line_3": "string",
210
+ "city": "string",
211
+ "company": "string",
212
+ "country_code": "US,MX,CA",
213
+ "email": "string",
214
+ "is_verified": true,
215
+ "name": "string",
216
+ "phone": "string",
217
+ "pickup_location": {
218
+ "carrier_id": "string",
219
+ "relay_id": "string"
220
+ },
221
+ "postal_code": "string",
222
+ "residential_indicator": "R",
223
+ "state_province": "string"
224
+ },
225
+ "buyer": {
226
+ "buyer_id": "string",
227
+ "email": "string",
228
+ "name": "string",
229
+ "phone": "string"
230
+ },
231
+ "created_date_time": "2021-03-31T18:21:14.858Z",
232
+ "currency": "USD,EUR,NZD",
233
+ "fulfilled_date": "2021-03-31T18:21:14.858Z",
234
+ "integration_context": "string",
235
+ "modified_date_time": "2021-03-31T18:21:14.858Z",
236
+ "notes": [
237
+ {
238
+ "text": "string",
239
+ "type": "BackOrderMessage"
240
+ }
241
+ ],
242
+ "order_id": "string",
243
+ "order_number": "string",
244
+ "order_url": "string",
245
+ "original_order_source": {
246
+ "marketplace_code": "string",
247
+ "order_id": "string",
248
+ "source_id": "string"
249
+ },
250
+ "paid_date": "2021-03-31T18:21:14.858Z",
251
+ "payment": {
252
+ "adjustments": [
253
+ {
254
+ "amount": "string",
255
+ "description": "string"
256
+ }
257
+ ],
258
+ "amount_paid": "string",
259
+ "coupon_code": "string",
260
+ "label_voucher": "string",
261
+ "payment_id": "string",
262
+ "payment_method": "string",
263
+ "payment_status": "AwaitingPayment",
264
+ "shipping_charges": [
265
+ {
266
+ "amount": "string",
267
+ "description": "string"
268
+ }
269
+ ],
270
+ "taxes": [
271
+ {
272
+ "amount": "string",
273
+ "description": "string"
274
+ }
275
+ ]
276
+ },
277
+ "requested_fulfillments": [
278
+ {
279
+ "branding": {
280
+ "company_name": "string",
281
+ "packing_slip": {
282
+ "url": "string"
274
283
  }
275
- ],
276
- "order_id": "string",
277
- "order_number": "string",
278
- "order_url": "string",
279
- "original_order_source": {
280
- "marketplace_code": "string",
281
- "order_id": "string",
282
- "source_id": "string"
283
284
  },
284
- "paid_date": "2021-03-31T18:21:14.858Z",
285
- "payment": {
286
- "adjustments": [
287
- {
288
- "amount": "string",
289
- "description": "string"
290
- }
291
- ],
292
- "amount_paid": "string",
293
- "coupon_code": "string",
294
- "label_voucher": "string",
295
- "payment_id": "string",
296
- "payment_method": "string",
297
- "payment_status": "AwaitingPayment",
298
- "shipping_charges": [
299
- {
300
- "amount": "string",
301
- "description": "string"
302
- }
303
- ],
304
- "taxes": [
305
- {
306
- "amount": "string",
307
- "description": "string"
308
- }
309
- ]
285
+ "extensions": {
286
+ "custom_field_1": "string",
287
+ "custom_field_2": "string",
288
+ "custom_field_3": "string"
310
289
  },
311
- "requested_fulfillments": [
290
+ "items": [
312
291
  {
313
- "branding": {
314
- "company_name": "string",
315
- "packing_slip": {
316
- "url": "string"
317
- }
318
- },
319
- "extensions": {
320
- "custom_field_1": "string",
321
- "custom_field_2": "string",
322
- "custom_field_3": "string"
323
- },
324
- "items": [
292
+ "adjustments": [
325
293
  {
326
- "adjustments": [
327
- {
328
- "amount": "string",
329
- "description": "string"
330
- }
331
- ],
332
- "description": "string",
333
- "item_url": "string",
334
- "line_item_id": "string",
335
- "modified_date_time": "2021-03-31T18:21:14.858Z",
336
- "product": {
337
- "description": "string",
338
- "details": [
339
- {
340
- "name": "Color",
341
- "value": "Red"
342
- }
343
- ],
344
- "dimensions": {
345
- "height": 0,
346
- "length": 0,
347
- "unit": "Centimeter",
348
- "width": 0
349
- },
350
- "identifiers": {
351
- "asin": "string",
352
- "fulfillment_sku": "string",
353
- "inventory_id": "string",
354
- "isbn": "string",
355
- "sku": "string",
356
- "upc": "string"
357
- },
358
- "location": "string",
359
- "name": "string",
360
- "product_id": "string",
361
- "unit_code": 0,
362
- "urls": {
363
- "image_url": "string",
364
- "product_url": "string",
365
- "thumbnail_url": "string"
366
- },
367
- "weight": {
368
- "unit": "Gram",
369
- "value": "string"
370
- }
371
- },
372
- "quantity": 0,
373
- "shipping_charges": [
374
- {
375
- "amount": "string",
376
- "description": "string"
377
- }
378
- ],
379
- "taxes": [
380
- {
381
- "amount": "string",
382
- "description": "string"
383
- }
384
- ],
385
- "unit_price": 0
294
+ "amount": "string",
295
+ "description": "string"
386
296
  }
387
297
  ],
388
- "requested_fulfillment_id": "string",
389
- "ship_to": {
390
- "address_line_1": "string",
391
- "address_line_2": "string",
392
- "address_line_3": "string",
393
- "city": "string",
394
- "company": "string",
395
- "country_code": "US,MX,CA",
396
- "is_verified": true,
397
- "name": "string",
398
- "first_name": "string",
399
- "last_name": "string",
400
- "phone": "string",
401
- "pickup_location": {
402
- "carrier_id": "string",
403
- "relay_id": "string"
404
- },
405
- "postal_code": "string",
406
- "residential_indicator": "R",
407
- "state_province": "string"
408
- },
409
- "shipping_preferences": {
410
- "additional_handling": true,
411
- "bill_duties_to_sender": true,
412
- "deliver_by_date": "2021-03-31T18:21:14.858Z",
413
- "digital_fulfillment": true,
414
- "do_not_prepay_postage": true,
415
- "documents": [
298
+ "description": "string",
299
+ "item_url": "string",
300
+ "line_item_id": "string",
301
+ "modified_date_time": "2021-03-31T18:21:14.858Z",
302
+ "product": {
303
+ "description": "string",
304
+ "details": [
416
305
  {
417
- "data": "string",
418
- "format": "PDF",
419
- "type": [
420
- "commercial_invoice"
421
- ]
306
+ "name": "Color",
307
+ "value": "Red"
422
308
  }
423
309
  ],
424
- "gift": true,
425
- "has_alcohol": true,
426
- "hold_until_date": "2021-03-31T18:21:14.858Z",
427
- "insurance_requested": true,
428
- "insured_value": 0,
429
- "is_premium_program": true,
430
- "non_machinable": true,
431
- "package_type": "string",
432
- "premium_program_name": "string",
433
- "preplanned_fulfillment_id": "string",
434
- "ready_to_ship_date": "2021-03-31T18:21:14.858Z",
435
- "requested_warehouse": "string",
436
- "saturday_delivery": true,
437
- "ship_by_date": "2021-03-31T18:21:14.858Z",
438
- "shipping_service": "string",
439
- "show_postage": true,
440
- "suppress_email_notify": true,
441
- "suppress_marketplace_notify": true
442
- }
310
+ "dimensions": {
311
+ "height": 0,
312
+ "length": 0,
313
+ "unit": "Centimeter",
314
+ "width": 0
315
+ },
316
+ "identifiers": {
317
+ "asin": "string",
318
+ "fulfillment_sku": "string",
319
+ "inventory_id": "string",
320
+ "isbn": "string",
321
+ "sku": "string",
322
+ "upc": "string"
323
+ },
324
+ "location": "string",
325
+ "name": "string",
326
+ "product_id": "string",
327
+ "unit_code": 0,
328
+ "urls": {
329
+ "image_url": "string",
330
+ "product_url": "string",
331
+ "thumbnail_url": "string"
332
+ },
333
+ "weight": {
334
+ "unit": "Gram",
335
+ "value": "string"
336
+ }
337
+ },
338
+ "quantity": 0,
339
+ "shipping_charges": [
340
+ {
341
+ "amount": "string",
342
+ "description": "string"
343
+ }
344
+ ],
345
+ "taxes": [
346
+ {
347
+ "amount": "string",
348
+ "description": "string"
349
+ }
350
+ ],
351
+ "unit_price": 0
443
352
  }
444
353
  ],
445
- "ship_from": {
354
+ "requested_fulfillment_id": "string",
355
+ "ship_to": {
446
356
  "address_line_1": "string",
447
357
  "address_line_2": "string",
448
358
  "address_line_3": "string",
@@ -462,30 +372,75 @@
462
372
  "residential_indicator": "R",
463
373
  "state_province": "string"
464
374
  },
465
- "status": "AwaitingPayment"
375
+ "shipping_preferences": {
376
+ "additional_handling": true,
377
+ "bill_duties_to_sender": true,
378
+ "deliver_by_date": "2021-03-31T18:21:14.858Z",
379
+ "digital_fulfillment": true,
380
+ "do_not_prepay_postage": true,
381
+ "documents": [
382
+ {
383
+ "data": "string",
384
+ "format": "PDF",
385
+ "type": [
386
+ "commercial_invoice"
387
+ ]
388
+ }
389
+ ],
390
+ "gift": true,
391
+ "has_alcohol": true,
392
+ "hold_until_date": "2021-03-31T18:21:14.858Z",
393
+ "insurance_requested": true,
394
+ "insured_value": 0,
395
+ "is_premium_program": true,
396
+ "non_machinable": true,
397
+ "package_type": "string",
398
+ "premium_program_name": "string",
399
+ "preplanned_fulfillment_id": "string",
400
+ "ready_to_ship_date": "2021-03-31T18:21:14.858Z",
401
+ "requested_warehouse": "string",
402
+ "saturday_delivery": true,
403
+ "ship_by_date": "2021-03-31T18:21:14.858Z",
404
+ "shipping_service": "string",
405
+ "show_postage": true,
406
+ "suppress_email_notify": true,
407
+ "suppress_marketplace_notify": true
408
+ }
466
409
  }
467
- }
410
+ ],
411
+ "ship_from": {
412
+ "address_line_1": "string",
413
+ "address_line_2": "string",
414
+ "address_line_3": "string",
415
+ "city": "string",
416
+ "company": "string",
417
+ "country_code": "US,MX,CA",
418
+ "is_verified": true,
419
+ "name": "string",
420
+ "first_name": "string",
421
+ "last_name": "string",
422
+ "phone": "string",
423
+ "pickup_location": {
424
+ "carrier_id": "string",
425
+ "relay_id": "string"
426
+ },
427
+ "postal_code": "string",
428
+ "residential_indicator": "R",
429
+ "state_province": "string"
430
+ },
431
+ "status": "AwaitingPayment"
468
432
  }
469
433
  }
470
434
  },
471
435
  "description": ""
472
- },
473
- "parameters": [
474
- {
475
- "schema": {
476
- "type": "string"
477
- },
478
- "in": "header",
479
- "name": "tenant-id"
480
- }
481
- ]
436
+ }
482
437
  },
483
438
  "parameters": []
484
439
  },
485
440
  "/get_fulfillments": {
486
441
  "post": {
487
442
  "summary": "Get Fulfillments",
488
- "operationId": "post-fulfillment-status",
443
+ "operationId": "post-get-fulfillments",
489
444
  "responses": {
490
445
  "200": {
491
446
  "description": "OK",
@@ -495,7 +450,8 @@
495
450
  "type": "object",
496
451
  "properties": {
497
452
  "fulfillment_provider_order_id": {
498
- "type": "string"
453
+ "type": "string",
454
+ "example": "3b5aa32d-c082-4058-9c7a-1b523d431b52"
499
455
  },
500
456
  "status": {
501
457
  "type": "string"
@@ -534,123 +490,68 @@
534
490
  "fulfillment_provider_order_id"
535
491
  ]
536
492
  },
537
- "examples": {
538
- "example-1": {
539
- "value": {
540
- "fulfillment_provider_order_id": "string",
541
- "status": "string",
542
- "fulfillments": [
493
+ "example": {
494
+ "fulfillment_provider_order_id": "3b5aa32d-c082-4058-9c7a-1b523d431b52",
495
+ "status": "Shipped",
496
+ "fulfillments": [
497
+ {
498
+ "status": "Shipped",
499
+ "line_items": [
543
500
  {
544
- "status": "Processing",
545
- "reason": "string",
546
- "explanation": "string",
547
- "line_items": [
548
- {
549
- "line_item_id": "string",
550
- "sku": "string",
551
- "quantity": 0
552
- }
553
- ]
501
+ "line_item_id": "95dcceef-e500-4da0-9c03-eec73bb763bf",
502
+ "sku": "sku-123",
503
+ "quantity": 1
554
504
  }
555
- ],
556
- "shipments": [
505
+ ]
506
+ }
507
+ ],
508
+ "shipments": [
509
+ {
510
+ "carrier_code": "UPS",
511
+ "carrier_service_code": "Expedited",
512
+ "items": [
557
513
  {
558
- "carrier_code": "string",
559
- "carrier_service_code": "string",
560
- "currency": "USD,EUR,NZD",
561
- "ext_location_id": "string",
562
- "fulfillment_cost": 0,
563
- "insurance_cost": 0,
564
- "integration_context": {},
565
- "items": [
566
- {
567
- "description": "string",
568
- "line_item_id": "string",
569
- "product_id": "string",
570
- "quantity": 0,
571
- "sku": "string"
572
- }
573
- ],
574
- "notes": [
575
- {
576
- "text": "string",
577
- "type": "BackOrderMessage"
578
- }
579
- ],
580
- "notification_id": "string",
581
- "notify_buyer": true,
582
- "order_id": "string",
583
- "order_number": "string",
584
- "return_address": {
585
- "address_line_1": "string",
586
- "address_line_2": "string",
587
- "address_line_3": "string",
588
- "city": "string",
589
- "company": "string",
590
- "country_code": "US,MX,CA",
591
- "is_verified": true,
592
- "name": "string",
593
- "first_name": "string",
594
- "last_name": "string",
595
- "phone": "string",
596
- "pickup_location": {
597
- "carrier_id": "string",
598
- "relay_id": "string"
599
- },
600
- "postal_code": "string",
601
- "residential_indicator": "R",
602
- "state_province": "string"
603
- },
604
- "ship_date": "2021-03-31T18:21:14.858Z",
605
- "ship_from": {
606
- "address_line_1": "string",
607
- "address_line_2": "string",
608
- "address_line_3": "string",
609
- "city": "string",
610
- "company": "string",
611
- "country_code": "US,MX,CA",
612
- "is_verified": true,
613
- "name": "string",
614
- "first_name": "string",
615
- "last_name": "string",
616
- "phone": "string",
617
- "pickup_location": {
618
- "carrier_id": "string",
619
- "relay_id": "string"
620
- },
621
- "postal_code": "string",
622
- "residential_indicator": "R",
623
- "state_province": "string"
624
- },
625
- "ship_to": {
626
- "address_line_1": "string",
627
- "address_line_2": "string",
628
- "address_line_3": "string",
629
- "city": "string",
630
- "company": "string",
631
- "country_code": "US,MX,CA",
632
- "is_verified": true,
633
- "name": "string",
634
- "first_name": "string",
635
- "last_name": "string",
636
- "phone": "string",
637
- "pickup_location": {
638
- "carrier_id": "string",
639
- "relay_id": "string"
640
- },
641
- "postal_code": "string",
642
- "residential_indicator": "R",
643
- "state_province": "string"
644
- },
645
- "tracking_number": "string",
646
- "tracking_url": "string"
514
+ "line_item_id": "95dcceef-e500-4da0-9c03-eec73bb763bf",
515
+ "product_id": "sku-123",
516
+ "quantity": 1,
517
+ "sku": "sku-123"
647
518
  }
648
519
  ],
649
- "polling": {
650
- "is_final_update_state": true,
651
- "max_age_seconds": 0
652
- }
520
+ "notification_id": "f56f941a-43a6-41da-b056-7cba2c6c7493",
521
+ "notify_buyer": true,
522
+ "order_id": "3b5aa32d-c082-4058-9c7a-1b523d431b52",
523
+ "ship_date": "2021-03-31T18:21:14.858Z",
524
+ "ship_from": {
525
+ "address_line_1": "123 Boxing St",
526
+ "city": "New York",
527
+ "country_code": "US",
528
+ "is_verified": true,
529
+ "name": "John Doe",
530
+ "first_name": "John",
531
+ "last_name": "Doe",
532
+ "phone": "555-555-5555",
533
+ "postal_code": "55555",
534
+ "residential_indicator": "R",
535
+ "state_province": "NY"
536
+ },
537
+ "ship_to": {
538
+ "address_line_1": "123 Boxing St",
539
+ "city": "New York",
540
+ "country_code": "US",
541
+ "is_verified": true,
542
+ "name": "John Doe",
543
+ "first_name": "John",
544
+ "last_name": "Doe",
545
+ "phone": "555-555-5555",
546
+ "postal_code": "55555",
547
+ "residential_indicator": "R",
548
+ "state_province": "NY"
549
+ },
550
+ "tracking_number": "UPSEXP444"
653
551
  }
552
+ ],
553
+ "polling": {
554
+ "is_final_update_state": true
654
555
  }
655
556
  }
656
557
  }
@@ -663,14 +564,22 @@
663
564
  "schema": {
664
565
  "type": "object",
665
566
  "properties": {
567
+ "transaction_id": {
568
+ "type": "string",
569
+ "description": "A randomly generated transaction ID, used to correlate the request and response.",
570
+ "format": "guid",
571
+ "example": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b"
572
+ },
666
573
  "auth": {
667
574
  "$ref": "#/components/schemas/Auth"
668
575
  },
669
576
  "fulfillment_provider_order_id": {
670
- "type": "string"
577
+ "type": "string",
578
+ "example": "3b5aa32d-c082-4058-9c7a-1b523d431b52"
671
579
  }
672
580
  },
673
581
  "required": [
582
+ "transaction_id",
674
583
  "auth",
675
584
  "fulfillment_provider_order_id"
676
585
  ]
@@ -678,23 +587,14 @@
678
587
  }
679
588
  }
680
589
  },
681
- "description": "Returns a list of fulfillments that the fulfillment provider has decided to use to fulfill an order. It may return only a root level status, which indicates a single status for all line items on an order. It may also return a list of fulfillments, their status, and the line items included in that fulfillment. Fulfillments may or may not match a list of shipments, this is completely up to the fulfillment provider.\n\nTo communicate that the results for an order will no longer change the polling fields is_final_update_state should be set to true. \n\nThe polling fields max_age_seconds refers to the expected cachable time of this result.\n\nTo instead return a list of changes on a periodic basis, refer to the /get_recent_changes path instead.",
682
- "parameters": [
683
- {
684
- "schema": {
685
- "type": "string"
686
- },
687
- "in": "header",
688
- "name": "tenant-id"
689
- }
690
- ]
590
+ "description": "Returns the fulfillment provider shipping status of all line items from a requested fulfillment."
691
591
  },
692
592
  "parameters": []
693
593
  },
694
594
  "/get_rates": {
695
595
  "post": {
696
- "summary": "Get Estimated Rates",
697
- "operationId": "post-rates",
596
+ "summary": "Get Rates",
597
+ "operationId": "post-get-rates",
698
598
  "responses": {
699
599
  "200": {
700
600
  "description": "OK",
@@ -713,6 +613,12 @@
713
613
  "schema": {
714
614
  "type": "object",
715
615
  "properties": {
616
+ "transaction_id": {
617
+ "type": "string",
618
+ "description": "A randomly generated transaction ID, used to correlate the request and response.",
619
+ "format": "guid",
620
+ "example": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b"
621
+ },
716
622
  "advanced_options": {
717
623
  "type": "object",
718
624
  "description": "This is a schemaless object. It is for open ended customizations unique to particular carriers. If the field is absent it should be interpreted as the default value for any applicable options, e.g. false for booleans."
@@ -779,21 +685,13 @@
779
685
  "ship_to": {
780
686
  "$ref": "#/components/schemas/ShippingAddress"
781
687
  }
782
- }
688
+ },
689
+ "required": ["transaction_id","auth"]
783
690
  }
784
691
  }
785
692
  }
786
693
  },
787
- "description": "This method get possible rates for labels between two addresses.",
788
- "parameters": [
789
- {
790
- "schema": {
791
- "type": "string"
792
- },
793
- "in": "header",
794
- "name": "tenant-id"
795
- }
796
- ]
694
+ "description": "This method get possible rates for labels between two addresses."
797
695
  },
798
696
  "parameters": []
799
697
  },
@@ -801,7 +699,7 @@
801
699
  "parameters": [],
802
700
  "post": {
803
701
  "summary": "Get Recent Changes",
804
- "operationId": "post-fulfillment-get-recent-changes",
702
+ "operationId": "post-get-recent-changes",
805
703
  "responses": {
806
704
  "200": {
807
705
  "description": "OK",
@@ -813,11 +711,17 @@
813
711
  "changes": {
814
712
  "type": "array",
815
713
  "items": {
816
- "$ref": "#/components/schemas/SalesOrderFulfillment"
714
+ "$ref": "#/components/schemas/SalesOrderFulfillments"
817
715
  }
818
716
  },
819
717
  "next_request": {
820
- "type": "string"
718
+ "oneOf": [
719
+ { "type": "string" },
720
+ { "type": "object" }
721
+ ],
722
+ "example": {
723
+ "next_page": "0289ef4c"
724
+ }
821
725
  }
822
726
  }
823
727
  }
@@ -825,40 +729,40 @@
825
729
  }
826
730
  }
827
731
  },
828
- "description": "Receives a timestamp of the last time requested changes was made, automatically buffered to include duplicate results to prevent skipping time.\n\nReturns a list of changes. These changes include fulfillments that the fulfillment provider has decided to use to fulfill an order. It may return only an order level status, which indicates a single status for all line items on an order. It may also return a list of fulfillments, their status, and the line items included in that fulfillment. Fulfillments may or may not match a list of shipments, this is completely up to the fulfillment provider.\n\nTo instead return status on single orders at a time , refer to the /get_fulfillments path instead.",
732
+ "description": "Returns shipping statuses for fulfillments that have been updated since a specific date and time. Pagination is available in the next_request fields. Return the next expected request in the next_request response field. Pagination ends when the next_request response field is empty.",
829
733
  "requestBody": {
830
734
  "content": {
831
735
  "application/json": {
832
736
  "schema": {
833
737
  "type": "object",
834
738
  "properties": {
739
+ "transaction_id": {
740
+ "type": "string",
741
+ "description": "A randomly generated transaction ID, used to correlate the request and response.",
742
+ "format": "guid",
743
+ "example": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b"
744
+ },
835
745
  "auth": {
836
746
  "$ref": "#/components/schemas/Auth"
837
747
  },
838
748
  "next_request": {
839
- "type": [
840
- "object",
841
- "string"
842
- ]
749
+ "oneOf": [
750
+ { "type": "string" },
751
+ { "type": "object" }
752
+ ],
753
+ "example": null
843
754
  },
844
755
  "since": {
845
- "type": "string"
756
+ "type": "string",
757
+ "format": "date-time"
846
758
  }
847
- }
759
+ },
760
+ "required": ["transaction_id","auth","since"]
848
761
  },
849
762
  "examples": {}
850
763
  }
851
764
  }
852
- },
853
- "parameters": [
854
- {
855
- "schema": {
856
- "type": "string"
857
- },
858
- "in": "header",
859
- "name": "tenant-id"
860
- }
861
- ]
765
+ }
862
766
  }
863
767
  },
864
768
  "/get_inventory": {
@@ -894,25 +798,23 @@
894
798
  }
895
799
  },
896
800
  "next_request": {
897
- "type": [
898
- "string",
899
- "object"
801
+ "oneOf": [
802
+ { "type": "string" },
803
+ { "type": "object" }
900
804
  ]
901
805
  }
902
806
  }
903
807
  },
904
- "examples": {
905
- "example-1": {
906
- "value": {
907
- "inventory": {
908
- "sku": "string",
909
- "warehouse_id": "string",
910
- "available_quantity": "string",
911
- "committed_quantity": "string",
912
- "on_hand_quantity": "string"
913
- },
914
- "next_request": "string"
915
- }
808
+ "example": {
809
+ "inventory": {
810
+ "sku": "sku-123",
811
+ "warehouse_id": "26d29491",
812
+ "available_quantity": "1",
813
+ "committed_quantity": "0",
814
+ "on_hand_quantity": "1"
815
+ },
816
+ "next_request": {
817
+ "next_page": "0289ef4c"
916
818
  }
917
819
  }
918
820
  }
@@ -925,24 +827,40 @@
925
827
  "schema": {
926
828
  "type": "object",
927
829
  "properties": {
830
+ "transaction_id": {
831
+ "type": "string",
832
+ "description": "A randomly generated transaction ID, used to correlate the request and response.",
833
+ "format": "guid",
834
+ "example": "8e4e3181-2a7e-4153-ba6a-f2d6e121500b"
835
+ },
928
836
  "auth": {
929
837
  "$ref": "#/components/schemas/Auth"
930
838
  },
839
+ "skus": {
840
+ "type": "array",
841
+ "items": {
842
+ "type": "string",
843
+ "example": "sku-123"
844
+ },
845
+ "description": "Comma separated list of skus to be used as filter criteria"
846
+ },
931
847
  "next_request": {
932
- "type": [
933
- "object",
934
- "string"
935
- ]
848
+ "oneOf": [
849
+ { "type": "string" },
850
+ { "type": "object" }
851
+ ],
852
+ "example": null
936
853
  }
937
854
  },
938
855
  "required": [
856
+ "transaction_id",
939
857
  "auth"
940
858
  ]
941
859
  }
942
860
  }
943
861
  }
944
862
  },
945
- "description": "Return the inventory that a fulfillment provider currently has for this merchant. Pagination is supplied via the next_request field. Pagination requests will be made until next_request is set to null. This is an optional path only for fulfillment providers who support inventory and are added as inventory provider integrations."
863
+ "description": "Returns the inventory level of skus within the fulfillment provider warehouses. Pagination is available in the next_request fields. Return the next expected request in the next_request response field. Pagination ends when the next_request response field is empty."
946
864
  },
947
865
  "parameters": []
948
866
  }
@@ -1025,6 +943,10 @@
1025
943
  "title": "Auth",
1026
944
  "type": "object",
1027
945
  "description": "Authentication properties",
946
+ "example": {
947
+ "access_token": "0cbf28e21b84443b9a9b31c4067d4771",
948
+ "fulfillment_provider_api_code": "test"
949
+ },
1028
950
  "properties": {
1029
951
  "access_token": {
1030
952
  "type": "string",
@@ -1044,9 +966,6 @@
1044
966
  "password": {
1045
967
  "type": "string"
1046
968
  },
1047
- "url": {
1048
- "type": "string"
1049
- },
1050
969
  "username": {
1051
970
  "type": "string"
1052
971
  }
@@ -2240,12 +2159,10 @@
2240
2159
  "title": "ProductDetail",
2241
2160
  "type": "object",
2242
2161
  "description": "Details about a product",
2243
- "examples": [
2244
- {
2245
- "name": "Color",
2246
- "value": "Red"
2247
- }
2248
- ],
2162
+ "example": {
2163
+ "name": "Color",
2164
+ "value": "Red"
2165
+ },
2249
2166
  "properties": {
2250
2167
  "name": {
2251
2168
  "type": "string",
@@ -2446,7 +2363,8 @@
2446
2363
  "Cancelled",
2447
2364
  "Rejected",
2448
2365
  "Shipped"
2449
- ]
2366
+ ],
2367
+ "example": "Shipped"
2450
2368
  },
2451
2369
  "SalesOrderFulfillment": {
2452
2370
  "title": "SalesOrderFulfillment",
@@ -2457,10 +2375,12 @@
2457
2375
  "$ref": "#/components/schemas/SalesOrderFulfillmentStatus"
2458
2376
  },
2459
2377
  "reason": {
2460
- "type": "string"
2378
+ "type": "string",
2379
+ "example": "Shipped"
2461
2380
  },
2462
2381
  "explanation": {
2463
- "type": "string"
2382
+ "type": "string",
2383
+ "example": "The items were shipped asap."
2464
2384
  },
2465
2385
  "line_items": {
2466
2386
  "type": "array",
@@ -2868,19 +2788,19 @@
2868
2788
  },
2869
2789
  "FulfillmentLineItem": {
2870
2790
  "title": "FulfillmentLineItem",
2871
- "x-stoplight": {
2872
- "id": "0wglkamy8lqi5"
2873
- },
2874
2791
  "type": "object",
2875
2792
  "properties": {
2876
2793
  "line_item_id": {
2877
- "type": "string"
2794
+ "type": "string",
2795
+ "example": "95dcceef-e500-4da0-9c03-eec73bb763bf"
2878
2796
  },
2879
2797
  "sku": {
2880
- "type": "string"
2798
+ "type": "string",
2799
+ "example": "sku-123"
2881
2800
  },
2882
2801
  "quantity": {
2883
- "type": "number"
2802
+ "type": "number",
2803
+ "example": 1
2884
2804
  }
2885
2805
  },
2886
2806
  "required": [
@@ -2889,13 +2809,11 @@
2889
2809
  },
2890
2810
  "SalesOrderFulfillments": {
2891
2811
  "title": "SalesOrderFulfillments",
2892
- "x-stoplight": {
2893
- "id": "0mccgdffw5fq2"
2894
- },
2895
2812
  "type": "object",
2896
2813
  "properties": {
2897
2814
  "fulfillment_provider_order_id": {
2898
- "type": "string"
2815
+ "type": "string",
2816
+ "example": "3b5aa32d-c082-4058-9c7a-1b523d431b52"
2899
2817
  },
2900
2818
  "status": {
2901
2819
  "$ref": "#/components/schemas/SalesOrderFulfillmentStatus"
@@ -2919,9 +2837,6 @@
2919
2837
  },
2920
2838
  "GetFulfillmentsError": {
2921
2839
  "title": "GetFulfillmentsError",
2922
- "x-stoplight": {
2923
- "id": "8mnh6631wyx16"
2924
- },
2925
2840
  "type": "object",
2926
2841
  "properties": {
2927
2842
  "code": {
@@ -2935,9 +2850,6 @@
2935
2850
  "GetFulfillmentsErrorCode": {
2936
2851
  "type": "string",
2937
2852
  "title": "GetFulfillmentsErrorCode",
2938
- "x-stoplight": {
2939
- "id": "dzb4hofw881kj"
2940
- },
2941
2853
  "enum": [
2942
2854
  "fulfillments_not_found"
2943
2855
  ]
@@ -2945,9 +2857,6 @@
2945
2857
  "ConnectErrorCode": {
2946
2858
  "type": "string",
2947
2859
  "title": "ConnectErrorCode",
2948
- "x-stoplight": {
2949
- "id": "vy21oyz941sk2"
2950
- },
2951
2860
  "enum": [
2952
2861
  "credentials_invalid",
2953
2862
  "permissions_invalid"
@@ -2955,9 +2864,6 @@
2955
2864
  },
2956
2865
  "ConnectError": {
2957
2866
  "title": "ConnectError",
2958
- "x-stoplight": {
2959
- "id": "lmd9k86jy1e28"
2960
- },
2961
2867
  "type": "object",
2962
2868
  "properties": {
2963
2869
  "code": {