-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
3043 lines (3039 loc) · 117 KB
/
openapi.yaml
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Goody API
description: >-
Goody is a new way to send personal and business gifts as easily as a text
message.
Our business gifting platform, Goody for Business, powers employee
engagement, client appreciation, and sales prospecting gifts at more than
12,000 leading companies. Goody integrates with 30 leading HR platforms,
allowing companies to automatically gift employees on birthdays and work
anniversaries.
Choose from a curated gift collection of 250+ brands. Send a gift with only
an email or phone number — no address required. Let gift recipients swap
your gift for equal or lower-priced options, with no pricing shown.
version: 1.0.0
contact:
name: Goody Support
email: support@ongoody.com
servers:
- description: Production
url: https://api.ongoody.com
- description: Sandbox
url: https://api.sandbox.ongoody.com
tags:
- name: Order Batches
- name: Orders
- name: Webhooks
- name: Me
- name: Payment Methods
- name: Products
- name: Workspaces
paths:
/v1/me:
get:
tags:
- Me
summary: Retrieve current user
operationId: Me_getCurrentUser
security:
- bearer: []
responses:
'200':
description: Me retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Me'
'401':
description: Failed to authorize
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v1/order_batches:
post:
tags:
- Order Batches
summary: Create an order batch
operationId: OrderBatches_createBatch
security:
- bearer: []
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderBatchInput'
examples:
Order batch created:
summary: Order batch created
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: bc82ba2f-c143-48e8-b2be-22fc34ee183f
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_id: de31187b-b9aa-4187-81ac-0d6c8a323c10
quantity: 1
Scheduled order batch created:
summary: Scheduled order batch created
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: 0346f7af-340b-469f-826a-12496c4ece2c
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_id: 4633f5ee-a080-4b41-b482-b9496ebf1833
quantity: 1
scheduled_send_on: '2023-07-20T21:50:33Z'
expires_at: '2023-08-10T21:50:33Z'
Order batch created with recipient address:
summary: Order batch created with recipient address
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: 3a23d47a-d606-4317-a4a8-8ea8be904205
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
mailing_address:
first_name: Alena
last_name: Kenter
address_1: 1 Main St
address_2: Apt 123
city: New York
state: NY
postal_code: '10022'
country: US
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
mailing_address:
first_name: Michael
last_name: Franci
address_1: 1 Main St
address_2: Apt 124
city: New York
state: NY
postal_code: '10022'
country: US
cart:
items:
- product_id: 07e2c9f7-28b8-43eb-8827-72d49d507e6c
quantity: 1
Order batch created using product URL in cart:
summary: Order batch created using product URL in cart
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: e080f854-8fd7-4523-b5ac-8a381031ae4d
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_url: >-
http://example.com/browse/brands/cookie-company/cookies
quantity: 1
expires_at: '2023-08-10T21:50:34Z'
Bad request:
summary: Bad request
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: b1faebbd-8482-4f90-9892-b25b6bbb9370
recipients: []
cart:
items:
- product_id: 3069c348-08c0-49b7-a2f7-cef5c3732485
quantity: 1
Bad request when using invalid product URL in cart:
summary: Bad request when using invalid product URL in cart
value:
from_name: John
message: Thank you!
send_method: link_multiple_custom_list
payment_method_id: null
workspace_id: null
card_id: 69c58b24-0273-4068-a8d9-cb63a7841ef2
recipients:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
items:
- product_url: >-
https://www.ongoody.com/browse/brands/invalid-brand/invalid-product
quantity: 1
scheduled_send_on: '2023-07-20T21:50:34Z'
expires_at: '2023-08-10T21:50:34Z'
responses:
'201':
description: Order batch created using product URL in cart
content:
application/json:
examples:
Order batch created (10 or fewer recipients):
value:
id: 5020fbee-a5dc-45d9-8114-155bccdf22e6
send_status: complete
from_name: John
message: Thank you!
orders_count: 2
orders_preview:
- id: f9afd3e0-4bf8-45a0-b8ff-2956740845d9
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/kkmTY4JyoYs7KgaLxd7rBaqM
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: bc82ba2f-c143-48e8-b2be-22fc34ee183f
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 5020fbee-a5dc-45d9-8114-155bccdf22e6
expires_at: null
cart:
id: bd87405f-d01e-450f-97d1-ed2a12d4c095
items:
- id: 963ffae2-94ba-444f-8c15-b13d9c3c4fc1
quantity: 1
product:
id: de31187b-b9aa-4187-81ac-0d6c8a323c10
name: Cookies
brand:
id: 7109b496-308a-4ac6-9274-f3c27d368af3
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15557285854@test.ongoody.com
workspace_id: 86a027de-2d2a-4aa2-a9e0-8714d1339c00
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: UFL9TUBEPLAJYYVJZOSH1YH4
- id: e2d608c6-cf4a-40ad-af32-6e30b2cdc347
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/RsH9NdSrzuVtLVNxjaew6CfO
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: bc82ba2f-c143-48e8-b2be-22fc34ee183f
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 5020fbee-a5dc-45d9-8114-155bccdf22e6
expires_at: null
cart:
id: bd87405f-d01e-450f-97d1-ed2a12d4c095X
items:
- id: 963ffae2-94ba-444f-8c15-b13d9c3c4fc1X
quantity: 1
product:
id: de31187b-b9aa-4187-81ac-0d6c8a323c10X
name: Cookies
brand:
id: 7109b496-308a-4ac6-9274-f3c27d368af3X
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15557285854@test.ongoody.com
workspace_id: 86a027de-2d2a-4aa2-a9e0-8714d1339c00
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: ZMAUHA0OZF1U9WEKPJ8ISZSG
recipients_count: 2
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: bd87405f-d01e-450f-97d1-ed2a12d4c095X
items:
- id: 963ffae2-94ba-444f-8c15-b13d9c3c4fc1X
quantity: 1
product:
id: de31187b-b9aa-4187-81ac-0d6c8a323c10X
name: Cookies
brand:
id: 7109b496-308a-4ac6-9274-f3c27d368af3X
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: bc82ba2f-c143-48e8-b2be-22fc34ee183f
sender:
first_name: Test
last_name: User
email: 15557285854@test.ongoody.com
workspace_id: 86a027de-2d2a-4aa2-a9e0-8714d1339c00
workspace_name: Test Team
reference_id: FAQAQCVFFRBCXSQIAVABPXWR
Order batch created (more than 10 recipients):
value:
id: 59b13ea3-e08f-4e5d-aa26-45ae505957fc
send_status: pending
from_name: John
message: Thank you!
orders_count: 0
orders_preview: []
recipients_count: 11
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: ceecbddb-fdca-413d-9c12-2bfc8eb301f2
items:
- id: 0a753de0-4a0c-41be-b6c2-4afba7a5ca1b
quantity: 1
product:
id: ea3e9769-eea2-4aa2-bece-8a32e26386b9
name: Cookies
brand:
id: 99e6c1cb-6b48-45e6-b695-2d5498230286
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: link_multiple_custom_list
batch_name: 11 recipients
card_id: 7e8d1f0b-d9e0-4663-8ae9-c2fc38d4fb0d
sender:
first_name: Test
last_name: User
email: 15554156359@test.ongoody.com
workspace_id: 45e1ef6e-6ba0-4b81-8c2e-155a81f1b365
workspace_name: Test Team
reference_id: 3S2SNBKTKN7SJDQWE88PHJ1A
Scheduled order batch created:
value:
id: 8516d9ee-968b-4ed6-a254-379e68732c62
send_status: pending
from_name: John
message: Thank you!
orders_count: 0
orders_preview: []
recipients_count: 2
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: f5f1a7ea-325e-470f-a085-9b6e54907c8e
items:
- id: 53e4915c-788d-4105-98c4-17f37b1f5724
quantity: 1
product:
id: 4633f5ee-a080-4b41-b482-b9496ebf1833
name: Cookies
brand:
id: 0410e2be-6359-4940-af15-5ee84805ec11
name: Cookie Company
is_scheduled_send: true
scheduled_send_on: '2023-07-20T21:50:33Z'
expires_at: '2023-08-10T21:50:33Z'
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: 0346f7af-340b-469f-826a-12496c4ece2c
sender:
first_name: Test
last_name: User
email: 15558391444@test.ongoody.com
workspace_id: 5e3072af-ce47-4152-87f6-388cecb6fa90
workspace_name: Test Team
reference_id: 1NJ8TOA7O5CKDELTKIGR4RRV
Order batch created with recipient address:
value:
id: 91e4804b-8f6f-4f38-afd5-b471ad7f7849
send_status: complete
from_name: John
message: Thank you!
orders_count: 2
orders_preview:
- id: 5300f2c0-04ed-4b35-8e51-beb814e5737c
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/Jm5Ss9lzUkjZnImBalLlcTu3
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: 3a23d47a-d606-4317-a4a8-8ea8be904205
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 91e4804b-8f6f-4f38-afd5-b471ad7f7849
expires_at: null
cart:
id: 65b3a129-f7ec-4048-a1bb-574c7e020b23
items:
- id: 3a11e0e8-d5c8-472f-9120-4e9d540eae06
quantity: 1
product:
id: 07e2c9f7-28b8-43eb-8827-72d49d507e6c
name: Cookies
brand:
id: b9d31cdd-3a88-4c7d-91b6-8d13cbd70b44
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15557699347@test.ongoody.com
workspace_id: 7dfffb26-b34e-4c70-a5ed-cbc4a84a28de
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: DNRURLZYRYDPEUYZXRXJMMFH
- id: 174beb23-ad17-4455-8525-e07129dccc9d
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/alTiXF5X4KRQzt1SGDMqrrxy
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: 3a23d47a-d606-4317-a4a8-8ea8be904205
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 91e4804b-8f6f-4f38-afd5-b471ad7f7849
expires_at: null
cart:
id: 65b3a129-f7ec-4048-a1bb-574c7e020b23X
items:
- id: 3a11e0e8-d5c8-472f-9120-4e9d540eae06X
quantity: 1
product:
id: 07e2c9f7-28b8-43eb-8827-72d49d507e6cX
name: Cookies
brand:
id: b9d31cdd-3a88-4c7d-91b6-8d13cbd70b44X
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15557699347@test.ongoody.com
workspace_id: 7dfffb26-b34e-4c70-a5ed-cbc4a84a28de
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: 0LBFVLB2V9S2KUQKUNBERDDS
recipients_count: 2
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: 65b3a129-f7ec-4048-a1bb-574c7e020b23X
items:
- id: 3a11e0e8-d5c8-472f-9120-4e9d540eae06X
quantity: 1
product:
id: 07e2c9f7-28b8-43eb-8827-72d49d507e6cX
name: Cookies
brand:
id: b9d31cdd-3a88-4c7d-91b6-8d13cbd70b44X
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: 3a23d47a-d606-4317-a4a8-8ea8be904205
sender:
first_name: Test
last_name: User
email: 15557699347@test.ongoody.com
workspace_id: 7dfffb26-b34e-4c70-a5ed-cbc4a84a28de
workspace_name: Test Team
reference_id: OKSZ8OJQ9ZPZDFXNG6JMAR9W
Order batch created (using product URL in cart):
value:
id: 040bf69d-2a2f-4eef-9365-a82788091e50
send_status: complete
from_name: John
message: Thank you!
orders_count: 2
orders_preview:
- id: 1d18374e-99a5-46a4-ac9a-2c28f6ee17d0
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/CFA2TU7QNeVgUgozNx00D5YQ
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: e080f854-8fd7-4523-b5ac-8a381031ae4d
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 040bf69d-2a2f-4eef-9365-a82788091e50
expires_at: '2023-08-10T21:50:34Z'
cart:
id: 3c594ba8-199a-476c-954f-b8eefe9a0b09
items:
- id: f930c2ae-b070-4d5f-ad4f-ef001971b601
quantity: 1
product:
id: 6d622295-1f44-4b8f-b788-bcbcd73b24ff
name: Cookies
brand:
id: 5c162bec-7df5-4013-a6a3-02dbfaa95392
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15555164350@test.ongoody.com
workspace_id: 17bde50f-cef1-4a42-ba4c-b1c3b413bf58
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: 6A5KGQ0KPQGOUX57C2KUQF0Q
- id: 82eb8825-34d5-4d3b-a682-26e2e781cebf
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/ZBD7op8PFrEC59nZsXjPELUF
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: e080f854-8fd7-4523-b5ac-8a381031ae4d
message: Thank you!
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 040bf69d-2a2f-4eef-9365-a82788091e50
expires_at: '2023-08-10T21:50:34Z'
cart:
id: 3c594ba8-199a-476c-954f-b8eefe9a0b09X
items:
- id: f930c2ae-b070-4d5f-ad4f-ef001971b601X
quantity: 1
product:
id: 6d622295-1f44-4b8f-b788-bcbcd73b24ffX
name: Cookies
brand:
id: 5c162bec-7df5-4013-a6a3-02dbfaa95392X
name: Cookie Company
shipments: []
amounts:
amount_product: 1000
amount_shipping: 1000
amount_processing_fee: 100
amount_pre_tax_total: 2100
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15555164350@test.ongoody.com
workspace_id: 17bde50f-cef1-4a42-ba4c-b1c3b413bf58
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: 1C7DPYGDYYUE5IQOFYXT9NZ2
recipients_count: 2
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: 3c594ba8-199a-476c-954f-b8eefe9a0b09X
items:
- id: f930c2ae-b070-4d5f-ad4f-ef001971b601X
quantity: 1
product:
id: 6d622295-1f44-4b8f-b788-bcbcd73b24ffX
name: Cookies
brand:
id: 5c162bec-7df5-4013-a6a3-02dbfaa95392X
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: '2023-08-10T21:50:34Z'
send_method: link_multiple_custom_list
batch_name: Alena Kenter and Michael Franci
card_id: e080f854-8fd7-4523-b5ac-8a381031ae4d
sender:
first_name: Test
last_name: User
email: 15555164350@test.ongoody.com
workspace_id: 17bde50f-cef1-4a42-ba4c-b1c3b413bf58
workspace_name: Test Team
reference_id: WBRN7MAB7LNPILVFLYAOOZNC
schema:
$ref: '#/components/schemas/OrderBatch'
'400':
description: Bad request when using invalid product URL in cart
content:
application/json:
examples:
Order batch without recipients fails to create:
value:
error: Recipients can't be blank
schema:
$ref: '#/components/schemas/Error'
get:
tags:
- Order Batches
summary: List order batches
operationId: OrderBatches_list
security:
- bearer: []
parameters:
- description: Page for pagination, starting at 1
name: page
in: query
schema:
type: integer
default: 1
minimum: 1
required: false
- description: Items per page for pagination
name: per_page
in: query
schema:
type: integer
default: 20
minimum: 1
maximum: 100
required: false
responses:
'200':
description: Order batches retrieved
content:
application/json:
examples:
Order batches retrieved:
value:
data:
- id: 684efbcf-105a-4018-b1c6-b7aa24b47e53
send_status: complete
from_name: Carlee
message: null
orders_count: 2
orders_preview:
- id: f6ceb426-4d03-438e-b0d9-1063e22982fd
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/XO7BKKHMGOQFJ0B0RYDCPZCI
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: 5e543979-4c97-4769-a93b-cd85fddacd93
message: Test Message
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 684efbcf-105a-4018-b1c6-b7aa24b47e53
expires_at: null
cart:
id: 1a40cbb9-4f6f-415d-a040-811db42c4edd
items:
- id: e70f24a2-323e-48f3-8c3f-d8be69f0fe38
quantity: 1
product:
id: 8496cb2f-304a-4822-9e20-9d9b0db24d6e
name: Cookies
brand:
id: 1fa68b66-e3eb-4f79-a775-5570a30c62d1
name: Cookie Company
shipments: []
amounts:
amount_product: 2000
amount_shipping: 500
amount_processing_fee: 0
amount_pre_tax_total: 2500
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15551766249@test.ongoody.com
workspace_id: 872a44e1-2ea6-4d44-8a02-62e4bca041f7
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: AWU6DOLO0JOV2WT0TVFIVDLY
- id: 518d338b-64a0-49e8-a235-4b853ef3668f
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/EOEC0JRXBBHUCKFSHKUQBFAE
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: 5e543979-4c97-4769-a93b-cd85fddacd93
message: Test Message
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: 684efbcf-105a-4018-b1c6-b7aa24b47e53
expires_at: null
cart:
id: 1a40cbb9-4f6f-415d-a040-811db42c4eddX
items:
- id: e70f24a2-323e-48f3-8c3f-d8be69f0fe38X
quantity: 1
product:
id: 8496cb2f-304a-4822-9e20-9d9b0db24d6eX
name: Cookies
brand:
id: 1fa68b66-e3eb-4f79-a775-5570a30c62d1X
name: Cookie Company
shipments: []
amounts:
amount_product: 2000
amount_shipping: 500
amount_processing_fee: 0
amount_pre_tax_total: 2500
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15551766249@test.ongoody.com
workspace_id: 872a44e1-2ea6-4d44-8a02-62e4bca041f7
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: OOWOL8COFAMN2AMHJZSHCMPA
recipients_count: 2
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: 1a40cbb9-4f6f-415d-a040-811db42c4eddX
items:
- id: e70f24a2-323e-48f3-8c3f-d8be69f0fe38X
quantity: 1
product:
id: 8496cb2f-304a-4822-9e20-9d9b0db24d6eX
name: Cookies
brand:
id: 1fa68b66-e3eb-4f79-a775-5570a30c62d1X
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: null
batch_name: Thank You from Greenholt, Heidenreich and Lubowitz
card_id: 5e543979-4c97-4769-a93b-cd85fddacd93
sender:
first_name: Test
last_name: User
email: 15551766249@test.ongoody.com
workspace_id: 872a44e1-2ea6-4d44-8a02-62e4bca041f7
workspace_name: Test Team
reference_id: SXKSP7TFRPG507W2HWUPRIBE
- id: cc2c3bd6-2edb-457c-bb47-aaa924f3dbf1
send_status: complete
from_name: Micah
message: null
orders_count: 2
orders_preview:
- id: 607da8c9-51a5-4375-804a-72a9c7d47234
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/RPGZMCCYCYNFS0QIWLMUFY87
recipient_first_name: Alena
recipient_last_name: Kenter
recipient_email: alena@ongoody.com
card_id: 7a03c12d-479b-47e8-a98d-3200b58848b4
message: Test Message
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: cc2c3bd6-2edb-457c-bb47-aaa924f3dbf1
expires_at: null
cart:
id: 00216423-6ecf-43fa-ab40-92b67ea49df2
items:
- id: bb9d3592-7ad4-4d10-af97-e14307fa1888
quantity: 1
product:
id: d2089d35-ae4b-4d00-92ed-18d07d869abf
name: Cookies
brand:
id: 78531fb7-3842-4a28-8495-daf174b5c7fb
name: Cookie Company
shipments: []
amounts:
amount_product: 2000
amount_shipping: 500
amount_processing_fee: 0
amount_pre_tax_total: 2500
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15557803909@test.ongoody.com
workspace_id: 872a44e1-2ea6-4d44-8a02-62e4bca041f7
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: YJNR4BMPZ4AIRDYXOHEA1IQR
- id: adeff9fb-92ed-48ca-8a7c-68ac703b14e4
status: created
individual_gift_link: >-
https://gifts.ongoody.com/gift/ZD5RHZK6M5MHV6SKPZXS18AB
recipient_first_name: Michael
recipient_last_name: Franci
recipient_email: michael@ongoody.com
card_id: 7a03c12d-479b-47e8-a98d-3200b58848b4
message: Test Message
thank_you_note: null
view_count_recipient: 0
is_swapped: false
order_batch_id: cc2c3bd6-2edb-457c-bb47-aaa924f3dbf1
expires_at: null
cart:
id: 00216423-6ecf-43fa-ab40-92b67ea49df2X
items:
- id: bb9d3592-7ad4-4d10-af97-e14307fa1888X
quantity: 1
product:
id: d2089d35-ae4b-4d00-92ed-18d07d869abfX
name: Cookies
brand:
id: 78531fb7-3842-4a28-8495-daf174b5c7fbX
name: Cookie Company
shipments: []
amounts:
amount_product: 2000
amount_shipping: 500
amount_processing_fee: 0
amount_pre_tax_total: 2500
amount_tax: null
amount_total: null
amount_global_relay_cost: null
sender:
first_name: Test
last_name: User
email: 15557803909@test.ongoody.com
workspace_id: 872a44e1-2ea6-4d44-8a02-62e4bca041f7
workspace_name: Test Team
original_cart: null
original_amounts: null
reference_id: WTQMNF4DC0XRPTW8CIWBHOVP
recipients_count: 2
recipients_preview:
- first_name: Alena
last_name: Kenter
email: alena@ongoody.com
- first_name: Michael
last_name: Franci
email: michael@ongoody.com
cart:
id: 00216423-6ecf-43fa-ab40-92b67ea49df2X
items:
- id: bb9d3592-7ad4-4d10-af97-e14307fa1888X
quantity: 1
product:
id: d2089d35-ae4b-4d00-92ed-18d07d869abfX
name: Cookies
brand:
id: 78531fb7-3842-4a28-8495-daf174b5c7fbX
name: Cookie Company
is_scheduled_send: false
scheduled_send_on: null
expires_at: null
send_method: null
batch_name: Thank You from Baumbach, Treutel and Hand
card_id: 7a03c12d-479b-47e8-a98d-3200b58848b4
sender:
first_name: Test
last_name: User
email: 15557803909@test.ongoody.com
workspace_id: 872a44e1-2ea6-4d44-8a02-62e4bca041f7
workspace_name: Test Team
reference_id: HX6LDJ4Q9T3CP91CMBCXH5P7
list_meta:
total_count: 2
schema:
$ref: '#/components/schemas/OrderBatchesListResponse'
/v1/order_batches/{id}/orders:
get:
tags: