@whiplashmerch/whiplash-api-client 2.0.36 → 3.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.
Files changed (127) hide show
  1. package/dist/client.esm.js +3953 -16323
  2. package/dist/client.esm.js.map +1 -1
  3. package/dist/generated/AccountTransactions.d.ts +2 -2
  4. package/dist/generated/Accounts.d.ts +9 -9
  5. package/dist/generated/BillOfLadings.d.ts +4 -4
  6. package/dist/generated/Broadcasts.d.ts +2 -2
  7. package/dist/generated/BundleItems.d.ts +2 -2
  8. package/dist/generated/CarrierAccounts.d.ts +12 -12
  9. package/dist/generated/Carriers.d.ts +37 -1
  10. package/dist/generated/Chromalists.d.ts +2 -2
  11. package/dist/generated/ConsumerReturns.d.ts +10 -10
  12. package/dist/generated/Currencies.d.ts +2 -2
  13. package/dist/generated/Customers.d.ts +15 -15
  14. package/dist/generated/Documents.d.ts +3 -3
  15. package/dist/generated/FilterSets.d.ts +10 -10
  16. package/dist/generated/ImporterOfRecords.d.ts +5 -5
  17. package/dist/generated/Incidents.d.ts +2 -2
  18. package/dist/generated/InvoiceItems.d.ts +4 -4
  19. package/dist/generated/Invoices.d.ts +4 -4
  20. package/dist/generated/Items.d.ts +31 -31
  21. package/dist/generated/Loads.d.ts +4 -4
  22. package/dist/generated/LocationAdjustments.d.ts +5 -5
  23. package/dist/generated/LocationAudits.d.ts +3 -3
  24. package/dist/generated/LocationTransfers.d.ts +3 -3
  25. package/dist/generated/Locations.d.ts +11 -11
  26. package/dist/generated/Lots.d.ts +10 -10
  27. package/dist/generated/Manifests.d.ts +7 -7
  28. package/dist/generated/MetaKeys.d.ts +4 -4
  29. package/dist/generated/Nav.d.ts +2 -2
  30. package/dist/generated/NavItems.d.ts +2 -2
  31. package/dist/generated/NotificationEvents.d.ts +3 -3
  32. package/dist/generated/NotificationSubscriptions.d.ts +8 -8
  33. package/dist/generated/OrderBatchItems.d.ts +3 -3
  34. package/dist/generated/OrderBatchRequests.d.ts +2 -2
  35. package/dist/generated/OrderBatches.d.ts +17 -17
  36. package/dist/generated/OrderDocuments.d.ts +2 -2
  37. package/dist/generated/OrderItems.d.ts +13 -13
  38. package/dist/generated/OrderTotes.d.ts +4 -4
  39. package/dist/generated/Orders.d.ts +29 -29
  40. package/dist/generated/Originators.d.ts +8 -8
  41. package/dist/generated/Packages.d.ts +12 -12
  42. package/dist/generated/Pallets.d.ts +5 -5
  43. package/dist/generated/Partners.d.ts +2 -2
  44. package/dist/generated/ProjectTasks.d.ts +2 -2
  45. package/dist/generated/Projects.d.ts +4 -4
  46. package/dist/generated/Public.d.ts +2 -2
  47. package/dist/generated/Rates.d.ts +10 -10
  48. package/dist/generated/ReasonCodes.d.ts +3 -3
  49. package/dist/generated/RelocateInventoryTransfers.d.ts +2 -2
  50. package/dist/generated/ReturnAddresses.d.ts +7 -7
  51. package/dist/generated/Rules.d.ts +8 -8
  52. package/dist/generated/ScancodeAliases.d.ts +2 -2
  53. package/dist/generated/Scancodes.d.ts +2 -2
  54. package/dist/generated/Schemas.d.ts +20 -0
  55. package/dist/generated/SerialNumbers.d.ts +2 -2
  56. package/dist/generated/ShipnoticeItems.d.ts +18 -18
  57. package/dist/generated/Shipnotices.d.ts +22 -22
  58. package/dist/generated/ShippingAliases.d.ts +8 -8
  59. package/dist/generated/ShippingBlacklistedMethods.d.ts +2 -2
  60. package/dist/generated/ShippingMethodMarkups.d.ts +7 -7
  61. package/dist/generated/ShippingMethods.d.ts +4 -4
  62. package/dist/generated/Shops.d.ts +9 -9
  63. package/dist/generated/Stats.d.ts +3 -3
  64. package/dist/generated/SurchargeMarkups.d.ts +4 -4
  65. package/dist/generated/TemplateTypes.d.ts +2 -2
  66. package/dist/generated/Templates.d.ts +14 -14
  67. package/dist/generated/Transactions.d.ts +7 -7
  68. package/dist/generated/TransportationMarkups.d.ts +4 -4
  69. package/dist/generated/Users.d.ts +6 -6
  70. package/dist/generated/WarehouseFeatures.d.ts +2 -2
  71. package/dist/generated/Warehouses.d.ts +7 -7
  72. package/dist/generated/Wholesales.d.ts +2 -2
  73. package/dist/generated/data-contracts.d.ts +3341 -1071
  74. package/dist/generated/index.d.ts +1 -0
  75. package/dist/mock-data/index.d.ts +13 -5
  76. package/dist/mock-data/v2/consumer-return/all.d.ts +1 -1087
  77. package/dist/mock-data/v2/consumer-return/in-transit.d.ts +192 -355
  78. package/dist/mock-data/v2/customer/normal.d.ts +1 -0
  79. package/dist/mock-data/v2/item/bundle.d.ts +61 -0
  80. package/dist/mock-data/v2/item/merch.d.ts +121 -0
  81. package/dist/mock-data/v2/item/packaging.d.ts +61 -0
  82. package/dist/mock-data/v2/item/single.d.ts +9 -5
  83. package/dist/mock-data/v2/location/multiple.d.ts +78 -0
  84. package/dist/mock-data/v2/location/single.d.ts +78 -0
  85. package/dist/mock-data/v2/order/all.d.ts +1 -1665
  86. package/dist/mock-data/v2/order/processing.d.ts +67 -20
  87. package/dist/mock-data/v2/shipnotice/all.d.ts +1 -621
  88. package/dist/mock-data/v2/shipnotice/in-transit.d.ts +94 -51
  89. package/dist/mock-data/v2/shipnotice/processing.d.ts +90 -47
  90. package/dist/mock-data/v2_1/consumer-return/all.d.ts +1 -1087
  91. package/dist/mock-data/v2_1/consumer-return/in-transit.d.ts +10 -500
  92. package/dist/mock-data/v2_1/importer-of-record/created.d.ts +1 -0
  93. package/dist/mock-data/v2_1/item/bundle.d.ts +60 -0
  94. package/dist/mock-data/v2_1/item/merch.d.ts +119 -0
  95. package/dist/mock-data/v2_1/item/packaging.d.ts +60 -0
  96. package/dist/mock-data/v2_1/item/single.d.ts +9 -6
  97. package/dist/mock-data/v2_1/location/multiple.d.ts +15 -0
  98. package/dist/mock-data/v2_1/location/single.d.ts +15 -0
  99. package/dist/mock-data/v2_1/order/all.d.ts +1 -384
  100. package/dist/mock-data/v2_1/order/processing.d.ts +49 -86
  101. package/dist/mock-data/v2_1/order-batch/in-load.d.ts +0 -56
  102. package/dist/mock-data/v2_1/order-batch/wholesale-available.d.ts +0 -56
  103. package/dist/mock-data/v2_1/return-address/created.d.ts +1 -0
  104. package/dist/mock-data/v2_1/shipnotice/all.d.ts +1 -367
  105. package/dist/mock-data/v2_1/shipnotice/in-transit.d.ts +20 -198
  106. package/dist/mock-data/v2_1/shipnotice/processing.d.ts +18 -196
  107. package/generated/BundleItems.ts +8 -7
  108. package/generated/CarrierAliases.ts +3 -3
  109. package/generated/ConsumerReturns.ts +22 -20
  110. package/generated/Customers.ts +12 -11
  111. package/generated/Documents.ts +11 -11
  112. package/generated/Items.ts +56 -48
  113. package/generated/NotificationEvents.ts +6 -5
  114. package/generated/NotificationSubscriptions.ts +16 -15
  115. package/generated/OrderDocuments.ts +3 -3
  116. package/generated/OrderItems.ts +25 -24
  117. package/generated/OrderTotes.ts +6 -5
  118. package/generated/Orders.ts +47 -42
  119. package/generated/Originators.ts +4 -3
  120. package/generated/Projects.ts +4 -3
  121. package/generated/ShipnoticeItems.ts +17 -16
  122. package/generated/Shipnotices.ts +32 -30
  123. package/generated/Simulate.ts +13 -13
  124. package/generated/Templates.ts +11 -13
  125. package/generated/WholesaleItems.ts +9 -9
  126. package/generated/data-contracts.ts +558 -48
  127. package/package.json +1 -1
@@ -1,1087 +1 @@
1
- export declare const ApiV21ConsumerReturnAllExample: ({
2
- id: number;
3
- order_id: number;
4
- customer_id: number;
5
- warehouse_id: number;
6
- sender: string;
7
- eta: string;
8
- status: number;
9
- status_name: string;
10
- received_by: null;
11
- notes_by_whiplash: null;
12
- notes_by_customer: null;
13
- total_boxes: number;
14
- created_at: string;
15
- updated_at: string;
16
- arrived_at: string;
17
- skip_images: null;
18
- easypostable_id: null;
19
- easypostable_type: string;
20
- shipping_label_url: null;
21
- ship_actual_cost: null;
22
- shipping_method_text: null;
23
- carrier: null;
24
- tracking: null;
25
- type: string;
26
- postage_billed: null;
27
- handling_billed: boolean;
28
- ship_3rdparty_cost: null;
29
- requires_label: boolean;
30
- completed_at: string;
31
- ship_actual_currency: null;
32
- delivered_at: string;
33
- due_at: string;
34
- reference: null;
35
- customer: {
36
- id: number;
37
- name: string;
38
- created_at: string;
39
- active: boolean;
40
- auto_merge_gestation: null;
41
- default_warehouse_id: number;
42
- eori_number: null;
43
- estimated_monthly_volume: null;
44
- fedex_account: null;
45
- from_email: null;
46
- instructions: null;
47
- item_scanning_preference: boolean;
48
- label_format: null;
49
- notes: null;
50
- notify_originator: boolean;
51
- notify_originator_inventory: number;
52
- originator_permissions: boolean;
53
- packing_slip_msg: null;
54
- packingslip_template: null;
55
- request_serial_numbers: boolean;
56
- ship_method_preference: number;
57
- shipping_name: string;
58
- ups_account: null;
59
- vat_number: null;
60
- ein: null;
61
- warehouse_fallback: number;
62
- payment_hold: boolean;
63
- account_level: number;
64
- account_level_name: null;
65
- whitelisted_warehouses: {
66
- id: number;
67
- name: string;
68
- timezone: string;
69
- shipping_address_1: string;
70
- shipping_address_2: string;
71
- shipping_city: string;
72
- shipping_state: string;
73
- shipping_zip: string;
74
- shipping_country: string;
75
- shipping_country_iso2: string;
76
- latitude: number;
77
- longitude: number;
78
- }[];
79
- activated_at: string;
80
- deactivated_at: null;
81
- auto_merge_skus: boolean;
82
- billing_email: string;
83
- billing_contact_name: string;
84
- billing_company: null;
85
- billing_phone1: null;
86
- billing_phone2: null;
87
- billing_address1: string;
88
- billing_address2: null;
89
- billing_address3: null;
90
- billing_city: string;
91
- billing_state: string;
92
- billing_zip: string;
93
- billing_country: string;
94
- billing_residential: null;
95
- items_returnable: boolean;
96
- allow_international_returns: boolean;
97
- items_exchangeable: boolean;
98
- return_time_limit: number;
99
- return_label_expires_in: number;
100
- return_price_restricted: boolean;
101
- return_sku_match: null;
102
- rma_display_logo: boolean;
103
- rma_footer_content: null;
104
- return_name: null;
105
- return_company: null;
106
- return_email: null;
107
- return_phone: null;
108
- return_address_1: null;
109
- return_address_2: null;
110
- return_city: null;
111
- return_state: null;
112
- return_zip: null;
113
- return_country: null;
114
- supports_return_labels: boolean;
115
- logo_content_type: null;
116
- logo_file_name: null;
117
- logo_file_size: null;
118
- logo_updated_at: null;
119
- full_logo_url: string;
120
- email_confirmation_from: string;
121
- email_confirmation_name: string;
122
- email_confirmation_msg: null;
123
- email_confirmation_preference: number;
124
- email_confirmation_template: null;
125
- low_inventory_threshold: null;
126
- lot_control: boolean;
127
- expiration_period: null;
128
- ship_strategy: number;
129
- items_unavailable_on_sellout: number;
130
- replenishment_min: null;
131
- replenishment_target: null;
132
- };
133
- warehouse: {
134
- id: number;
135
- name: string;
136
- timezone: string;
137
- shipping_address_1: string;
138
- shipping_address_2: string;
139
- shipping_city: string;
140
- shipping_state: string;
141
- shipping_zip: string;
142
- shipping_country: string;
143
- shipping_country_iso2: string;
144
- latitude: number;
145
- longitude: number;
146
- };
147
- originator: {
148
- id: number;
149
- originated_id: number;
150
- originated_type: string;
151
- shop_id: null;
152
- provider: string;
153
- original_id: null;
154
- group_id: null;
155
- misc: null;
156
- active: boolean;
157
- integration_id: null;
158
- last_notified_at: null;
159
- last_notification_status: null;
160
- distinct_originator_key: null;
161
- created_at: string;
162
- updated_at: string;
163
- application_id: null;
164
- };
165
- return_items: {
166
- id: number;
167
- item_id: number;
168
- name: string;
169
- sku: string;
170
- price: string;
171
- quantity: number;
172
- quantity_good: number;
173
- quantity_damaged: number;
174
- description: string;
175
- extended_description: null;
176
- return_action: string;
177
- order_item_id: number;
178
- return_item_originator_id: null;
179
- originator_id: null;
180
- lot_ids: never[];
181
- }[];
182
- exchange_order: {
183
- id: number;
184
- customer_id: number;
185
- order_batch_id: null;
186
- quote_id: null;
187
- warehouse_id: number;
188
- return_warehouse_id: number;
189
- shipping_method_id: null;
190
- estimated_shipping_method_id: null;
191
- humanize_id: string;
192
- status: number;
193
- status_name: string;
194
- previous_status: number;
195
- order_orig: string;
196
- level1_token: string;
197
- level2_token: string;
198
- workable_at: string;
199
- skip_street_date: boolean;
200
- due_at: string;
201
- created_at: string;
202
- updated_at: string;
203
- meta_data: null;
204
- customer_provided_label_carrier: null;
205
- purchase_order: null;
206
- email: string;
207
- address_verified: boolean;
208
- address_message: null;
209
- shop_warehouse_ids: never[];
210
- shop_shipping_method_currency: null;
211
- shop_created_at: null;
212
- shop_updated_at: null;
213
- shop_shipping_method_text: null;
214
- shop_shipping_method_price: string;
215
- billing_company: null;
216
- billing_address_1: null;
217
- billing_address_2: null;
218
- billing_address_3: null;
219
- billing_city: null;
220
- billing_state: null;
221
- billing_zip: null;
222
- billing_country: null;
223
- billing_phone: null;
224
- billed: boolean;
225
- billing_name: null;
226
- first_name: null;
227
- last_name: null;
228
- full_name: null;
229
- shipping_name: string;
230
- shipping_company: null;
231
- shipping_address_1: string;
232
- shipping_address_2: null;
233
- shipping_city: string;
234
- shipping_state: string;
235
- shipping_zip: string;
236
- shipping_country: string;
237
- shipping_country_iso2: string;
238
- shipping_phone: null;
239
- requested_address: string;
240
- residential: boolean;
241
- require_signature: boolean;
242
- require_adult_signature: boolean;
243
- saturday_delivery: boolean;
244
- gift: boolean;
245
- insure: boolean;
246
- contains_alcohol: boolean;
247
- ship_actual_cost: null;
248
- shipped_on: null;
249
- ship_notes: null;
250
- shipping_confirmation_sent: boolean;
251
- ship_3rdparty_cost: string;
252
- ship_3rdparty_account: null;
253
- ship_3rdparty_zip: null;
254
- ship_3rdparty_country: null;
255
- incoterm: null;
256
- public_note: null;
257
- days_in_transit: number;
258
- days_in_transit_carrier_estimate: null;
259
- req_insurance_value: null;
260
- ship_method: null;
261
- packingslip_pdf_url: null;
262
- tracking: never[];
263
- tracking_links: string[];
264
- approximate_delivery_date: null;
265
- return_name: null;
266
- return_company: null;
267
- return_address_1: null;
268
- return_address_2: null;
269
- return_city: null;
270
- return_state: null;
271
- return_country: null;
272
- return_zip: null;
273
- return_phone: null;
274
- return_email: null;
275
- return_address_verified: null;
276
- return_time_limit: null;
277
- order_items: {
278
- id: number;
279
- order_id: number;
280
- customer_id: number;
281
- item_id: number;
282
- package_id: number;
283
- quote_item_id: null;
284
- sku: string;
285
- description: string;
286
- quantity: number;
287
- price: string;
288
- created_at: string;
289
- updated_at: string;
290
- unshippable: boolean;
291
- available: boolean;
292
- packed: number;
293
- packaging: boolean;
294
- wholesale_cost: null;
295
- is_bundle: boolean;
296
- retail_fee: null;
297
- promo: boolean;
298
- returnable: null;
299
- currency: string;
300
- wholesale_fee: null;
301
- hazmat: boolean;
302
- misc: null;
303
- originator: {
304
- id: number;
305
- originated_id: number;
306
- originated_type: string;
307
- shop_id: null;
308
- provider: string;
309
- original_id: null;
310
- group_id: null;
311
- misc: null;
312
- active: boolean;
313
- integration_id: null;
314
- last_notified_at: null;
315
- last_notification_status: null;
316
- distinct_originator_key: null;
317
- created_at: string;
318
- updated_at: string;
319
- application_id: null;
320
- };
321
- }[];
322
- originator: {
323
- id: number;
324
- originated_id: number;
325
- originated_type: string;
326
- shop_id: null;
327
- provider: string;
328
- original_id: null;
329
- group_id: null;
330
- misc: null;
331
- active: boolean;
332
- integration_id: null;
333
- last_notified_at: null;
334
- last_notification_status: null;
335
- distinct_originator_key: null;
336
- created_at: string;
337
- updated_at: string;
338
- application_id: null;
339
- };
340
- proto_originator_id: null;
341
- packages: {
342
- id: number;
343
- order_id: number;
344
- shipped_on: null;
345
- ship_actual_cost: null;
346
- actual_weight: null;
347
- actual_width: null;
348
- actual_height: null;
349
- actual_length: null;
350
- actual_dimensional_weight: null;
351
- tracking: null;
352
- tracking_link: string;
353
- order_item_ids: number[];
354
- created_at: string;
355
- updated_at: string;
356
- ucc128: null;
357
- barcode_sscc18: string;
358
- ship_actual_currency: null;
359
- }[];
360
- shipping_method: null;
361
- serial_numbers: never[];
362
- };
363
- order: {
364
- id: number;
365
- customer_id: number;
366
- order_batch_id: null;
367
- quote_id: null;
368
- warehouse_id: number;
369
- return_warehouse_id: number;
370
- shipping_method_id: null;
371
- estimated_shipping_method_id: null;
372
- humanize_id: string;
373
- status: number;
374
- status_name: string;
375
- previous_status: number;
376
- order_orig: string;
377
- level1_token: string;
378
- level2_token: string;
379
- workable_at: string;
380
- skip_street_date: boolean;
381
- due_at: string;
382
- created_at: string;
383
- updated_at: string;
384
- meta_data: null;
385
- customer_provided_label_carrier: null;
386
- purchase_order: null;
387
- email: string;
388
- address_verified: boolean;
389
- address_message: null;
390
- shop_warehouse_ids: never[];
391
- shop_shipping_method_currency: null;
392
- shop_created_at: null;
393
- shop_updated_at: null;
394
- shop_shipping_method_text: null;
395
- shop_shipping_method_price: string;
396
- billing_company: null;
397
- billing_address_1: null;
398
- billing_address_2: null;
399
- billing_address_3: null;
400
- billing_city: null;
401
- billing_state: null;
402
- billing_zip: null;
403
- billing_country: null;
404
- billing_phone: null;
405
- billed: boolean;
406
- billing_name: null;
407
- first_name: null;
408
- last_name: null;
409
- full_name: null;
410
- shipping_name: string;
411
- shipping_company: null;
412
- shipping_address_1: string;
413
- shipping_address_2: null;
414
- shipping_city: string;
415
- shipping_state: string;
416
- shipping_zip: string;
417
- shipping_country: string;
418
- shipping_country_iso2: string;
419
- shipping_phone: null;
420
- requested_address: string;
421
- residential: boolean;
422
- require_signature: boolean;
423
- require_adult_signature: boolean;
424
- saturday_delivery: boolean;
425
- gift: boolean;
426
- insure: boolean;
427
- contains_alcohol: boolean;
428
- ship_actual_cost: null;
429
- shipped_on: null;
430
- ship_notes: null;
431
- shipping_confirmation_sent: boolean;
432
- ship_3rdparty_cost: string;
433
- ship_3rdparty_account: null;
434
- ship_3rdparty_zip: null;
435
- ship_3rdparty_country: null;
436
- incoterm: null;
437
- public_note: null;
438
- days_in_transit: number;
439
- days_in_transit_carrier_estimate: null;
440
- req_insurance_value: null;
441
- ship_method: null;
442
- packingslip_pdf_url: null;
443
- tracking: never[];
444
- tracking_links: string[];
445
- approximate_delivery_date: null;
446
- return_name: null;
447
- return_company: null;
448
- return_address_1: null;
449
- return_address_2: null;
450
- return_city: null;
451
- return_state: null;
452
- return_country: null;
453
- return_zip: null;
454
- return_phone: null;
455
- return_email: null;
456
- return_address_verified: null;
457
- return_time_limit: null;
458
- order_items: {
459
- id: number;
460
- order_id: number;
461
- customer_id: number;
462
- item_id: number;
463
- package_id: number;
464
- quote_item_id: null;
465
- sku: string;
466
- description: string;
467
- quantity: number;
468
- price: string;
469
- created_at: string;
470
- updated_at: string;
471
- unshippable: boolean;
472
- available: boolean;
473
- packed: number;
474
- packaging: boolean;
475
- wholesale_cost: null;
476
- is_bundle: boolean;
477
- retail_fee: null;
478
- promo: boolean;
479
- returnable: null;
480
- currency: string;
481
- wholesale_fee: null;
482
- hazmat: boolean;
483
- misc: null;
484
- originator: {
485
- id: number;
486
- originated_id: number;
487
- originated_type: string;
488
- shop_id: null;
489
- provider: string;
490
- original_id: null;
491
- group_id: null;
492
- misc: null;
493
- active: boolean;
494
- integration_id: null;
495
- last_notified_at: null;
496
- last_notification_status: null;
497
- distinct_originator_key: null;
498
- created_at: string;
499
- updated_at: string;
500
- application_id: null;
501
- };
502
- }[];
503
- originator: {
504
- id: number;
505
- originated_id: number;
506
- originated_type: string;
507
- shop_id: null;
508
- provider: string;
509
- original_id: null;
510
- group_id: null;
511
- misc: null;
512
- active: boolean;
513
- integration_id: null;
514
- last_notified_at: null;
515
- last_notification_status: null;
516
- distinct_originator_key: null;
517
- created_at: string;
518
- updated_at: string;
519
- application_id: null;
520
- };
521
- proto_originator_id: null;
522
- packages: {
523
- id: number;
524
- order_id: number;
525
- shipped_on: null;
526
- ship_actual_cost: null;
527
- actual_weight: null;
528
- actual_width: null;
529
- actual_height: null;
530
- actual_length: null;
531
- actual_dimensional_weight: null;
532
- tracking: null;
533
- tracking_link: string;
534
- order_item_ids: number[];
535
- created_at: string;
536
- updated_at: string;
537
- ucc128: null;
538
- barcode_sscc18: string;
539
- ship_actual_currency: null;
540
- }[];
541
- shipping_method: null;
542
- serial_numbers: never[];
543
- };
544
- } | {
545
- id: number;
546
- order_id: number;
547
- customer_id: number;
548
- warehouse_id: number;
549
- sender: string;
550
- eta: string;
551
- status: number;
552
- status_name: string;
553
- received_by: null;
554
- notes_by_whiplash: null;
555
- notes_by_customer: null;
556
- total_boxes: number;
557
- created_at: string;
558
- updated_at: string;
559
- arrived_at: null;
560
- skip_images: null;
561
- easypostable_id: null;
562
- easypostable_type: string;
563
- shipping_label_url: null;
564
- ship_actual_cost: null;
565
- shipping_method_text: null;
566
- carrier: null;
567
- tracking: null;
568
- type: string;
569
- postage_billed: null;
570
- handling_billed: null;
571
- ship_3rdparty_cost: null;
572
- requires_label: boolean;
573
- completed_at: null;
574
- ship_actual_currency: null;
575
- delivered_at: null;
576
- due_at: null;
577
- reference: null;
578
- customer: {
579
- id: number;
580
- name: string;
581
- created_at: string;
582
- active: boolean;
583
- auto_merge_gestation: null;
584
- default_warehouse_id: number;
585
- eori_number: null;
586
- estimated_monthly_volume: null;
587
- fedex_account: null;
588
- from_email: null;
589
- instructions: null;
590
- item_scanning_preference: boolean;
591
- label_format: null;
592
- notes: null;
593
- notify_originator: boolean;
594
- notify_originator_inventory: number;
595
- originator_permissions: boolean;
596
- packing_slip_msg: null;
597
- packingslip_template: null;
598
- request_serial_numbers: boolean;
599
- ship_method_preference: number;
600
- shipping_name: string;
601
- ups_account: null;
602
- vat_number: null;
603
- ein: null;
604
- warehouse_fallback: number;
605
- payment_hold: boolean;
606
- account_level: number;
607
- account_level_name: null;
608
- whitelisted_warehouses: {
609
- id: number;
610
- name: string;
611
- timezone: string;
612
- shipping_address_1: string;
613
- shipping_address_2: string;
614
- shipping_city: string;
615
- shipping_state: string;
616
- shipping_zip: string;
617
- shipping_country: string;
618
- shipping_country_iso2: string;
619
- latitude: number;
620
- longitude: number;
621
- }[];
622
- activated_at: string;
623
- deactivated_at: null;
624
- auto_merge_skus: boolean;
625
- billing_email: string;
626
- billing_contact_name: string;
627
- billing_company: null;
628
- billing_phone1: null;
629
- billing_phone2: null;
630
- billing_address1: string;
631
- billing_address2: null;
632
- billing_address3: null;
633
- billing_city: string;
634
- billing_state: string;
635
- billing_zip: string;
636
- billing_country: string;
637
- billing_residential: null;
638
- items_returnable: boolean;
639
- allow_international_returns: boolean;
640
- items_exchangeable: boolean;
641
- return_time_limit: number;
642
- return_label_expires_in: number;
643
- return_price_restricted: boolean;
644
- return_sku_match: null;
645
- rma_display_logo: boolean;
646
- rma_footer_content: null;
647
- return_name: null;
648
- return_company: null;
649
- return_email: null;
650
- return_phone: null;
651
- return_address_1: null;
652
- return_address_2: null;
653
- return_city: null;
654
- return_state: null;
655
- return_zip: null;
656
- return_country: null;
657
- supports_return_labels: boolean;
658
- logo_content_type: null;
659
- logo_file_name: null;
660
- logo_file_size: null;
661
- logo_updated_at: null;
662
- full_logo_url: string;
663
- email_confirmation_from: string;
664
- email_confirmation_name: string;
665
- email_confirmation_msg: null;
666
- email_confirmation_preference: number;
667
- email_confirmation_template: null;
668
- low_inventory_threshold: null;
669
- lot_control: boolean;
670
- expiration_period: null;
671
- ship_strategy: number;
672
- items_unavailable_on_sellout: number;
673
- replenishment_min: null;
674
- replenishment_target: null;
675
- };
676
- warehouse: {
677
- id: number;
678
- name: string;
679
- timezone: string;
680
- shipping_address_1: string;
681
- shipping_address_2: string;
682
- shipping_city: string;
683
- shipping_state: string;
684
- shipping_zip: string;
685
- shipping_country: string;
686
- shipping_country_iso2: string;
687
- latitude: number;
688
- longitude: number;
689
- };
690
- originator: {
691
- id: number;
692
- originated_id: number;
693
- originated_type: string;
694
- shop_id: null;
695
- provider: string;
696
- original_id: null;
697
- group_id: null;
698
- misc: null;
699
- active: boolean;
700
- integration_id: null;
701
- last_notified_at: null;
702
- last_notification_status: null;
703
- distinct_originator_key: null;
704
- created_at: string;
705
- updated_at: string;
706
- application_id: null;
707
- };
708
- return_items: {
709
- id: number;
710
- item_id: number;
711
- name: string;
712
- sku: string;
713
- price: string;
714
- quantity: number;
715
- quantity_good: number;
716
- quantity_damaged: number;
717
- description: string;
718
- extended_description: null;
719
- return_action: string;
720
- order_item_id: number;
721
- return_item_originator_id: null;
722
- originator_id: null;
723
- lot_ids: never[];
724
- }[];
725
- exchange_order: {
726
- id: number;
727
- customer_id: number;
728
- order_batch_id: null;
729
- quote_id: null;
730
- warehouse_id: number;
731
- return_warehouse_id: number;
732
- shipping_method_id: null;
733
- estimated_shipping_method_id: null;
734
- humanize_id: string;
735
- status: number;
736
- status_name: string;
737
- previous_status: number;
738
- order_orig: string;
739
- level1_token: string;
740
- level2_token: string;
741
- workable_at: string;
742
- skip_street_date: boolean;
743
- due_at: string;
744
- created_at: string;
745
- updated_at: string;
746
- meta_data: null;
747
- customer_provided_label_carrier: null;
748
- purchase_order: null;
749
- email: string;
750
- address_verified: boolean;
751
- address_message: null;
752
- shop_warehouse_ids: never[];
753
- shop_shipping_method_currency: null;
754
- shop_created_at: null;
755
- shop_updated_at: null;
756
- shop_shipping_method_text: null;
757
- shop_shipping_method_price: string;
758
- billing_company: null;
759
- billing_address_1: null;
760
- billing_address_2: null;
761
- billing_address_3: null;
762
- billing_city: null;
763
- billing_state: null;
764
- billing_zip: null;
765
- billing_country: null;
766
- billing_phone: null;
767
- billed: boolean;
768
- billing_name: null;
769
- first_name: null;
770
- last_name: null;
771
- full_name: null;
772
- shipping_name: string;
773
- shipping_company: null;
774
- shipping_address_1: string;
775
- shipping_address_2: null;
776
- shipping_city: string;
777
- shipping_state: string;
778
- shipping_zip: string;
779
- shipping_country: string;
780
- shipping_country_iso2: string;
781
- shipping_phone: null;
782
- requested_address: string;
783
- residential: boolean;
784
- require_signature: boolean;
785
- require_adult_signature: boolean;
786
- saturday_delivery: boolean;
787
- gift: boolean;
788
- insure: boolean;
789
- contains_alcohol: boolean;
790
- ship_actual_cost: null;
791
- shipped_on: null;
792
- ship_notes: null;
793
- shipping_confirmation_sent: boolean;
794
- ship_3rdparty_cost: string;
795
- ship_3rdparty_account: null;
796
- ship_3rdparty_zip: null;
797
- ship_3rdparty_country: null;
798
- incoterm: null;
799
- public_note: null;
800
- days_in_transit: number;
801
- days_in_transit_carrier_estimate: null;
802
- req_insurance_value: null;
803
- ship_method: null;
804
- packingslip_pdf_url: null;
805
- tracking: never[];
806
- tracking_links: string[];
807
- approximate_delivery_date: null;
808
- return_name: null;
809
- return_company: null;
810
- return_address_1: null;
811
- return_address_2: null;
812
- return_city: null;
813
- return_state: null;
814
- return_country: null;
815
- return_zip: null;
816
- return_phone: null;
817
- return_email: null;
818
- return_address_verified: null;
819
- return_time_limit: null;
820
- order_items: {
821
- id: number;
822
- order_id: number;
823
- customer_id: number;
824
- item_id: number;
825
- package_id: number;
826
- quote_item_id: null;
827
- sku: string;
828
- description: string;
829
- quantity: number;
830
- price: string;
831
- created_at: string;
832
- updated_at: string;
833
- unshippable: boolean;
834
- available: boolean;
835
- packed: number;
836
- packaging: boolean;
837
- wholesale_cost: null;
838
- is_bundle: boolean;
839
- retail_fee: null;
840
- promo: boolean;
841
- returnable: null;
842
- currency: string;
843
- wholesale_fee: null;
844
- hazmat: boolean;
845
- misc: null;
846
- originator: {
847
- id: number;
848
- originated_id: number;
849
- originated_type: string;
850
- shop_id: null;
851
- provider: string;
852
- original_id: null;
853
- group_id: null;
854
- misc: null;
855
- active: boolean;
856
- integration_id: null;
857
- last_notified_at: null;
858
- last_notification_status: null;
859
- distinct_originator_key: null;
860
- created_at: string;
861
- updated_at: string;
862
- application_id: null;
863
- };
864
- }[];
865
- originator: {
866
- id: number;
867
- originated_id: number;
868
- originated_type: string;
869
- shop_id: null;
870
- provider: string;
871
- original_id: null;
872
- group_id: null;
873
- misc: null;
874
- active: boolean;
875
- integration_id: null;
876
- last_notified_at: null;
877
- last_notification_status: null;
878
- distinct_originator_key: null;
879
- created_at: string;
880
- updated_at: string;
881
- application_id: null;
882
- };
883
- proto_originator_id: null;
884
- packages: {
885
- id: number;
886
- order_id: number;
887
- shipped_on: null;
888
- ship_actual_cost: null;
889
- actual_weight: null;
890
- actual_width: null;
891
- actual_height: null;
892
- actual_length: null;
893
- actual_dimensional_weight: null;
894
- tracking: null;
895
- tracking_link: string;
896
- order_item_ids: number[];
897
- created_at: string;
898
- updated_at: string;
899
- ucc128: null;
900
- barcode_sscc18: string;
901
- ship_actual_currency: null;
902
- }[];
903
- shipping_method: null;
904
- serial_numbers: never[];
905
- };
906
- order: {
907
- id: number;
908
- customer_id: number;
909
- order_batch_id: null;
910
- quote_id: null;
911
- warehouse_id: number;
912
- return_warehouse_id: number;
913
- shipping_method_id: null;
914
- estimated_shipping_method_id: null;
915
- humanize_id: string;
916
- status: number;
917
- status_name: string;
918
- previous_status: number;
919
- order_orig: string;
920
- level1_token: string;
921
- level2_token: string;
922
- workable_at: string;
923
- skip_street_date: boolean;
924
- due_at: string;
925
- created_at: string;
926
- updated_at: string;
927
- meta_data: null;
928
- customer_provided_label_carrier: null;
929
- purchase_order: null;
930
- email: string;
931
- address_verified: boolean;
932
- address_message: null;
933
- shop_warehouse_ids: never[];
934
- shop_shipping_method_currency: null;
935
- shop_created_at: null;
936
- shop_updated_at: null;
937
- shop_shipping_method_text: null;
938
- shop_shipping_method_price: string;
939
- billing_company: null;
940
- billing_address_1: null;
941
- billing_address_2: null;
942
- billing_address_3: null;
943
- billing_city: null;
944
- billing_state: null;
945
- billing_zip: null;
946
- billing_country: null;
947
- billing_phone: null;
948
- billed: boolean;
949
- billing_name: null;
950
- first_name: null;
951
- last_name: null;
952
- full_name: null;
953
- shipping_name: string;
954
- shipping_company: null;
955
- shipping_address_1: string;
956
- shipping_address_2: null;
957
- shipping_city: string;
958
- shipping_state: string;
959
- shipping_zip: string;
960
- shipping_country: string;
961
- shipping_country_iso2: string;
962
- shipping_phone: null;
963
- requested_address: string;
964
- residential: boolean;
965
- require_signature: boolean;
966
- require_adult_signature: boolean;
967
- saturday_delivery: boolean;
968
- gift: boolean;
969
- insure: boolean;
970
- contains_alcohol: boolean;
971
- ship_actual_cost: null;
972
- shipped_on: null;
973
- ship_notes: null;
974
- shipping_confirmation_sent: boolean;
975
- ship_3rdparty_cost: string;
976
- ship_3rdparty_account: null;
977
- ship_3rdparty_zip: null;
978
- ship_3rdparty_country: null;
979
- incoterm: null;
980
- public_note: null;
981
- days_in_transit: number;
982
- days_in_transit_carrier_estimate: null;
983
- req_insurance_value: null;
984
- ship_method: null;
985
- packingslip_pdf_url: null;
986
- tracking: never[];
987
- tracking_links: string[];
988
- approximate_delivery_date: null;
989
- return_name: null;
990
- return_company: null;
991
- return_address_1: null;
992
- return_address_2: null;
993
- return_city: null;
994
- return_state: null;
995
- return_country: null;
996
- return_zip: null;
997
- return_phone: null;
998
- return_email: null;
999
- return_address_verified: null;
1000
- return_time_limit: null;
1001
- order_items: {
1002
- id: number;
1003
- order_id: number;
1004
- customer_id: number;
1005
- item_id: number;
1006
- package_id: number;
1007
- quote_item_id: null;
1008
- sku: string;
1009
- description: string;
1010
- quantity: number;
1011
- price: string;
1012
- created_at: string;
1013
- updated_at: string;
1014
- unshippable: boolean;
1015
- available: boolean;
1016
- packed: number;
1017
- packaging: boolean;
1018
- wholesale_cost: null;
1019
- is_bundle: boolean;
1020
- retail_fee: null;
1021
- promo: boolean;
1022
- returnable: null;
1023
- currency: string;
1024
- wholesale_fee: null;
1025
- hazmat: boolean;
1026
- misc: null;
1027
- originator: {
1028
- id: number;
1029
- originated_id: number;
1030
- originated_type: string;
1031
- shop_id: null;
1032
- provider: string;
1033
- original_id: null;
1034
- group_id: null;
1035
- misc: null;
1036
- active: boolean;
1037
- integration_id: null;
1038
- last_notified_at: null;
1039
- last_notification_status: null;
1040
- distinct_originator_key: null;
1041
- created_at: string;
1042
- updated_at: string;
1043
- application_id: null;
1044
- };
1045
- }[];
1046
- originator: {
1047
- id: number;
1048
- originated_id: number;
1049
- originated_type: string;
1050
- shop_id: null;
1051
- provider: string;
1052
- original_id: null;
1053
- group_id: null;
1054
- misc: null;
1055
- active: boolean;
1056
- integration_id: null;
1057
- last_notified_at: null;
1058
- last_notification_status: null;
1059
- distinct_originator_key: null;
1060
- created_at: string;
1061
- updated_at: string;
1062
- application_id: null;
1063
- };
1064
- proto_originator_id: null;
1065
- packages: {
1066
- id: number;
1067
- order_id: number;
1068
- shipped_on: null;
1069
- ship_actual_cost: null;
1070
- actual_weight: null;
1071
- actual_width: null;
1072
- actual_height: null;
1073
- actual_length: null;
1074
- actual_dimensional_weight: null;
1075
- tracking: null;
1076
- tracking_link: string;
1077
- order_item_ids: number[];
1078
- created_at: string;
1079
- updated_at: string;
1080
- ucc128: null;
1081
- barcode_sscc18: string;
1082
- ship_actual_currency: null;
1083
- }[];
1084
- shipping_method: null;
1085
- serial_numbers: never[];
1086
- };
1087
- })[];
1
+ export declare const ApiV21ConsumerReturnAllExample: never[];