-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
6146 lines (6133 loc) · 183 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.0
info:
title: Foodkit API
description: >-
Foodkit is an end-to-end white-label restaurant platform, and API -
Including iOS and Android e-commerce apps, websites and kiosks, enterprise
customer service and CRM, delivery logistics optimization, omnichannel
marketing and loyalty programs, POS integration and more.
One powerful platform, complete flexibility, less cost - so you can focus on
growing your brand, instead of worrying about backend technology and code.
We believe in building exceptional technology, empowering restaurants and
removing the expense of building and maintaining complicated technology
infrastructure.
WHY FOODKIT?
✔ We power the world's best restaurant brands from the cloud
✔ We provide a best-in-class platform and open API
✔ We eliminate the complexity and high costs associated with developing and
maintaining a digital restaurant business
✔ We offer outstanding customer service 24/7
Contact us at:
✎ https://www.foodkit.io/
version: '6.0'
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- url: https://dev.foodkit.io/api
tags:
- name: Customers
- name: Branches
- name: Menu
- name: Orders
- name: Branch List
- name: Publications
- name: Marketing
- name: Loyalty Punch Card
- name: Brands
- name: Referrals
paths:
/v1/storefront/customers:
post:
tags:
- Customers
summary: Register customer
operationId: Customers_registerCustomer
description: ''
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersRegisterCustomerRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersRegisterCustomerResponse'
/v1/storefront/customers/me:
patch:
tags:
- Customers
summary: Update customer
operationId: Customers_updateDetails
description: Update the current customer's details (based on the access token).
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersUpdateDetailsRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersUpdateDetailsResponse'
get:
tags:
- Customers
summary: Get current customer
operationId: Customers_getDetails
description: Retrieve the customer details for the current access token context.
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersGetDetailsResponse'
/v2/storefront/customers/me/addresses:
get:
tags:
- Customers
summary: Get customer addresses
operationId: Customers_getAddresses
description: List the stored addresses for the current customer context.
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersGetAddressesResponse'
/v3/storefront/brands:
get:
tags:
- Brands
summary: Get brand
operationId: Brands_getBrandContext
description: Displays the current "brand" context.
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BrandsGetBrandContextResponse'
/v3/storefront/customers/me/orders:
get:
tags:
- Customers
summary: Get customer orders
operationId: Customers_getCustomerOrders
description: ''
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersGetCustomerOrdersResponse'
/v3/storefront/vendors/{vendor}/promotions:
get:
tags:
- Marketing
summary: Get promotions
operationId: Marketing_getPromotions
description: ''
parameters:
- description: ''
in: path
name: vendor
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MarketingGetPromotionsResponse'
/v4/storefront/customers/brands/{brand}/customers/{customer}/orders/{id}/track:
get:
tags:
- Orders
summary: Track order
operationId: Orders_trackStatus
description: >-
Track the status of an order. This endpoint will provide the current
status of an order, as well as timestamps for each status transition
(e.g: time when the order is dispatched from the restaurant). This
endpoint will also report the latest driver position (latitude and
longitude) if available.
parameters:
- description: ''
in: path
name: brand
schema:
type: integer
example: 2043
required: true
- description: ''
in: path
name: customer
schema:
type: integer
example: 332091
required: true
- description: ''
in: path
name: id
schema:
type: integer
example: 1021011
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OrdersTrackStatusResponse'
/v4/storefront/customers/brands/{brand}/customers/{customer}/tax-ids:
get:
tags:
- Customers
summary: Get customer tax IDs
operationId: Customers_getTaxIds
description: ''
parameters:
- description: ''
in: path
name: brand
schema:
type: integer
required: true
- description: ''
in: path
name: customer
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersGetTaxIdsResponse'
post:
tags:
- Customers
summary: Store customer tax ID
operationId: Customers_storeTaxId
description: ''
parameters:
- description: ''
in: path
name: brand
schema:
type: integer
required: true
- description: ''
in: path
name: customer
schema:
type: integer
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersStoreTaxIdRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersStoreTaxIdResponse'
/v5/storefront/content/tenants/{tenant}/branch-list:
get:
tags:
- Branch List
summary: Branch list content
operationId: BranchList_content
description: (See 'Timestamped branch list link')
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 101
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchListContentResponse'
/v5/storefront/content/tenants/{tenant}/branch-list/timestamp:
get:
tags:
- Branch List
summary: Timestamped branch list link
operationId: BranchList_getTimestampedLink
description: >-
Use this endpoint to retrieve the complete list of branches (AKA
locations or outlets) for a tenant. This endpoint will not return the
data directly, but instead will provide a URL to the most up-to-date
version of the branch list and the timestamp since the last update (Unix
time). To optimise performance (and prevent rate limiting) you should
fetch the provided branch list and cache in your application along with
the timestamp. You can then check this endpoint periodically and only
refresh the branch list locally if the timestamp has changed since your
last check.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 522
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchListGetTimestampedLinkResponse'
/v5/storefront/content/tenants/{tenant}/menu:
get:
tags:
- Menu
summary: Menu content
operationId: Menu_getTenantMenu
description: (See 'Timestamped menu link')
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MenuGetTenantMenuResponse'
/v5/storefront/content/tenants/{tenant}/menu/timestamp:
get:
tags:
- Menu
summary: Timestamped menu link
operationId: Menu_getTimestampedLink
description: >-
Use this endpoint to retrieve the complete menu for a tenant. This
endpoint will not return the menu directly, rather it will provide a URL
to the most up-to-date version of the menu and the timestamp since the
last update. To optimise performance (and prevent API rate limiting)
you should fetch the provided URL (via a GET request, no authorization
required) to retrieve the menu and cache it in your application along
with the timestamp. You can then call this endpoint periodically and
only refresh the locally cached menu if the timestamp has changed since
your last check.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MenuGetTimestampedLinkResponse'
/v5/storefront/content/tenants/{tenant}/publications-cached:
get:
tags:
- Publications
summary: Get publications
operationId: Publications_getCachedPublications
description: (See 'Get publications timestamp')
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicationsGetCachedPublicationsResponse'
/v5/storefront/content/tenants/{tenant}/publications/timestamp:
get:
tags:
- Publications
summary: Get publications timestamp
operationId: Publications_getTenantPublicationsTimestamp
description: >-
Use this endpoint to retrieve all publications for a tenant.
"Publications" include any content that should be publicly visible
through your customer facing channels (e.g: websites and/or
applications). Restaurants can use publications to advertise offers,
promotions, or to make announcements. Note that data is not returned
directly. Rather this endpoint provides a URL to the latest list of
publications and an associated "last update" timestamp. To optimise
performance (and prevent rate limiting) you should cache the
publications list locally and check the timestamp periodically. If the
timestamp changes you should invalidate your local cache and fetch the
list again from the provided `url` using a standard GET request.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/PublicationsGetTenantPublicationsTimestampResponse
/v5/storefront/customers/tenants/{tenant}/customers/{customer}/contact-form:
post:
tags:
- Branches
summary: Submit contact form
operationId: Branches_submitContactForm
description: >-
Submit a support request (via email) to the designated support email
address for the tenant.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 92
required: true
- description: ''
in: path
name: customer
schema:
type: integer
example: 981
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesSubmitContactFormRequest'
responses:
'202':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesSubmitContactFormResponse'
/v5/storefront/inventory/brands/{brand}/branches/{branch}/upsells:
post:
tags:
- Marketing
summary: Upsell recommendations
operationId: Marketing_createUpsellRecommendations
description: ''
parameters:
- description: ''
in: path
name: brand
schema:
type: integer
example: 801
required: true
- description: ''
in: path
name: branch
schema:
type: integer
example: 984
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MarketingCreateUpsellRecommendationsRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/MarketingCreateUpsellRecommendationsResponse
/v5/storefront/tenants/{tenant}/branch-capabilities:
get:
tags:
- Branches
summary: Branch capabilities (by tenant)
operationId: Branches_listBranchCapabilities
description: >-
Get a list of branches and the order types which each branch supports
(e.g pickup orders, delivery orders...)
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 432
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesListBranchCapabilitiesResponse'
/v5/storefront/tenants/{tenant}/branch-closures:
get:
tags:
- Branches
summary: Branch closures (by tenant)
operationId: Branches_getClosures
description: >-
Retrieve a list of branches that are currently closed for the related
tenant ID. For multi-brand licenses (e.g marketplaces) this endpoint
will return branch closures for all brands.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 432
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesGetClosuresResponse'
/v5/storefront/tenants/{tenant}/brands/{brand}/branch-capabilities:
get:
tags:
- Branches
summary: Branch capabilities (by brand)
operationId: Branches_getBranchCapabilities
description: >-
Get a list of branches and the order types which each branch supports
(e.g pickup orders, delivery orders...)
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 92
required: true
- description: ''
in: path
name: brand
schema:
type: integer
example: 981
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesGetBranchCapabilitiesResponse'
/v5/storefront/tenants/{tenant}/brands/{brand}/branch-closures:
get:
tags:
- Branches
summary: Branch closures (by brand)
operationId: Branches_getClosedBranches
description: >-
Retrieve a list of restaurant branches that are currently closed for the
related brand ID. For single brand licenses this will return the same as
the "Branch closures (by tenant)" endpoint.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 92
required: true
- description: ''
in: path
name: brand
schema:
type: integer
example: 981
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesGetClosedBranchesResponse'
/v5/storefront/tenants/{tenant}/brands/{brand}/branches/{branch}/inventory-closures:
get:
tags:
- Menu
summary: Inventory closures
operationId: Menu_getBranchInventoryClosures
description: >-
List hidden or out-of-stock inventory items for a specific restaurant
branch. You should check the availability before presenting a menu to a
user so you can mark products as unavailable or out-of-stock.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
- description: ''
in: path
name: brand
schema:
type: integer
required: true
- description: ''
in: path
name: branch
schema:
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MenuGetBranchInventoryClosuresResponse'
/v5/storefront/tenants/{tenant}/brands/{brand}/deliverable-branches:
get:
tags:
- Branches
summary: Deliverable branches (by brand)
operationId: Branches_findDeliverableBranches
description: >-
Get a list of branches that are capable of delivering to a specific
delivery address (latitude and longitude) based on configured delivery
zones.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
- description: ''
in: path
name: brand
schema:
type: integer
required: true
- description: Latitude of the delivery address
in: query
name: latitude
schema:
type: number
required: true
- description: Longitude of the delivery address
in: query
name: longitude
schema:
type: number
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesFindDeliverableBranchesResponse'
/v5/storefront/tenants/{tenant}/deliverable-branches:
get:
tags:
- Branches
summary: Deliverable branches (by tenant)
operationId: Branches_listDeliverableBranches
description: >-
Get a list of branches that are capable of delivering to a specific
delivery address (latitude and longitude) based on configured delivery
zones. For delivery orders we recommend you to call this endpoint once
you know the guest's location but before they start adding items to the
shopping cart, so you can warn them if delivery is not available to
their location and suggest an alternative (e.g: create a pickup order
instead).
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
- description: Latitude of the delivery address
in: query
name: latitude
schema:
type: number
required: true
- description: Longitude of the delivery address
in: query
name: longitude
schema:
type: number
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BranchesListDeliverableBranchesResponse'
/v5/storefront/tenants/{tenant}/orders:
post:
tags:
- Orders
summary: Store an order
operationId: Orders_createOrder
description: ''
parameters:
- description: ''
in: path
name: tenant
schema:
type: string
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrdersCreateOrderRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OrdersCreateOrderResponse'
/v5/storefront/tenants/{tenant}/quotes:
post:
tags:
- Orders
summary: Retrieve a quotation
operationId: Orders_getQuotation
description: ''
parameters:
- description: ''
in: path
name: tenant
schema:
type: string
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrdersGetQuotationRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OrdersGetQuotationResponse'
/v5/storefront/tenants/{tenant}/service-area-email:
post:
tags:
- Customers
summary: Opt-in for service area change email
operationId: Customers_optInServiceAreaEmail
description: >-
Allows an out-of-service-area customer to register interest in being
notified when the service area for the restaurant is expanded to include
their specified address.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersOptInServiceAreaEmailRequest'
responses:
'202':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersOptInServiceAreaEmailResponse'
/v6/storefront/customers/tenants/{tenant}/customers/gdpr-preferences:
post:
tags:
- Customers
summary: Store customer's GDPR preferences
operationId: Customers_storeGdprPreferences
description: >-
Stores a customer's GDPR opt-in preferences for conversion analysis can
be called with either a `guest` or `customer` scoped access token.
parameters:
- description: Tenant ID for the account.
in: path
name: tenant
schema:
type: integer
example: 9801
required: true
- description: ID of the associated customer.
in: path
name: customer
schema:
type: integer
example: 22104
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersStoreGdprPreferencesRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersStoreGdprPreferencesResponse'
/v6/storefront/customers/tenants/{tenant}/customers/{customer}/intercom-hmacs:
post:
tags:
- Customers
summary: Generate Intercom HMAC
operationId: Customers_generateIntercomHmac
description: >-
Create a HMAC signature for an authenticated user for use in an Intercom
chat session.
parameters:
- description: Tenant ID for the account.
in: path
name: tenant
schema:
type: integer
example: 9801
required: true
- description: ID of the associated customer.
in: path
name: customer
schema:
type: integer
example: 22104
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersGenerateIntercomHmacRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersGenerateIntercomHmacResponse'
/v6/storefront/loyalty/tenants/{tenant}/customers/{customer}/punch-card:
get:
tags:
- Loyalty Punch Card
summary: Get punchcard for customer
operationId: LoyaltyPunchCard_getPunchcard
description: >-
Only valid when loyalty program is enabled for your account. Retrieve
the current state of the member's loyalty program, along with the
associated punchcard.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 999
required: true
- description: ''
in: path
name: customer
schema:
type: integer
example: 10001
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LoyaltyPunchCardGetPunchcardResponse'
/v6/storefront/loyalty/tenants/{tenant}/punch-card:
get:
tags:
- Loyalty Punch Card
summary: Get punchcard for guest
operationId: LoyaltyPunchCard_getDetails
description: >-
Use this endpoint to retrieve the punchcard details before the customer
has registered/logged-in.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 999
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LoyaltyPunchCardGetDetailsResponse'
/v6/storefront/referrals/tenants/{tenant}/customers/{customer}:
get:
tags:
- Referrals
summary: Get referral codes for customer
operationId: Referrals_getReferralCodesForCustomer
description: >-
Only valid when referral program is enabled for your account. Retrieves
the referral coupon for a customer and any earned rewards (from other
guests who have used the customer's referral code).
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
example: 999
required: true
- description: ''
in: path
name: customer
schema:
type: integer
example: 10001
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/ReferralsGetReferralCodesForCustomerResponse
/v6/storefront/tenants/{tenant}/delivery-zones:
get:
tags:
- Branches
summary: Delivery zones
operationId: Branches_listDeliveryZones
description: >-
List the available delivery zones (and associated branches) for a given
latitude and longitude pair.
parameters:
- description: ''
in: path
name: tenant
schema:
type: integer
required: true
- description: Latitude of the delivery address
in: query