@poweredbysous/storefront-all-sdk 3.0.0 → 3.2.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.
- package/dist/index.d.cts +1899 -116
- package/dist/index.d.ts +1899 -116
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -365,6 +365,38 @@ interface paths {
|
|
|
365
365
|
patch: operations["admin_discounts_partial_update"];
|
|
366
366
|
trace?: never;
|
|
367
367
|
};
|
|
368
|
+
"/api/v1/admin/locations/delivery-methods/": {
|
|
369
|
+
parameters: {
|
|
370
|
+
query?: never;
|
|
371
|
+
header?: never;
|
|
372
|
+
path?: never;
|
|
373
|
+
cookie?: never;
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* Summarise delivery-method state for several Locations
|
|
377
|
+
* @description ``GET /api/v1/admin/locations/delivery-methods/?pair=<store>:<location>``.
|
|
378
|
+
*
|
|
379
|
+
* Read-only, many-location counterpart of ``StoreDeliveryMethodListView``
|
|
380
|
+
* for the Portal's Locations list: each method's on/off state and
|
|
381
|
+
* ``disabled_at`` per (store, location) pair, without the retained config.
|
|
382
|
+
* The caller names the pairs (it already knows each Location's Vendors), so
|
|
383
|
+
* this never infers membership from ``LocationStoreLink``, which may not be
|
|
384
|
+
* populated yet for a store — see ``_location_linked_to_store``.
|
|
385
|
+
*
|
|
386
|
+
* Same visibility rules as the single-location list: methods the company
|
|
387
|
+
* hasn't made available are omitted, and a pair whose store belongs to
|
|
388
|
+
* another company is silently dropped rather than reported, so it can't be
|
|
389
|
+
* used to probe for other companies' ids.
|
|
390
|
+
*/
|
|
391
|
+
get: operations["admin_locations_delivery_methods_list"];
|
|
392
|
+
put?: never;
|
|
393
|
+
post?: never;
|
|
394
|
+
delete?: never;
|
|
395
|
+
options?: never;
|
|
396
|
+
head?: never;
|
|
397
|
+
patch?: never;
|
|
398
|
+
trace?: never;
|
|
399
|
+
};
|
|
368
400
|
"/api/v1/admin/pages/": {
|
|
369
401
|
parameters: {
|
|
370
402
|
query?: never;
|
|
@@ -883,6 +915,50 @@ interface paths {
|
|
|
883
915
|
patch?: never;
|
|
884
916
|
trace?: never;
|
|
885
917
|
};
|
|
918
|
+
"/api/v1/admin/stores/{store_public_id}/base-coverage/": {
|
|
919
|
+
parameters: {
|
|
920
|
+
query?: never;
|
|
921
|
+
header?: never;
|
|
922
|
+
path?: never;
|
|
923
|
+
cookie?: never;
|
|
924
|
+
};
|
|
925
|
+
/**
|
|
926
|
+
* @description The rule this location's drawn areas are added to.
|
|
927
|
+
*
|
|
928
|
+
* Reuses ``_DrawnShapeViewSet`` for store resolution, the row lock and the
|
|
929
|
+
* shared-provider 409 — the parts that are dangerous and identical — but
|
|
930
|
+
* exposes a single object rather than a collection, because a location has
|
|
931
|
+
* one base coverage, not a list of them.
|
|
932
|
+
*
|
|
933
|
+
* ``mode`` is derived on read rather than stored. The modes are a *reading*
|
|
934
|
+
* of the rules already on the row, so a stored discriminator could disagree
|
|
935
|
+
* with the rules that actually decide coverage, and the rules would win. See
|
|
936
|
+
* ``base_coverage.mode_of``, and the module docstring there for why the
|
|
937
|
+
* portal is allowed to write a field the sync serializer also lists.
|
|
938
|
+
*/
|
|
939
|
+
get: operations["admin_stores_base_coverage_retrieve"];
|
|
940
|
+
/**
|
|
941
|
+
* @description The rule this location's drawn areas are added to.
|
|
942
|
+
*
|
|
943
|
+
* Reuses ``_DrawnShapeViewSet`` for store resolution, the row lock and the
|
|
944
|
+
* shared-provider 409 — the parts that are dangerous and identical — but
|
|
945
|
+
* exposes a single object rather than a collection, because a location has
|
|
946
|
+
* one base coverage, not a list of them.
|
|
947
|
+
*
|
|
948
|
+
* ``mode`` is derived on read rather than stored. The modes are a *reading*
|
|
949
|
+
* of the rules already on the row, so a stored discriminator could disagree
|
|
950
|
+
* with the rules that actually decide coverage, and the rules would win. See
|
|
951
|
+
* ``base_coverage.mode_of``, and the module docstring there for why the
|
|
952
|
+
* portal is allowed to write a field the sync serializer also lists.
|
|
953
|
+
*/
|
|
954
|
+
put: operations["admin_stores_base_coverage_update"];
|
|
955
|
+
post?: never;
|
|
956
|
+
delete?: never;
|
|
957
|
+
options?: never;
|
|
958
|
+
head?: never;
|
|
959
|
+
patch?: never;
|
|
960
|
+
trace?: never;
|
|
961
|
+
};
|
|
886
962
|
"/api/v1/admin/stores/{store_public_id}/compliance-defaults/": {
|
|
887
963
|
parameters: {
|
|
888
964
|
query?: never;
|
|
@@ -944,6 +1020,144 @@ interface paths {
|
|
|
944
1020
|
patch?: never;
|
|
945
1021
|
trace?: never;
|
|
946
1022
|
};
|
|
1023
|
+
"/api/v1/admin/stores/{store_public_id}/delivery-areas/": {
|
|
1024
|
+
parameters: {
|
|
1025
|
+
query?: never;
|
|
1026
|
+
header?: never;
|
|
1027
|
+
path?: never;
|
|
1028
|
+
cookie?: never;
|
|
1029
|
+
};
|
|
1030
|
+
/** @description List the shapes of this kind stored for the location. */
|
|
1031
|
+
get: operations["admin_stores_delivery_areas_list"];
|
|
1032
|
+
put?: never;
|
|
1033
|
+
/** @description Add one shape, leaving every other entry untouched. */
|
|
1034
|
+
post: operations["admin_stores_delivery_areas_create"];
|
|
1035
|
+
delete?: never;
|
|
1036
|
+
options?: never;
|
|
1037
|
+
head?: never;
|
|
1038
|
+
patch?: never;
|
|
1039
|
+
trace?: never;
|
|
1040
|
+
};
|
|
1041
|
+
"/api/v1/admin/stores/{store_public_id}/delivery-areas/{shape_id}/": {
|
|
1042
|
+
parameters: {
|
|
1043
|
+
query?: never;
|
|
1044
|
+
header?: never;
|
|
1045
|
+
path?: never;
|
|
1046
|
+
cookie?: never;
|
|
1047
|
+
};
|
|
1048
|
+
get?: never;
|
|
1049
|
+
put?: never;
|
|
1050
|
+
post?: never;
|
|
1051
|
+
/** @description Remove one shape, leaving the rest of the coverage intact. */
|
|
1052
|
+
delete: operations["admin_stores_delivery_areas_destroy"];
|
|
1053
|
+
options?: never;
|
|
1054
|
+
head?: never;
|
|
1055
|
+
/** @description Reshape or rename one shape, leaving the others untouched. */
|
|
1056
|
+
patch: operations["admin_stores_delivery_areas_partial_update"];
|
|
1057
|
+
trace?: never;
|
|
1058
|
+
};
|
|
1059
|
+
"/api/v1/admin/stores/{store_public_id}/delivery-exclusions/": {
|
|
1060
|
+
parameters: {
|
|
1061
|
+
query?: never;
|
|
1062
|
+
header?: never;
|
|
1063
|
+
path?: never;
|
|
1064
|
+
cookie?: never;
|
|
1065
|
+
};
|
|
1066
|
+
/** @description List the shapes of this kind stored for the location. */
|
|
1067
|
+
get: operations["admin_stores_delivery_exclusions_list"];
|
|
1068
|
+
put?: never;
|
|
1069
|
+
/** @description Add one shape, leaving every other entry untouched. */
|
|
1070
|
+
post: operations["admin_stores_delivery_exclusions_create"];
|
|
1071
|
+
delete?: never;
|
|
1072
|
+
options?: never;
|
|
1073
|
+
head?: never;
|
|
1074
|
+
patch?: never;
|
|
1075
|
+
trace?: never;
|
|
1076
|
+
};
|
|
1077
|
+
"/api/v1/admin/stores/{store_public_id}/delivery-exclusions/{shape_id}/": {
|
|
1078
|
+
parameters: {
|
|
1079
|
+
query?: never;
|
|
1080
|
+
header?: never;
|
|
1081
|
+
path?: never;
|
|
1082
|
+
cookie?: never;
|
|
1083
|
+
};
|
|
1084
|
+
get?: never;
|
|
1085
|
+
put?: never;
|
|
1086
|
+
post?: never;
|
|
1087
|
+
/** @description Remove one shape, leaving the rest of the coverage intact. */
|
|
1088
|
+
delete: operations["admin_stores_delivery_exclusions_destroy"];
|
|
1089
|
+
options?: never;
|
|
1090
|
+
head?: never;
|
|
1091
|
+
/** @description Reshape or rename one shape, leaving the others untouched. */
|
|
1092
|
+
patch: operations["admin_stores_delivery_exclusions_partial_update"];
|
|
1093
|
+
trace?: never;
|
|
1094
|
+
};
|
|
1095
|
+
"/api/v1/admin/stores/{store_public_id}/delivery-fee/": {
|
|
1096
|
+
parameters: {
|
|
1097
|
+
query?: never;
|
|
1098
|
+
header?: never;
|
|
1099
|
+
path?: never;
|
|
1100
|
+
cookie?: never;
|
|
1101
|
+
};
|
|
1102
|
+
/**
|
|
1103
|
+
* @description What a customer is charged for this location's own delivery.
|
|
1104
|
+
*
|
|
1105
|
+
* A singleton on the same resolution/lock/409 base as the shapes. The
|
|
1106
|
+
* portal may write these for the reason ``base_coverage.py`` gives for the
|
|
1107
|
+
* radius: they are in the sync serializer's field list, but the only thing
|
|
1108
|
+
* that ever sends them is the hand-run ``set_store_delivery_method``
|
|
1109
|
+
* command — the ops task this feature replaces — so there is no routine
|
|
1110
|
+
* second writer.
|
|
1111
|
+
*/
|
|
1112
|
+
get: operations["admin_stores_delivery_fee_retrieve"];
|
|
1113
|
+
/**
|
|
1114
|
+
* @description What a customer is charged for this location's own delivery.
|
|
1115
|
+
*
|
|
1116
|
+
* A singleton on the same resolution/lock/409 base as the shapes. The
|
|
1117
|
+
* portal may write these for the reason ``base_coverage.py`` gives for the
|
|
1118
|
+
* radius: they are in the sync serializer's field list, but the only thing
|
|
1119
|
+
* that ever sends them is the hand-run ``set_store_delivery_method``
|
|
1120
|
+
* command — the ops task this feature replaces — so there is no routine
|
|
1121
|
+
* second writer.
|
|
1122
|
+
*/
|
|
1123
|
+
put: operations["admin_stores_delivery_fee_update"];
|
|
1124
|
+
post?: never;
|
|
1125
|
+
delete?: never;
|
|
1126
|
+
options?: never;
|
|
1127
|
+
head?: never;
|
|
1128
|
+
patch?: never;
|
|
1129
|
+
trace?: never;
|
|
1130
|
+
};
|
|
1131
|
+
"/api/v1/admin/stores/{store_public_id}/delivery-fee-split/": {
|
|
1132
|
+
parameters: {
|
|
1133
|
+
query?: never;
|
|
1134
|
+
header?: never;
|
|
1135
|
+
path?: never;
|
|
1136
|
+
cookie?: never;
|
|
1137
|
+
};
|
|
1138
|
+
/**
|
|
1139
|
+
* Get a store's delivery-fee split
|
|
1140
|
+
* @description The merchant portal has to show the current split before it can
|
|
1141
|
+
* offer to change it.
|
|
1142
|
+
*/
|
|
1143
|
+
get: operations["admin_stores_delivery_fee_split_retrieve"];
|
|
1144
|
+
put?: never;
|
|
1145
|
+
post?: never;
|
|
1146
|
+
delete?: never;
|
|
1147
|
+
options?: never;
|
|
1148
|
+
head?: never;
|
|
1149
|
+
/**
|
|
1150
|
+
* Set a store's delivery-fee split
|
|
1151
|
+
* @description Read/write a store's merchant/customer delivery-fee split.
|
|
1152
|
+
*
|
|
1153
|
+
* Auth and company scoping mirror ``AdminStoreComplianceDefaultsView``:
|
|
1154
|
+
* Firebase merchant auth, store resolved via ``resolve_active_company`` +
|
|
1155
|
+
* ``public_id`` so a merchant can only ever reach their own company's
|
|
1156
|
+
* store, never another company's.
|
|
1157
|
+
*/
|
|
1158
|
+
patch: operations["admin_stores_delivery_fee_split_partial_update"];
|
|
1159
|
+
trace?: never;
|
|
1160
|
+
};
|
|
947
1161
|
"/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
|
|
948
1162
|
parameters: {
|
|
949
1163
|
query?: never;
|
|
@@ -2034,6 +2248,31 @@ interface paths {
|
|
|
2034
2248
|
patch?: never;
|
|
2035
2249
|
trace?: never;
|
|
2036
2250
|
};
|
|
2251
|
+
"/api/v1/checkout/{checkout_id}/marketing-consent/": {
|
|
2252
|
+
parameters: {
|
|
2253
|
+
query?: never;
|
|
2254
|
+
header?: never;
|
|
2255
|
+
path?: never;
|
|
2256
|
+
cookie?: never;
|
|
2257
|
+
};
|
|
2258
|
+
get?: never;
|
|
2259
|
+
put?: never;
|
|
2260
|
+
post?: never;
|
|
2261
|
+
delete?: never;
|
|
2262
|
+
options?: never;
|
|
2263
|
+
head?: never;
|
|
2264
|
+
/**
|
|
2265
|
+
* @description PATCH /api/v1/checkout/{id}/marketing-consent/ — the customer's opt-in
|
|
2266
|
+
* for special offers and updates.
|
|
2267
|
+
*
|
|
2268
|
+
* Kept off the delivery PATCH deliberately: consent is an independent choice
|
|
2269
|
+
* the customer can toggle at any point in the flow, and folding it into
|
|
2270
|
+
* ``set_delivery`` would force a ``DELIVERY_SET`` transition on a write that
|
|
2271
|
+
* changes no totals. Store-scoped like every other checkout mutation.
|
|
2272
|
+
*/
|
|
2273
|
+
patch: operations["checkout_marketing_consent_partial_update"];
|
|
2274
|
+
trace?: never;
|
|
2275
|
+
};
|
|
2037
2276
|
"/api/v1/checkout/{checkout_id}/packaging-choice/": {
|
|
2038
2277
|
parameters: {
|
|
2039
2278
|
query?: never;
|
|
@@ -6420,6 +6659,21 @@ interface components {
|
|
|
6420
6659
|
*/
|
|
6421
6660
|
reusable_deposit_id?: number | null;
|
|
6422
6661
|
};
|
|
6662
|
+
/**
|
|
6663
|
+
* @description Read/write view of a store's merchant/customer delivery-fee split.
|
|
6664
|
+
*
|
|
6665
|
+
* ``delivery_fee_customer_pct`` is the fraction (0-1) of the shipping cost
|
|
6666
|
+
* the customer pays; the merchant absorbs the remainder — see
|
|
6667
|
+
* ``core.fees.apply_pass_through``. DRF derives 0-1 bounds validation from
|
|
6668
|
+
* the model field's own validators.
|
|
6669
|
+
*/
|
|
6670
|
+
AdminStoreDeliveryFeeSplit: {
|
|
6671
|
+
/**
|
|
6672
|
+
* Format: decimal
|
|
6673
|
+
* @description Fraction of shipping cost the customer pays (0-1). Merchant absorbs the remainder.
|
|
6674
|
+
*/
|
|
6675
|
+
delivery_fee_customer_pct?: string;
|
|
6676
|
+
};
|
|
6423
6677
|
/**
|
|
6424
6678
|
* @description Per-store fulfilment capability for the merchant offers UI.
|
|
6425
6679
|
*
|
|
@@ -6513,6 +6767,23 @@ interface components {
|
|
|
6513
6767
|
masked_code: string;
|
|
6514
6768
|
requires_security_code: boolean;
|
|
6515
6769
|
};
|
|
6770
|
+
/**
|
|
6771
|
+
* @description The rule a location's drawn areas are added to.
|
|
6772
|
+
*
|
|
6773
|
+
* ``mode`` is derived from the rules on read (see ``base_coverage.mode_of``)
|
|
6774
|
+
* and drives which of the other fields matters on write — the client sends
|
|
6775
|
+
* the whole shape and the server decides what to keep, so a merchant who
|
|
6776
|
+
* switches from Radius to Postcodes does not leave a stale radius behind
|
|
6777
|
+
* still granting coverage.
|
|
6778
|
+
*/
|
|
6779
|
+
BaseCoverage: {
|
|
6780
|
+
mode: components["schemas"]["ModeEnum"];
|
|
6781
|
+
/** Format: decimal */
|
|
6782
|
+
radius_km?: string | null;
|
|
6783
|
+
postcodes?: string[];
|
|
6784
|
+
readonly drawn_area_count: number;
|
|
6785
|
+
readonly origin: components["schemas"]["_Origin"] | null;
|
|
6786
|
+
};
|
|
6516
6787
|
/**
|
|
6517
6788
|
* @description * `free` - Free
|
|
6518
6789
|
* * `percentage` - Percentage Off
|
|
@@ -6855,24 +7126,10 @@ interface components {
|
|
|
6855
7126
|
/**
|
|
6856
7127
|
* @description How many products this category shows, descendants included.
|
|
6857
7128
|
*
|
|
6858
|
-
* Counted through the compliance gate (D15), because the count and the
|
|
6859
|
-
* listing are one read model: ``/categories/`` reported 5 while
|
|
6860
|
-
* ``/categories/<id>/products/`` returned 0, which discloses how many
|
|
6861
|
-
* hidden products sit in each category and, by diffing, which categories
|
|
6862
|
-
* are affected. Search's ``total`` had already closed the same gap.
|
|
6863
|
-
*
|
|
6864
|
-
* No ``annotated_product_count`` shortcut any more: a ``Count()`` in the
|
|
6865
|
-
* view cannot know the verdict, so such an annotation would be an ungated
|
|
6866
|
-
* number that silently won over this one.
|
|
6867
|
-
*
|
|
6868
7129
|
* The listing precomputes every category's count in one pass
|
|
6869
|
-
* (``views.
|
|
6870
|
-
*
|
|
6871
|
-
*
|
|
6872
|
-
* bounds the depth but not the breadth, and breadth is what drives it.
|
|
6873
|
-
*
|
|
6874
|
-
* The fallback below is the single-object path (retrieve), where there is
|
|
6875
|
-
* no tree to amortise over and one gate call is the whole cost.
|
|
7130
|
+
* (``views._build_product_counts``) and passes it in context; the
|
|
7131
|
+
* fallback below is the single-object path (retrieve), which counts its
|
|
7132
|
+
* own subtree directly.
|
|
6876
7133
|
*/
|
|
6877
7134
|
readonly product_count: number;
|
|
6878
7135
|
};
|
|
@@ -7210,6 +7467,72 @@ interface components {
|
|
|
7210
7467
|
/** @default */
|
|
7211
7468
|
description: string;
|
|
7212
7469
|
};
|
|
7470
|
+
/**
|
|
7471
|
+
* @description * `before_close` - A notice before the day closes
|
|
7472
|
+
* * `by_day` - A time set for each day
|
|
7473
|
+
* @enum {string}
|
|
7474
|
+
*/
|
|
7475
|
+
CutoffModeEnum: "before_close" | "by_day";
|
|
7476
|
+
/**
|
|
7477
|
+
* @description One area a merchant drew on a map.
|
|
7478
|
+
*
|
|
7479
|
+
* ``id`` is read-only: it is minted server-side so that a client cannot
|
|
7480
|
+
* address — or overwrite — an area it does not own, the same discipline the
|
|
7481
|
+
* store id gets on every other company-scoped admin endpoint.
|
|
7482
|
+
*/
|
|
7483
|
+
DeliveryArea: {
|
|
7484
|
+
readonly id: string;
|
|
7485
|
+
/** @description What the merchant calls this area, e.g. 'North of the canal'. */
|
|
7486
|
+
name?: string;
|
|
7487
|
+
/** @description A GeoJSON Polygon with a single closed ring, [longitude, latitude], WGS84. A point on the boundary counts as inside. */
|
|
7488
|
+
polygon: unknown;
|
|
7489
|
+
};
|
|
7490
|
+
/**
|
|
7491
|
+
* @description One pocket a merchant cut out of their coverage.
|
|
7492
|
+
*
|
|
7493
|
+
* A separate serializer rather than a flag on :class:`DeliveryAreaSerializer`
|
|
7494
|
+
* because the wire key is what makes a pocket safe: a reader that predates
|
|
7495
|
+
* exclusions must not be able to mistake one for coverage. See the
|
|
7496
|
+
* ``delivery_areas`` module docstring and workspace ADR 0014.
|
|
7497
|
+
*/
|
|
7498
|
+
DeliveryExclusion: {
|
|
7499
|
+
readonly id: string;
|
|
7500
|
+
/** @description What the merchant calls this pocket, e.g. 'Canal island'. */
|
|
7501
|
+
name?: string;
|
|
7502
|
+
/** @description A GeoJSON Polygon with a single closed ring, [longitude, latitude], WGS84. Addresses inside it are never delivered to, whatever the location's other coverage rules say. A point on the boundary counts as excluded. */
|
|
7503
|
+
excluded_polygon: unknown;
|
|
7504
|
+
};
|
|
7505
|
+
/**
|
|
7506
|
+
* @description What a customer is charged for this location's own delivery.
|
|
7507
|
+
*
|
|
7508
|
+
* Two numbers, not the customer/restaurant *split* the design also shows.
|
|
7509
|
+
* That division has no field anywhere yet — merchant-portal-backend's
|
|
7510
|
+
* ``delivery_fee_fixed`` is the platform's charge *to* the restaurant, a
|
|
7511
|
+
* finance setting, not the same thing — and it is what PAT-2186 decides.
|
|
7512
|
+
* Until then this exposes the total and the free-delivery threshold, which
|
|
7513
|
+
* the storefront already reads on every rate.
|
|
7514
|
+
*/
|
|
7515
|
+
DeliveryFee: {
|
|
7516
|
+
/** Format: decimal */
|
|
7517
|
+
base_delivery_fee: string;
|
|
7518
|
+
/** Format: decimal */
|
|
7519
|
+
free_delivery_threshold?: string | null;
|
|
7520
|
+
};
|
|
7521
|
+
/** @description One method's on/off state at one store+location — the summary's leaf. */
|
|
7522
|
+
DeliveryMethodState: {
|
|
7523
|
+
method: components["schemas"]["MethodEnum"];
|
|
7524
|
+
is_enabled: boolean;
|
|
7525
|
+
/** Format: date-time */
|
|
7526
|
+
disabled_at: string | null;
|
|
7527
|
+
};
|
|
7528
|
+
/**
|
|
7529
|
+
* @description What merchant-portal-backend's publish needs to know about a store
|
|
7530
|
+
* whose delivery methods the portal's toggles own.
|
|
7531
|
+
*/
|
|
7532
|
+
DeliveryMethodToggles: {
|
|
7533
|
+
wizard_choice_applies: components["schemas"]["WizardChoiceApplies"];
|
|
7534
|
+
publish_readiness: string[];
|
|
7535
|
+
};
|
|
7213
7536
|
/**
|
|
7214
7537
|
* @description Merchant-facing CRUD serializer for :class:`Discount`.
|
|
7215
7538
|
*
|
|
@@ -7415,6 +7738,17 @@ interface components {
|
|
|
7415
7738
|
* @enum {string}
|
|
7416
7739
|
*/
|
|
7417
7740
|
FulfillmentTypeEnum: "nationwide_delivery" | "local_delivery" | "pickup" | "room_service";
|
|
7741
|
+
/**
|
|
7742
|
+
* @description What publish provisioned (``fulfillment.services
|
|
7743
|
+
* .StoreFulfilmentProvisionResult``).
|
|
7744
|
+
*/
|
|
7745
|
+
FulfilmentProvisioning: {
|
|
7746
|
+
pickup_enabled: boolean;
|
|
7747
|
+
uber_direct_enabled: boolean;
|
|
7748
|
+
uber_direct_skipped_reason: string | null;
|
|
7749
|
+
products_assigned: number;
|
|
7750
|
+
products_unassigned: number;
|
|
7751
|
+
};
|
|
7418
7752
|
GroupOrderItemsRequest: {
|
|
7419
7753
|
participant_id: string;
|
|
7420
7754
|
};
|
|
@@ -7749,6 +8083,11 @@ interface components {
|
|
|
7749
8083
|
LightspeedWebhook: {
|
|
7750
8084
|
endpoint_id: string;
|
|
7751
8085
|
};
|
|
8086
|
+
/** @description One location's delivery-method state, grouped by the stores serving it. */
|
|
8087
|
+
LocationDeliveryMethodSummary: {
|
|
8088
|
+
location_public_id: string;
|
|
8089
|
+
stores: components["schemas"]["StoreDeliveryMethodStates"][];
|
|
8090
|
+
};
|
|
7752
8091
|
/**
|
|
7753
8092
|
* @description * `single` - Single location
|
|
7754
8093
|
* * `subset` - Subset of locations
|
|
@@ -7962,6 +8301,13 @@ interface components {
|
|
|
7962
8301
|
* @enum {string}
|
|
7963
8302
|
*/
|
|
7964
8303
|
MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
|
|
8304
|
+
/**
|
|
8305
|
+
* @description * `drawn` - drawn
|
|
8306
|
+
* * `radius` - radius
|
|
8307
|
+
* * `postcodes` - postcodes
|
|
8308
|
+
* @enum {string}
|
|
8309
|
+
*/
|
|
8310
|
+
ModeEnum: "drawn" | "radius" | "postcodes";
|
|
7965
8311
|
ModifyLineItem: {
|
|
7966
8312
|
/** Format: uuid */
|
|
7967
8313
|
order_line_item_id: string;
|
|
@@ -8692,6 +9038,21 @@ interface components {
|
|
|
8692
9038
|
*/
|
|
8693
9039
|
reusable_deposit_id?: number | null;
|
|
8694
9040
|
};
|
|
9041
|
+
/**
|
|
9042
|
+
* @description Read/write view of a store's merchant/customer delivery-fee split.
|
|
9043
|
+
*
|
|
9044
|
+
* ``delivery_fee_customer_pct`` is the fraction (0-1) of the shipping cost
|
|
9045
|
+
* the customer pays; the merchant absorbs the remainder — see
|
|
9046
|
+
* ``core.fees.apply_pass_through``. DRF derives 0-1 bounds validation from
|
|
9047
|
+
* the model field's own validators.
|
|
9048
|
+
*/
|
|
9049
|
+
PatchedAdminStoreDeliveryFeeSplit: {
|
|
9050
|
+
/**
|
|
9051
|
+
* Format: decimal
|
|
9052
|
+
* @description Fraction of shipping cost the customer pays (0-1). Merchant absorbs the remainder.
|
|
9053
|
+
*/
|
|
9054
|
+
delivery_fee_customer_pct?: string;
|
|
9055
|
+
};
|
|
8695
9056
|
/**
|
|
8696
9057
|
* @description Validates the request body for binding a service point to a cart.
|
|
8697
9058
|
*
|
|
@@ -8740,6 +9101,20 @@ interface components {
|
|
|
8740
9101
|
/** @default */
|
|
8741
9102
|
description: string;
|
|
8742
9103
|
};
|
|
9104
|
+
/** @description A partial edit: rename an area, reshape it, or both. */
|
|
9105
|
+
PatchedDeliveryAreaUpdate: {
|
|
9106
|
+
readonly id?: string;
|
|
9107
|
+
/** @description What the merchant calls this area, e.g. 'North of the canal'. */
|
|
9108
|
+
name?: string;
|
|
9109
|
+
polygon?: unknown;
|
|
9110
|
+
};
|
|
9111
|
+
/** @description A partial edit: rename a pocket, reshape it, or both. */
|
|
9112
|
+
PatchedDeliveryExclusionUpdate: {
|
|
9113
|
+
readonly id?: string;
|
|
9114
|
+
/** @description What the merchant calls this pocket, e.g. 'Canal island'. */
|
|
9115
|
+
name?: string;
|
|
9116
|
+
excluded_polygon?: unknown;
|
|
9117
|
+
};
|
|
8743
9118
|
/**
|
|
8744
9119
|
* @description Merchant-facing CRUD serializer for :class:`Discount`.
|
|
8745
9120
|
*
|
|
@@ -8832,6 +9207,24 @@ interface components {
|
|
|
8832
9207
|
/** Format: date-time */
|
|
8833
9208
|
readonly updated_at?: string;
|
|
8834
9209
|
};
|
|
9210
|
+
/**
|
|
9211
|
+
* @description Marketing consent captured at checkout.
|
|
9212
|
+
*
|
|
9213
|
+
* A single opt-in for special offers and updates (over email, SMS or
|
|
9214
|
+
* WhatsApp), plus the version identifier of the consent copy the customer
|
|
9215
|
+
* saw. Stored on the checkout and copied to the order at creation, then
|
|
9216
|
+
* forwarded to the merchant portal, which persists it onto the customer
|
|
9217
|
+
* record. Unticked by default; the order completes regardless of state.
|
|
9218
|
+
*/
|
|
9219
|
+
PatchedMarketingConsentInput: {
|
|
9220
|
+
/** @default false */
|
|
9221
|
+
opted_in: boolean;
|
|
9222
|
+
/**
|
|
9223
|
+
* @description Version id of the consent copy shown to the customer.
|
|
9224
|
+
* @default
|
|
9225
|
+
*/
|
|
9226
|
+
version: string;
|
|
9227
|
+
};
|
|
8835
9228
|
PatchedMessageUpdate: {
|
|
8836
9229
|
priority?: number;
|
|
8837
9230
|
/** Format: date-time */
|
|
@@ -8961,6 +9354,9 @@ interface components {
|
|
|
8961
9354
|
fee_split_percentage?: string | null;
|
|
8962
9355
|
schedule?: unknown;
|
|
8963
9356
|
lead_time_minutes?: number | null;
|
|
9357
|
+
cutoff_mode?: components["schemas"]["CutoffModeEnum"];
|
|
9358
|
+
cutoff_minutes?: number | null;
|
|
9359
|
+
cutoff_by_day?: unknown;
|
|
8964
9360
|
};
|
|
8965
9361
|
/**
|
|
8966
9362
|
* @description Read/write serializer for the store-onboarding wizard.
|
|
@@ -9003,6 +9399,7 @@ interface components {
|
|
|
9003
9399
|
readonly updated_at?: string;
|
|
9004
9400
|
readonly brand_assets?: components["schemas"]["StoreBrandAsset"][];
|
|
9005
9401
|
readonly uber_direct_supported_countries?: string[];
|
|
9402
|
+
readonly delivery_method_toggles?: components["schemas"]["DeliveryMethodToggles"] | null;
|
|
9006
9403
|
};
|
|
9007
9404
|
PatchedSurcharge: {
|
|
9008
9405
|
readonly id?: number;
|
|
@@ -10038,8 +10435,22 @@ interface components {
|
|
|
10038
10435
|
fee_split_percentage: string | null;
|
|
10039
10436
|
schedule: unknown;
|
|
10040
10437
|
lead_time_minutes: number | null;
|
|
10438
|
+
cutoff_mode: components["schemas"]["CutoffModeEnum"];
|
|
10439
|
+
/** @description Minutes before a day closes that it stops taking orders. NULL means this location sets no cut-off of its own -- it does NOT mean zero. */
|
|
10440
|
+
cutoff_minutes: number | null;
|
|
10441
|
+
/** @description Weekday -> 'HH:MM', the absolute last-order time per day, read only in by_day mode. Its own field rather than a key inside schedule: the editor writes the times here, and a schedule is hours. */
|
|
10442
|
+
cutoff_by_day: unknown;
|
|
10443
|
+
/** @description Per day, the last-order cut-off actually in force and which setting produced it. Read-only: the merchant's own value may be clamped by the kitchen's schedule, and a screen that shows only what was typed cannot tell a clamped value from one that failed to save. */
|
|
10444
|
+
readonly cutoff_in_force: unknown;
|
|
10041
10445
|
/** Format: date-time */
|
|
10042
10446
|
config_updated_at: string | null;
|
|
10447
|
+
/** Format: date-time */
|
|
10448
|
+
disabled_at: string | null;
|
|
10449
|
+
};
|
|
10450
|
+
/** @description Every company-available method's state at one store for one location. */
|
|
10451
|
+
StoreDeliveryMethodStates: {
|
|
10452
|
+
store_public_id: string;
|
|
10453
|
+
methods: components["schemas"]["DeliveryMethodState"][];
|
|
10043
10454
|
};
|
|
10044
10455
|
StoreMeResponse: {
|
|
10045
10456
|
id: number;
|
|
@@ -10088,6 +10499,7 @@ interface components {
|
|
|
10088
10499
|
readonly updated_at: string;
|
|
10089
10500
|
readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
|
|
10090
10501
|
readonly uber_direct_supported_countries: string[];
|
|
10502
|
+
readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
|
|
10091
10503
|
};
|
|
10092
10504
|
/**
|
|
10093
10505
|
* @description * `draft` - Draft
|
|
@@ -10095,6 +10507,49 @@ interface components {
|
|
|
10095
10507
|
* @enum {string}
|
|
10096
10508
|
*/
|
|
10097
10509
|
StoreOnboardingStatusEnum: "draft" | "published";
|
|
10510
|
+
/**
|
|
10511
|
+
* @description The published onboarding row, plus what publish provisioned -- the only
|
|
10512
|
+
* way a merchant learns why an Uber Direct they ticked is not live.
|
|
10513
|
+
*
|
|
10514
|
+
* The provisioning result comes in through ``context["provisioning"]``.
|
|
10515
|
+
*/
|
|
10516
|
+
StorePublishResponse: {
|
|
10517
|
+
slug: string;
|
|
10518
|
+
name?: string;
|
|
10519
|
+
tagline?: string;
|
|
10520
|
+
description?: string;
|
|
10521
|
+
logo_text?: string;
|
|
10522
|
+
theme?: unknown;
|
|
10523
|
+
layout?: string;
|
|
10524
|
+
languages?: unknown;
|
|
10525
|
+
default_language?: string;
|
|
10526
|
+
currency?: string;
|
|
10527
|
+
country?: string;
|
|
10528
|
+
timezone?: string;
|
|
10529
|
+
contact?: unknown;
|
|
10530
|
+
hours?: unknown;
|
|
10531
|
+
social?: unknown;
|
|
10532
|
+
seo?: unknown;
|
|
10533
|
+
fulfilment?: unknown;
|
|
10534
|
+
cuisine?: string;
|
|
10535
|
+
price_range?: string;
|
|
10536
|
+
product_placeholder?: string;
|
|
10537
|
+
analytics?: unknown;
|
|
10538
|
+
labels?: unknown;
|
|
10539
|
+
frame_ancestors?: unknown;
|
|
10540
|
+
multi_store?: boolean;
|
|
10541
|
+
brand_slug?: string;
|
|
10542
|
+
default_store?: string;
|
|
10543
|
+
readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
|
|
10544
|
+
/** Format: date-time */
|
|
10545
|
+
readonly published_at: string | null;
|
|
10546
|
+
/** Format: date-time */
|
|
10547
|
+
readonly updated_at: string;
|
|
10548
|
+
readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
|
|
10549
|
+
readonly uber_direct_supported_countries: string[];
|
|
10550
|
+
readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
|
|
10551
|
+
readonly provisioning: components["schemas"]["FulfilmentProvisioning"];
|
|
10552
|
+
};
|
|
10098
10553
|
/**
|
|
10099
10554
|
* @description Customer-facing profile view (no CRM/analytics fields).
|
|
10100
10555
|
*
|
|
@@ -10432,6 +10887,11 @@ interface components {
|
|
|
10432
10887
|
completed_at: string | null;
|
|
10433
10888
|
eligibility_snapshot: components["schemas"]["EligibilitySnapshot"];
|
|
10434
10889
|
};
|
|
10890
|
+
/** @description Per delivery method: whether the wizard's toggle still decides it. */
|
|
10891
|
+
WizardChoiceApplies: {
|
|
10892
|
+
uber_direct: boolean;
|
|
10893
|
+
lieferando: boolean;
|
|
10894
|
+
};
|
|
10435
10895
|
/** @description Customer-facing Zeemijlen balance + redemption economics. */
|
|
10436
10896
|
ZeemijlenSummary: {
|
|
10437
10897
|
points_balance: number;
|
|
@@ -10463,6 +10923,13 @@ interface components {
|
|
|
10463
10923
|
order_line_item_id: string;
|
|
10464
10924
|
quantity?: number;
|
|
10465
10925
|
};
|
|
10926
|
+
/** @description A point, as ``MerchantShippingProvider`` stores it. */
|
|
10927
|
+
_Origin: {
|
|
10928
|
+
/** Format: decimal */
|
|
10929
|
+
latitude: string;
|
|
10930
|
+
/** Format: decimal */
|
|
10931
|
+
longitude: string;
|
|
10932
|
+
};
|
|
10466
10933
|
/** @description A product a promotion grants as its benefit (id + translated name). */
|
|
10467
10934
|
_PromotionBenefitProduct: {
|
|
10468
10935
|
id: number;
|
|
@@ -11708,9 +12175,88 @@ interface operations {
|
|
|
11708
12175
|
};
|
|
11709
12176
|
};
|
|
11710
12177
|
};
|
|
11711
|
-
|
|
12178
|
+
admin_locations_delivery_methods_list: {
|
|
11712
12179
|
parameters: {
|
|
11713
|
-
query
|
|
12180
|
+
query: {
|
|
12181
|
+
/** @description Repeated ``<store_public_id>:<location_public_id>``, one per store serving a location. At most 50. */
|
|
12182
|
+
pair: string[];
|
|
12183
|
+
};
|
|
12184
|
+
header?: {
|
|
12185
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
12186
|
+
"X-Sous-Company-Id"?: number;
|
|
12187
|
+
};
|
|
12188
|
+
path?: never;
|
|
12189
|
+
cookie?: never;
|
|
12190
|
+
};
|
|
12191
|
+
requestBody?: never;
|
|
12192
|
+
responses: {
|
|
12193
|
+
200: {
|
|
12194
|
+
headers: {
|
|
12195
|
+
[name: string]: unknown;
|
|
12196
|
+
};
|
|
12197
|
+
content: {
|
|
12198
|
+
"application/json": components["schemas"]["LocationDeliveryMethodSummary"][];
|
|
12199
|
+
};
|
|
12200
|
+
};
|
|
12201
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12202
|
+
400: {
|
|
12203
|
+
headers: {
|
|
12204
|
+
[name: string]: unknown;
|
|
12205
|
+
};
|
|
12206
|
+
content: {
|
|
12207
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12208
|
+
};
|
|
12209
|
+
};
|
|
12210
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12211
|
+
401: {
|
|
12212
|
+
headers: {
|
|
12213
|
+
[name: string]: unknown;
|
|
12214
|
+
};
|
|
12215
|
+
content: {
|
|
12216
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12217
|
+
};
|
|
12218
|
+
};
|
|
12219
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12220
|
+
403: {
|
|
12221
|
+
headers: {
|
|
12222
|
+
[name: string]: unknown;
|
|
12223
|
+
};
|
|
12224
|
+
content: {
|
|
12225
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12226
|
+
};
|
|
12227
|
+
};
|
|
12228
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12229
|
+
404: {
|
|
12230
|
+
headers: {
|
|
12231
|
+
[name: string]: unknown;
|
|
12232
|
+
};
|
|
12233
|
+
content: {
|
|
12234
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12235
|
+
};
|
|
12236
|
+
};
|
|
12237
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12238
|
+
429: {
|
|
12239
|
+
headers: {
|
|
12240
|
+
[name: string]: unknown;
|
|
12241
|
+
};
|
|
12242
|
+
content: {
|
|
12243
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12244
|
+
};
|
|
12245
|
+
};
|
|
12246
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12247
|
+
500: {
|
|
12248
|
+
headers: {
|
|
12249
|
+
[name: string]: unknown;
|
|
12250
|
+
};
|
|
12251
|
+
content: {
|
|
12252
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12253
|
+
};
|
|
12254
|
+
};
|
|
12255
|
+
};
|
|
12256
|
+
};
|
|
12257
|
+
admin_pages_list: {
|
|
12258
|
+
parameters: {
|
|
12259
|
+
query?: {
|
|
11714
12260
|
/** @description Language override for translated content. The primary mechanism is the `Accept-Language` header; this query parameter is an override for widget embedding where merchants cannot control browser headers. Defaults to `en`. */
|
|
11715
12261
|
lang?: string;
|
|
11716
12262
|
};
|
|
@@ -12872,7 +13418,1131 @@ interface operations {
|
|
|
12872
13418
|
};
|
|
12873
13419
|
};
|
|
12874
13420
|
};
|
|
12875
|
-
admin_products_confirm_compliance_retrieve: {
|
|
13421
|
+
admin_products_confirm_compliance_retrieve: {
|
|
13422
|
+
parameters: {
|
|
13423
|
+
query?: never;
|
|
13424
|
+
header?: {
|
|
13425
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13426
|
+
"X-Sous-Company-Id"?: number;
|
|
13427
|
+
};
|
|
13428
|
+
path: {
|
|
13429
|
+
product_id: number;
|
|
13430
|
+
};
|
|
13431
|
+
cookie?: never;
|
|
13432
|
+
};
|
|
13433
|
+
requestBody?: never;
|
|
13434
|
+
responses: {
|
|
13435
|
+
200: {
|
|
13436
|
+
headers: {
|
|
13437
|
+
[name: string]: unknown;
|
|
13438
|
+
};
|
|
13439
|
+
content: {
|
|
13440
|
+
"application/json": components["schemas"]["ComplianceConfirmation"];
|
|
13441
|
+
};
|
|
13442
|
+
};
|
|
13443
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13444
|
+
400: {
|
|
13445
|
+
headers: {
|
|
13446
|
+
[name: string]: unknown;
|
|
13447
|
+
};
|
|
13448
|
+
content: {
|
|
13449
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13450
|
+
};
|
|
13451
|
+
};
|
|
13452
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13453
|
+
401: {
|
|
13454
|
+
headers: {
|
|
13455
|
+
[name: string]: unknown;
|
|
13456
|
+
};
|
|
13457
|
+
content: {
|
|
13458
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13459
|
+
};
|
|
13460
|
+
};
|
|
13461
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13462
|
+
403: {
|
|
13463
|
+
headers: {
|
|
13464
|
+
[name: string]: unknown;
|
|
13465
|
+
};
|
|
13466
|
+
content: {
|
|
13467
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13468
|
+
};
|
|
13469
|
+
};
|
|
13470
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13471
|
+
404: {
|
|
13472
|
+
headers: {
|
|
13473
|
+
[name: string]: unknown;
|
|
13474
|
+
};
|
|
13475
|
+
content: {
|
|
13476
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13477
|
+
};
|
|
13478
|
+
};
|
|
13479
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13480
|
+
429: {
|
|
13481
|
+
headers: {
|
|
13482
|
+
[name: string]: unknown;
|
|
13483
|
+
};
|
|
13484
|
+
content: {
|
|
13485
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13486
|
+
};
|
|
13487
|
+
};
|
|
13488
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13489
|
+
500: {
|
|
13490
|
+
headers: {
|
|
13491
|
+
[name: string]: unknown;
|
|
13492
|
+
};
|
|
13493
|
+
content: {
|
|
13494
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13495
|
+
};
|
|
13496
|
+
};
|
|
13497
|
+
};
|
|
13498
|
+
};
|
|
13499
|
+
admin_products_confirm_compliance_create: {
|
|
13500
|
+
parameters: {
|
|
13501
|
+
query?: never;
|
|
13502
|
+
header?: {
|
|
13503
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13504
|
+
"X-Sous-Company-Id"?: number;
|
|
13505
|
+
};
|
|
13506
|
+
path: {
|
|
13507
|
+
product_id: number;
|
|
13508
|
+
};
|
|
13509
|
+
cookie?: never;
|
|
13510
|
+
};
|
|
13511
|
+
requestBody?: never;
|
|
13512
|
+
responses: {
|
|
13513
|
+
/** @description No response body */
|
|
13514
|
+
200: {
|
|
13515
|
+
headers: {
|
|
13516
|
+
[name: string]: unknown;
|
|
13517
|
+
};
|
|
13518
|
+
content?: never;
|
|
13519
|
+
};
|
|
13520
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13521
|
+
400: {
|
|
13522
|
+
headers: {
|
|
13523
|
+
[name: string]: unknown;
|
|
13524
|
+
};
|
|
13525
|
+
content: {
|
|
13526
|
+
"application/json": components["schemas"]["ComplianceIncomplete"];
|
|
13527
|
+
};
|
|
13528
|
+
};
|
|
13529
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13530
|
+
401: {
|
|
13531
|
+
headers: {
|
|
13532
|
+
[name: string]: unknown;
|
|
13533
|
+
};
|
|
13534
|
+
content: {
|
|
13535
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13536
|
+
};
|
|
13537
|
+
};
|
|
13538
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13539
|
+
403: {
|
|
13540
|
+
headers: {
|
|
13541
|
+
[name: string]: unknown;
|
|
13542
|
+
};
|
|
13543
|
+
content: {
|
|
13544
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13545
|
+
};
|
|
13546
|
+
};
|
|
13547
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13548
|
+
404: {
|
|
13549
|
+
headers: {
|
|
13550
|
+
[name: string]: unknown;
|
|
13551
|
+
};
|
|
13552
|
+
content: {
|
|
13553
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13554
|
+
};
|
|
13555
|
+
};
|
|
13556
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13557
|
+
429: {
|
|
13558
|
+
headers: {
|
|
13559
|
+
[name: string]: unknown;
|
|
13560
|
+
};
|
|
13561
|
+
content: {
|
|
13562
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13563
|
+
};
|
|
13564
|
+
};
|
|
13565
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13566
|
+
500: {
|
|
13567
|
+
headers: {
|
|
13568
|
+
[name: string]: unknown;
|
|
13569
|
+
};
|
|
13570
|
+
content: {
|
|
13571
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13572
|
+
};
|
|
13573
|
+
};
|
|
13574
|
+
};
|
|
13575
|
+
};
|
|
13576
|
+
admin_products_confirm_compliance_destroy: {
|
|
13577
|
+
parameters: {
|
|
13578
|
+
query?: never;
|
|
13579
|
+
header?: {
|
|
13580
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13581
|
+
"X-Sous-Company-Id"?: number;
|
|
13582
|
+
};
|
|
13583
|
+
path: {
|
|
13584
|
+
product_id: number;
|
|
13585
|
+
};
|
|
13586
|
+
cookie?: never;
|
|
13587
|
+
};
|
|
13588
|
+
requestBody?: never;
|
|
13589
|
+
responses: {
|
|
13590
|
+
/** @description No response body */
|
|
13591
|
+
204: {
|
|
13592
|
+
headers: {
|
|
13593
|
+
[name: string]: unknown;
|
|
13594
|
+
};
|
|
13595
|
+
content?: never;
|
|
13596
|
+
};
|
|
13597
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13598
|
+
400: {
|
|
13599
|
+
headers: {
|
|
13600
|
+
[name: string]: unknown;
|
|
13601
|
+
};
|
|
13602
|
+
content: {
|
|
13603
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13604
|
+
};
|
|
13605
|
+
};
|
|
13606
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13607
|
+
401: {
|
|
13608
|
+
headers: {
|
|
13609
|
+
[name: string]: unknown;
|
|
13610
|
+
};
|
|
13611
|
+
content: {
|
|
13612
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13613
|
+
};
|
|
13614
|
+
};
|
|
13615
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13616
|
+
403: {
|
|
13617
|
+
headers: {
|
|
13618
|
+
[name: string]: unknown;
|
|
13619
|
+
};
|
|
13620
|
+
content: {
|
|
13621
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13622
|
+
};
|
|
13623
|
+
};
|
|
13624
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13625
|
+
404: {
|
|
13626
|
+
headers: {
|
|
13627
|
+
[name: string]: unknown;
|
|
13628
|
+
};
|
|
13629
|
+
content: {
|
|
13630
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13631
|
+
};
|
|
13632
|
+
};
|
|
13633
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13634
|
+
429: {
|
|
13635
|
+
headers: {
|
|
13636
|
+
[name: string]: unknown;
|
|
13637
|
+
};
|
|
13638
|
+
content: {
|
|
13639
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13640
|
+
};
|
|
13641
|
+
};
|
|
13642
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13643
|
+
500: {
|
|
13644
|
+
headers: {
|
|
13645
|
+
[name: string]: unknown;
|
|
13646
|
+
};
|
|
13647
|
+
content: {
|
|
13648
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13649
|
+
};
|
|
13650
|
+
};
|
|
13651
|
+
};
|
|
13652
|
+
};
|
|
13653
|
+
admin_products_surcharges_update: {
|
|
13654
|
+
parameters: {
|
|
13655
|
+
query?: never;
|
|
13656
|
+
header?: {
|
|
13657
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13658
|
+
"X-Sous-Company-Id"?: number;
|
|
13659
|
+
};
|
|
13660
|
+
path: {
|
|
13661
|
+
product_id: number;
|
|
13662
|
+
};
|
|
13663
|
+
cookie?: never;
|
|
13664
|
+
};
|
|
13665
|
+
requestBody: {
|
|
13666
|
+
content: {
|
|
13667
|
+
"application/json": components["schemas"]["AdminProductSurchargesRequest"];
|
|
13668
|
+
"application/x-www-form-urlencoded": components["schemas"]["AdminProductSurchargesRequest"];
|
|
13669
|
+
"multipart/form-data": components["schemas"]["AdminProductSurchargesRequest"];
|
|
13670
|
+
};
|
|
13671
|
+
};
|
|
13672
|
+
responses: {
|
|
13673
|
+
200: {
|
|
13674
|
+
headers: {
|
|
13675
|
+
[name: string]: unknown;
|
|
13676
|
+
};
|
|
13677
|
+
content: {
|
|
13678
|
+
"application/json": components["schemas"]["Surcharge"][];
|
|
13679
|
+
};
|
|
13680
|
+
};
|
|
13681
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13682
|
+
400: {
|
|
13683
|
+
headers: {
|
|
13684
|
+
[name: string]: unknown;
|
|
13685
|
+
};
|
|
13686
|
+
content: {
|
|
13687
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13688
|
+
};
|
|
13689
|
+
};
|
|
13690
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13691
|
+
401: {
|
|
13692
|
+
headers: {
|
|
13693
|
+
[name: string]: unknown;
|
|
13694
|
+
};
|
|
13695
|
+
content: {
|
|
13696
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13697
|
+
};
|
|
13698
|
+
};
|
|
13699
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13700
|
+
403: {
|
|
13701
|
+
headers: {
|
|
13702
|
+
[name: string]: unknown;
|
|
13703
|
+
};
|
|
13704
|
+
content: {
|
|
13705
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13706
|
+
};
|
|
13707
|
+
};
|
|
13708
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13709
|
+
404: {
|
|
13710
|
+
headers: {
|
|
13711
|
+
[name: string]: unknown;
|
|
13712
|
+
};
|
|
13713
|
+
content: {
|
|
13714
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13715
|
+
};
|
|
13716
|
+
};
|
|
13717
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13718
|
+
429: {
|
|
13719
|
+
headers: {
|
|
13720
|
+
[name: string]: unknown;
|
|
13721
|
+
};
|
|
13722
|
+
content: {
|
|
13723
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13724
|
+
};
|
|
13725
|
+
};
|
|
13726
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13727
|
+
500: {
|
|
13728
|
+
headers: {
|
|
13729
|
+
[name: string]: unknown;
|
|
13730
|
+
};
|
|
13731
|
+
content: {
|
|
13732
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13733
|
+
};
|
|
13734
|
+
};
|
|
13735
|
+
};
|
|
13736
|
+
};
|
|
13737
|
+
admin_products_shared_create: {
|
|
13738
|
+
parameters: {
|
|
13739
|
+
query?: never;
|
|
13740
|
+
header?: {
|
|
13741
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13742
|
+
"X-Sous-Company-Id"?: number;
|
|
13743
|
+
};
|
|
13744
|
+
path?: never;
|
|
13745
|
+
cookie?: never;
|
|
13746
|
+
};
|
|
13747
|
+
requestBody: {
|
|
13748
|
+
content: {
|
|
13749
|
+
"application/json": components["schemas"]["SharedProductsRequest"];
|
|
13750
|
+
"application/x-www-form-urlencoded": components["schemas"]["SharedProductsRequest"];
|
|
13751
|
+
"multipart/form-data": components["schemas"]["SharedProductsRequest"];
|
|
13752
|
+
};
|
|
13753
|
+
};
|
|
13754
|
+
responses: {
|
|
13755
|
+
200: {
|
|
13756
|
+
headers: {
|
|
13757
|
+
[name: string]: unknown;
|
|
13758
|
+
};
|
|
13759
|
+
content: {
|
|
13760
|
+
"application/json": components["schemas"]["SharedBrandProduct"][];
|
|
13761
|
+
};
|
|
13762
|
+
};
|
|
13763
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13764
|
+
400: {
|
|
13765
|
+
headers: {
|
|
13766
|
+
[name: string]: unknown;
|
|
13767
|
+
};
|
|
13768
|
+
content: {
|
|
13769
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13770
|
+
};
|
|
13771
|
+
};
|
|
13772
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13773
|
+
401: {
|
|
13774
|
+
headers: {
|
|
13775
|
+
[name: string]: unknown;
|
|
13776
|
+
};
|
|
13777
|
+
content: {
|
|
13778
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13779
|
+
};
|
|
13780
|
+
};
|
|
13781
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13782
|
+
403: {
|
|
13783
|
+
headers: {
|
|
13784
|
+
[name: string]: unknown;
|
|
13785
|
+
};
|
|
13786
|
+
content: {
|
|
13787
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13788
|
+
};
|
|
13789
|
+
};
|
|
13790
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13791
|
+
404: {
|
|
13792
|
+
headers: {
|
|
13793
|
+
[name: string]: unknown;
|
|
13794
|
+
};
|
|
13795
|
+
content: {
|
|
13796
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13797
|
+
};
|
|
13798
|
+
};
|
|
13799
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13800
|
+
429: {
|
|
13801
|
+
headers: {
|
|
13802
|
+
[name: string]: unknown;
|
|
13803
|
+
};
|
|
13804
|
+
content: {
|
|
13805
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13806
|
+
};
|
|
13807
|
+
};
|
|
13808
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13809
|
+
500: {
|
|
13810
|
+
headers: {
|
|
13811
|
+
[name: string]: unknown;
|
|
13812
|
+
};
|
|
13813
|
+
content: {
|
|
13814
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13815
|
+
};
|
|
13816
|
+
};
|
|
13817
|
+
};
|
|
13818
|
+
};
|
|
13819
|
+
admin_promotions_list: {
|
|
13820
|
+
parameters: {
|
|
13821
|
+
query?: {
|
|
13822
|
+
/** @description The pagination cursor value. */
|
|
13823
|
+
cursor?: string;
|
|
13824
|
+
};
|
|
13825
|
+
header?: {
|
|
13826
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13827
|
+
"X-Sous-Company-Id"?: number;
|
|
13828
|
+
};
|
|
13829
|
+
path?: never;
|
|
13830
|
+
cookie?: never;
|
|
13831
|
+
};
|
|
13832
|
+
requestBody?: never;
|
|
13833
|
+
responses: {
|
|
13834
|
+
200: {
|
|
13835
|
+
headers: {
|
|
13836
|
+
[name: string]: unknown;
|
|
13837
|
+
};
|
|
13838
|
+
content: {
|
|
13839
|
+
"application/json": components["schemas"]["PaginatedAdminPromotionList"];
|
|
13840
|
+
};
|
|
13841
|
+
};
|
|
13842
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13843
|
+
400: {
|
|
13844
|
+
headers: {
|
|
13845
|
+
[name: string]: unknown;
|
|
13846
|
+
};
|
|
13847
|
+
content: {
|
|
13848
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13849
|
+
};
|
|
13850
|
+
};
|
|
13851
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13852
|
+
401: {
|
|
13853
|
+
headers: {
|
|
13854
|
+
[name: string]: unknown;
|
|
13855
|
+
};
|
|
13856
|
+
content: {
|
|
13857
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13858
|
+
};
|
|
13859
|
+
};
|
|
13860
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13861
|
+
403: {
|
|
13862
|
+
headers: {
|
|
13863
|
+
[name: string]: unknown;
|
|
13864
|
+
};
|
|
13865
|
+
content: {
|
|
13866
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13867
|
+
};
|
|
13868
|
+
};
|
|
13869
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13870
|
+
404: {
|
|
13871
|
+
headers: {
|
|
13872
|
+
[name: string]: unknown;
|
|
13873
|
+
};
|
|
13874
|
+
content: {
|
|
13875
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13876
|
+
};
|
|
13877
|
+
};
|
|
13878
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13879
|
+
429: {
|
|
13880
|
+
headers: {
|
|
13881
|
+
[name: string]: unknown;
|
|
13882
|
+
};
|
|
13883
|
+
content: {
|
|
13884
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13885
|
+
};
|
|
13886
|
+
};
|
|
13887
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13888
|
+
500: {
|
|
13889
|
+
headers: {
|
|
13890
|
+
[name: string]: unknown;
|
|
13891
|
+
};
|
|
13892
|
+
content: {
|
|
13893
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13894
|
+
};
|
|
13895
|
+
};
|
|
13896
|
+
};
|
|
13897
|
+
};
|
|
13898
|
+
admin_promotions_create: {
|
|
13899
|
+
parameters: {
|
|
13900
|
+
query?: never;
|
|
13901
|
+
header?: {
|
|
13902
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13903
|
+
"X-Sous-Company-Id"?: number;
|
|
13904
|
+
};
|
|
13905
|
+
path?: never;
|
|
13906
|
+
cookie?: never;
|
|
13907
|
+
};
|
|
13908
|
+
requestBody: {
|
|
13909
|
+
content: {
|
|
13910
|
+
"application/json": components["schemas"]["AdminPromotion"];
|
|
13911
|
+
"application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
|
|
13912
|
+
"multipart/form-data": components["schemas"]["AdminPromotion"];
|
|
13913
|
+
};
|
|
13914
|
+
};
|
|
13915
|
+
responses: {
|
|
13916
|
+
200: {
|
|
13917
|
+
headers: {
|
|
13918
|
+
[name: string]: unknown;
|
|
13919
|
+
};
|
|
13920
|
+
content: {
|
|
13921
|
+
"application/json": components["schemas"]["AdminPromotion"];
|
|
13922
|
+
};
|
|
13923
|
+
};
|
|
13924
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13925
|
+
400: {
|
|
13926
|
+
headers: {
|
|
13927
|
+
[name: string]: unknown;
|
|
13928
|
+
};
|
|
13929
|
+
content: {
|
|
13930
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13931
|
+
};
|
|
13932
|
+
};
|
|
13933
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13934
|
+
401: {
|
|
13935
|
+
headers: {
|
|
13936
|
+
[name: string]: unknown;
|
|
13937
|
+
};
|
|
13938
|
+
content: {
|
|
13939
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13940
|
+
};
|
|
13941
|
+
};
|
|
13942
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13943
|
+
403: {
|
|
13944
|
+
headers: {
|
|
13945
|
+
[name: string]: unknown;
|
|
13946
|
+
};
|
|
13947
|
+
content: {
|
|
13948
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13949
|
+
};
|
|
13950
|
+
};
|
|
13951
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13952
|
+
404: {
|
|
13953
|
+
headers: {
|
|
13954
|
+
[name: string]: unknown;
|
|
13955
|
+
};
|
|
13956
|
+
content: {
|
|
13957
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13958
|
+
};
|
|
13959
|
+
};
|
|
13960
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13961
|
+
429: {
|
|
13962
|
+
headers: {
|
|
13963
|
+
[name: string]: unknown;
|
|
13964
|
+
};
|
|
13965
|
+
content: {
|
|
13966
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13967
|
+
};
|
|
13968
|
+
};
|
|
13969
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13970
|
+
500: {
|
|
13971
|
+
headers: {
|
|
13972
|
+
[name: string]: unknown;
|
|
13973
|
+
};
|
|
13974
|
+
content: {
|
|
13975
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
13976
|
+
};
|
|
13977
|
+
};
|
|
13978
|
+
};
|
|
13979
|
+
};
|
|
13980
|
+
admin_promotions_retrieve: {
|
|
13981
|
+
parameters: {
|
|
13982
|
+
query?: never;
|
|
13983
|
+
header?: {
|
|
13984
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13985
|
+
"X-Sous-Company-Id"?: number;
|
|
13986
|
+
};
|
|
13987
|
+
path: {
|
|
13988
|
+
/** @description A unique integer value identifying this promotion. */
|
|
13989
|
+
id: number;
|
|
13990
|
+
};
|
|
13991
|
+
cookie?: never;
|
|
13992
|
+
};
|
|
13993
|
+
requestBody?: never;
|
|
13994
|
+
responses: {
|
|
13995
|
+
200: {
|
|
13996
|
+
headers: {
|
|
13997
|
+
[name: string]: unknown;
|
|
13998
|
+
};
|
|
13999
|
+
content: {
|
|
14000
|
+
"application/json": components["schemas"]["AdminPromotion"];
|
|
14001
|
+
};
|
|
14002
|
+
};
|
|
14003
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14004
|
+
400: {
|
|
14005
|
+
headers: {
|
|
14006
|
+
[name: string]: unknown;
|
|
14007
|
+
};
|
|
14008
|
+
content: {
|
|
14009
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14010
|
+
};
|
|
14011
|
+
};
|
|
14012
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14013
|
+
401: {
|
|
14014
|
+
headers: {
|
|
14015
|
+
[name: string]: unknown;
|
|
14016
|
+
};
|
|
14017
|
+
content: {
|
|
14018
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14019
|
+
};
|
|
14020
|
+
};
|
|
14021
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14022
|
+
403: {
|
|
14023
|
+
headers: {
|
|
14024
|
+
[name: string]: unknown;
|
|
14025
|
+
};
|
|
14026
|
+
content: {
|
|
14027
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14028
|
+
};
|
|
14029
|
+
};
|
|
14030
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14031
|
+
404: {
|
|
14032
|
+
headers: {
|
|
14033
|
+
[name: string]: unknown;
|
|
14034
|
+
};
|
|
14035
|
+
content: {
|
|
14036
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14037
|
+
};
|
|
14038
|
+
};
|
|
14039
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14040
|
+
429: {
|
|
14041
|
+
headers: {
|
|
14042
|
+
[name: string]: unknown;
|
|
14043
|
+
};
|
|
14044
|
+
content: {
|
|
14045
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14046
|
+
};
|
|
14047
|
+
};
|
|
14048
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14049
|
+
500: {
|
|
14050
|
+
headers: {
|
|
14051
|
+
[name: string]: unknown;
|
|
14052
|
+
};
|
|
14053
|
+
content: {
|
|
14054
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14055
|
+
};
|
|
14056
|
+
};
|
|
14057
|
+
};
|
|
14058
|
+
};
|
|
14059
|
+
admin_promotions_update: {
|
|
14060
|
+
parameters: {
|
|
14061
|
+
query?: never;
|
|
14062
|
+
header?: {
|
|
14063
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14064
|
+
"X-Sous-Company-Id"?: number;
|
|
14065
|
+
};
|
|
14066
|
+
path: {
|
|
14067
|
+
/** @description A unique integer value identifying this promotion. */
|
|
14068
|
+
id: number;
|
|
14069
|
+
};
|
|
14070
|
+
cookie?: never;
|
|
14071
|
+
};
|
|
14072
|
+
requestBody: {
|
|
14073
|
+
content: {
|
|
14074
|
+
"application/json": components["schemas"]["AdminPromotion"];
|
|
14075
|
+
"application/x-www-form-urlencoded": components["schemas"]["AdminPromotion"];
|
|
14076
|
+
"multipart/form-data": components["schemas"]["AdminPromotion"];
|
|
14077
|
+
};
|
|
14078
|
+
};
|
|
14079
|
+
responses: {
|
|
14080
|
+
200: {
|
|
14081
|
+
headers: {
|
|
14082
|
+
[name: string]: unknown;
|
|
14083
|
+
};
|
|
14084
|
+
content: {
|
|
14085
|
+
"application/json": components["schemas"]["AdminPromotion"];
|
|
14086
|
+
};
|
|
14087
|
+
};
|
|
14088
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14089
|
+
400: {
|
|
14090
|
+
headers: {
|
|
14091
|
+
[name: string]: unknown;
|
|
14092
|
+
};
|
|
14093
|
+
content: {
|
|
14094
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14095
|
+
};
|
|
14096
|
+
};
|
|
14097
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14098
|
+
401: {
|
|
14099
|
+
headers: {
|
|
14100
|
+
[name: string]: unknown;
|
|
14101
|
+
};
|
|
14102
|
+
content: {
|
|
14103
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14104
|
+
};
|
|
14105
|
+
};
|
|
14106
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14107
|
+
403: {
|
|
14108
|
+
headers: {
|
|
14109
|
+
[name: string]: unknown;
|
|
14110
|
+
};
|
|
14111
|
+
content: {
|
|
14112
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14113
|
+
};
|
|
14114
|
+
};
|
|
14115
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14116
|
+
404: {
|
|
14117
|
+
headers: {
|
|
14118
|
+
[name: string]: unknown;
|
|
14119
|
+
};
|
|
14120
|
+
content: {
|
|
14121
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14122
|
+
};
|
|
14123
|
+
};
|
|
14124
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14125
|
+
429: {
|
|
14126
|
+
headers: {
|
|
14127
|
+
[name: string]: unknown;
|
|
14128
|
+
};
|
|
14129
|
+
content: {
|
|
14130
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14131
|
+
};
|
|
14132
|
+
};
|
|
14133
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14134
|
+
500: {
|
|
14135
|
+
headers: {
|
|
14136
|
+
[name: string]: unknown;
|
|
14137
|
+
};
|
|
14138
|
+
content: {
|
|
14139
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14140
|
+
};
|
|
14141
|
+
};
|
|
14142
|
+
};
|
|
14143
|
+
};
|
|
14144
|
+
admin_promotions_destroy: {
|
|
14145
|
+
parameters: {
|
|
14146
|
+
query?: never;
|
|
14147
|
+
header?: {
|
|
14148
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14149
|
+
"X-Sous-Company-Id"?: number;
|
|
14150
|
+
};
|
|
14151
|
+
path: {
|
|
14152
|
+
/** @description A unique integer value identifying this promotion. */
|
|
14153
|
+
id: number;
|
|
14154
|
+
};
|
|
14155
|
+
cookie?: never;
|
|
14156
|
+
};
|
|
14157
|
+
requestBody?: never;
|
|
14158
|
+
responses: {
|
|
14159
|
+
/** @description No response body */
|
|
14160
|
+
204: {
|
|
14161
|
+
headers: {
|
|
14162
|
+
[name: string]: unknown;
|
|
14163
|
+
};
|
|
14164
|
+
content?: never;
|
|
14165
|
+
};
|
|
14166
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14167
|
+
400: {
|
|
14168
|
+
headers: {
|
|
14169
|
+
[name: string]: unknown;
|
|
14170
|
+
};
|
|
14171
|
+
content: {
|
|
14172
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14173
|
+
};
|
|
14174
|
+
};
|
|
14175
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14176
|
+
401: {
|
|
14177
|
+
headers: {
|
|
14178
|
+
[name: string]: unknown;
|
|
14179
|
+
};
|
|
14180
|
+
content: {
|
|
14181
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14182
|
+
};
|
|
14183
|
+
};
|
|
14184
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14185
|
+
403: {
|
|
14186
|
+
headers: {
|
|
14187
|
+
[name: string]: unknown;
|
|
14188
|
+
};
|
|
14189
|
+
content: {
|
|
14190
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14191
|
+
};
|
|
14192
|
+
};
|
|
14193
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14194
|
+
404: {
|
|
14195
|
+
headers: {
|
|
14196
|
+
[name: string]: unknown;
|
|
14197
|
+
};
|
|
14198
|
+
content: {
|
|
14199
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14200
|
+
};
|
|
14201
|
+
};
|
|
14202
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14203
|
+
429: {
|
|
14204
|
+
headers: {
|
|
14205
|
+
[name: string]: unknown;
|
|
14206
|
+
};
|
|
14207
|
+
content: {
|
|
14208
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14209
|
+
};
|
|
14210
|
+
};
|
|
14211
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14212
|
+
500: {
|
|
14213
|
+
headers: {
|
|
14214
|
+
[name: string]: unknown;
|
|
14215
|
+
};
|
|
14216
|
+
content: {
|
|
14217
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14218
|
+
};
|
|
14219
|
+
};
|
|
14220
|
+
};
|
|
14221
|
+
};
|
|
14222
|
+
admin_promotions_partial_update: {
|
|
14223
|
+
parameters: {
|
|
14224
|
+
query?: never;
|
|
14225
|
+
header?: {
|
|
14226
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14227
|
+
"X-Sous-Company-Id"?: number;
|
|
14228
|
+
};
|
|
14229
|
+
path: {
|
|
14230
|
+
/** @description A unique integer value identifying this promotion. */
|
|
14231
|
+
id: number;
|
|
14232
|
+
};
|
|
14233
|
+
cookie?: never;
|
|
14234
|
+
};
|
|
14235
|
+
requestBody?: {
|
|
14236
|
+
content: {
|
|
14237
|
+
"application/json": components["schemas"]["PatchedAdminPromotion"];
|
|
14238
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedAdminPromotion"];
|
|
14239
|
+
"multipart/form-data": components["schemas"]["PatchedAdminPromotion"];
|
|
14240
|
+
};
|
|
14241
|
+
};
|
|
14242
|
+
responses: {
|
|
14243
|
+
200: {
|
|
14244
|
+
headers: {
|
|
14245
|
+
[name: string]: unknown;
|
|
14246
|
+
};
|
|
14247
|
+
content: {
|
|
14248
|
+
"application/json": components["schemas"]["AdminPromotion"];
|
|
14249
|
+
};
|
|
14250
|
+
};
|
|
14251
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14252
|
+
400: {
|
|
14253
|
+
headers: {
|
|
14254
|
+
[name: string]: unknown;
|
|
14255
|
+
};
|
|
14256
|
+
content: {
|
|
14257
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14258
|
+
};
|
|
14259
|
+
};
|
|
14260
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14261
|
+
401: {
|
|
14262
|
+
headers: {
|
|
14263
|
+
[name: string]: unknown;
|
|
14264
|
+
};
|
|
14265
|
+
content: {
|
|
14266
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14267
|
+
};
|
|
14268
|
+
};
|
|
14269
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14270
|
+
403: {
|
|
14271
|
+
headers: {
|
|
14272
|
+
[name: string]: unknown;
|
|
14273
|
+
};
|
|
14274
|
+
content: {
|
|
14275
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14276
|
+
};
|
|
14277
|
+
};
|
|
14278
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14279
|
+
404: {
|
|
14280
|
+
headers: {
|
|
14281
|
+
[name: string]: unknown;
|
|
14282
|
+
};
|
|
14283
|
+
content: {
|
|
14284
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14285
|
+
};
|
|
14286
|
+
};
|
|
14287
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14288
|
+
429: {
|
|
14289
|
+
headers: {
|
|
14290
|
+
[name: string]: unknown;
|
|
14291
|
+
};
|
|
14292
|
+
content: {
|
|
14293
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14294
|
+
};
|
|
14295
|
+
};
|
|
14296
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14297
|
+
500: {
|
|
14298
|
+
headers: {
|
|
14299
|
+
[name: string]: unknown;
|
|
14300
|
+
};
|
|
14301
|
+
content: {
|
|
14302
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14303
|
+
};
|
|
14304
|
+
};
|
|
14305
|
+
};
|
|
14306
|
+
};
|
|
14307
|
+
admin_store_fulfillment_types_list: {
|
|
14308
|
+
parameters: {
|
|
14309
|
+
query?: never;
|
|
14310
|
+
header?: {
|
|
14311
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14312
|
+
"X-Sous-Company-Id"?: number;
|
|
14313
|
+
};
|
|
14314
|
+
path?: never;
|
|
14315
|
+
cookie?: never;
|
|
14316
|
+
};
|
|
14317
|
+
requestBody?: never;
|
|
14318
|
+
responses: {
|
|
14319
|
+
200: {
|
|
14320
|
+
headers: {
|
|
14321
|
+
[name: string]: unknown;
|
|
14322
|
+
};
|
|
14323
|
+
content: {
|
|
14324
|
+
"application/json": components["schemas"]["AdminStoreFulfillment"][];
|
|
14325
|
+
};
|
|
14326
|
+
};
|
|
14327
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14328
|
+
400: {
|
|
14329
|
+
headers: {
|
|
14330
|
+
[name: string]: unknown;
|
|
14331
|
+
};
|
|
14332
|
+
content: {
|
|
14333
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14334
|
+
};
|
|
14335
|
+
};
|
|
14336
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14337
|
+
401: {
|
|
14338
|
+
headers: {
|
|
14339
|
+
[name: string]: unknown;
|
|
14340
|
+
};
|
|
14341
|
+
content: {
|
|
14342
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14343
|
+
};
|
|
14344
|
+
};
|
|
14345
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14346
|
+
403: {
|
|
14347
|
+
headers: {
|
|
14348
|
+
[name: string]: unknown;
|
|
14349
|
+
};
|
|
14350
|
+
content: {
|
|
14351
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14352
|
+
};
|
|
14353
|
+
};
|
|
14354
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14355
|
+
404: {
|
|
14356
|
+
headers: {
|
|
14357
|
+
[name: string]: unknown;
|
|
14358
|
+
};
|
|
14359
|
+
content: {
|
|
14360
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14361
|
+
};
|
|
14362
|
+
};
|
|
14363
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14364
|
+
429: {
|
|
14365
|
+
headers: {
|
|
14366
|
+
[name: string]: unknown;
|
|
14367
|
+
};
|
|
14368
|
+
content: {
|
|
14369
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14370
|
+
};
|
|
14371
|
+
};
|
|
14372
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14373
|
+
500: {
|
|
14374
|
+
headers: {
|
|
14375
|
+
[name: string]: unknown;
|
|
14376
|
+
};
|
|
14377
|
+
content: {
|
|
14378
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14379
|
+
};
|
|
14380
|
+
};
|
|
14381
|
+
};
|
|
14382
|
+
};
|
|
14383
|
+
admin_stores_base_coverage_retrieve: {
|
|
14384
|
+
parameters: {
|
|
14385
|
+
query?: never;
|
|
14386
|
+
header?: {
|
|
14387
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14388
|
+
"X-Sous-Company-Id"?: number;
|
|
14389
|
+
};
|
|
14390
|
+
path: {
|
|
14391
|
+
store_public_id: string;
|
|
14392
|
+
};
|
|
14393
|
+
cookie?: never;
|
|
14394
|
+
};
|
|
14395
|
+
requestBody?: never;
|
|
14396
|
+
responses: {
|
|
14397
|
+
200: {
|
|
14398
|
+
headers: {
|
|
14399
|
+
[name: string]: unknown;
|
|
14400
|
+
};
|
|
14401
|
+
content: {
|
|
14402
|
+
"application/json": components["schemas"]["BaseCoverage"];
|
|
14403
|
+
};
|
|
14404
|
+
};
|
|
14405
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14406
|
+
400: {
|
|
14407
|
+
headers: {
|
|
14408
|
+
[name: string]: unknown;
|
|
14409
|
+
};
|
|
14410
|
+
content: {
|
|
14411
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14412
|
+
};
|
|
14413
|
+
};
|
|
14414
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14415
|
+
401: {
|
|
14416
|
+
headers: {
|
|
14417
|
+
[name: string]: unknown;
|
|
14418
|
+
};
|
|
14419
|
+
content: {
|
|
14420
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14421
|
+
};
|
|
14422
|
+
};
|
|
14423
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14424
|
+
403: {
|
|
14425
|
+
headers: {
|
|
14426
|
+
[name: string]: unknown;
|
|
14427
|
+
};
|
|
14428
|
+
content: {
|
|
14429
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14430
|
+
};
|
|
14431
|
+
};
|
|
14432
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14433
|
+
404: {
|
|
14434
|
+
headers: {
|
|
14435
|
+
[name: string]: unknown;
|
|
14436
|
+
};
|
|
14437
|
+
content: {
|
|
14438
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14439
|
+
};
|
|
14440
|
+
};
|
|
14441
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14442
|
+
429: {
|
|
14443
|
+
headers: {
|
|
14444
|
+
[name: string]: unknown;
|
|
14445
|
+
};
|
|
14446
|
+
content: {
|
|
14447
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14448
|
+
};
|
|
14449
|
+
};
|
|
14450
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14451
|
+
500: {
|
|
14452
|
+
headers: {
|
|
14453
|
+
[name: string]: unknown;
|
|
14454
|
+
};
|
|
14455
|
+
content: {
|
|
14456
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14457
|
+
};
|
|
14458
|
+
};
|
|
14459
|
+
};
|
|
14460
|
+
};
|
|
14461
|
+
admin_stores_base_coverage_update: {
|
|
14462
|
+
parameters: {
|
|
14463
|
+
query?: never;
|
|
14464
|
+
header?: {
|
|
14465
|
+
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14466
|
+
"X-Sous-Company-Id"?: number;
|
|
14467
|
+
};
|
|
14468
|
+
path: {
|
|
14469
|
+
store_public_id: string;
|
|
14470
|
+
};
|
|
14471
|
+
cookie?: never;
|
|
14472
|
+
};
|
|
14473
|
+
requestBody: {
|
|
14474
|
+
content: {
|
|
14475
|
+
"application/json": components["schemas"]["BaseCoverage"];
|
|
14476
|
+
"application/x-www-form-urlencoded": components["schemas"]["BaseCoverage"];
|
|
14477
|
+
"multipart/form-data": components["schemas"]["BaseCoverage"];
|
|
14478
|
+
};
|
|
14479
|
+
};
|
|
14480
|
+
responses: {
|
|
14481
|
+
200: {
|
|
14482
|
+
headers: {
|
|
14483
|
+
[name: string]: unknown;
|
|
14484
|
+
};
|
|
14485
|
+
content: {
|
|
14486
|
+
"application/json": components["schemas"]["BaseCoverage"];
|
|
14487
|
+
};
|
|
14488
|
+
};
|
|
14489
|
+
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14490
|
+
400: {
|
|
14491
|
+
headers: {
|
|
14492
|
+
[name: string]: unknown;
|
|
14493
|
+
};
|
|
14494
|
+
content: {
|
|
14495
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14496
|
+
};
|
|
14497
|
+
};
|
|
14498
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14499
|
+
401: {
|
|
14500
|
+
headers: {
|
|
14501
|
+
[name: string]: unknown;
|
|
14502
|
+
};
|
|
14503
|
+
content: {
|
|
14504
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14505
|
+
};
|
|
14506
|
+
};
|
|
14507
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14508
|
+
403: {
|
|
14509
|
+
headers: {
|
|
14510
|
+
[name: string]: unknown;
|
|
14511
|
+
};
|
|
14512
|
+
content: {
|
|
14513
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14514
|
+
};
|
|
14515
|
+
};
|
|
14516
|
+
/** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14517
|
+
404: {
|
|
14518
|
+
headers: {
|
|
14519
|
+
[name: string]: unknown;
|
|
14520
|
+
};
|
|
14521
|
+
content: {
|
|
14522
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14523
|
+
};
|
|
14524
|
+
};
|
|
14525
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14526
|
+
429: {
|
|
14527
|
+
headers: {
|
|
14528
|
+
[name: string]: unknown;
|
|
14529
|
+
};
|
|
14530
|
+
content: {
|
|
14531
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14532
|
+
};
|
|
14533
|
+
};
|
|
14534
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
14535
|
+
500: {
|
|
14536
|
+
headers: {
|
|
14537
|
+
[name: string]: unknown;
|
|
14538
|
+
};
|
|
14539
|
+
content: {
|
|
14540
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
14541
|
+
};
|
|
14542
|
+
};
|
|
14543
|
+
};
|
|
14544
|
+
};
|
|
14545
|
+
admin_stores_compliance_defaults_retrieve: {
|
|
12876
14546
|
parameters: {
|
|
12877
14547
|
query?: never;
|
|
12878
14548
|
header?: {
|
|
@@ -12880,7 +14550,7 @@ interface operations {
|
|
|
12880
14550
|
"X-Sous-Company-Id"?: number;
|
|
12881
14551
|
};
|
|
12882
14552
|
path: {
|
|
12883
|
-
|
|
14553
|
+
store_public_id: string;
|
|
12884
14554
|
};
|
|
12885
14555
|
cookie?: never;
|
|
12886
14556
|
};
|
|
@@ -12891,7 +14561,7 @@ interface operations {
|
|
|
12891
14561
|
[name: string]: unknown;
|
|
12892
14562
|
};
|
|
12893
14563
|
content: {
|
|
12894
|
-
"application/json": components["schemas"]["
|
|
14564
|
+
"application/json": components["schemas"]["AdminStoreComplianceDefaults"];
|
|
12895
14565
|
};
|
|
12896
14566
|
};
|
|
12897
14567
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -12950,7 +14620,7 @@ interface operations {
|
|
|
12950
14620
|
};
|
|
12951
14621
|
};
|
|
12952
14622
|
};
|
|
12953
|
-
|
|
14623
|
+
admin_stores_compliance_defaults_partial_update: {
|
|
12954
14624
|
parameters: {
|
|
12955
14625
|
query?: never;
|
|
12956
14626
|
header?: {
|
|
@@ -12958,18 +14628,25 @@ interface operations {
|
|
|
12958
14628
|
"X-Sous-Company-Id"?: number;
|
|
12959
14629
|
};
|
|
12960
14630
|
path: {
|
|
12961
|
-
|
|
14631
|
+
store_public_id: string;
|
|
12962
14632
|
};
|
|
12963
14633
|
cookie?: never;
|
|
12964
14634
|
};
|
|
12965
|
-
requestBody?:
|
|
14635
|
+
requestBody?: {
|
|
14636
|
+
content: {
|
|
14637
|
+
"application/json": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
14638
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
14639
|
+
"multipart/form-data": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
14640
|
+
};
|
|
14641
|
+
};
|
|
12966
14642
|
responses: {
|
|
12967
|
-
/** @description No response body */
|
|
12968
14643
|
200: {
|
|
12969
14644
|
headers: {
|
|
12970
14645
|
[name: string]: unknown;
|
|
12971
14646
|
};
|
|
12972
|
-
content
|
|
14647
|
+
content: {
|
|
14648
|
+
"application/json": components["schemas"]["AdminStoreComplianceDefaults"];
|
|
14649
|
+
};
|
|
12973
14650
|
};
|
|
12974
14651
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
12975
14652
|
400: {
|
|
@@ -12977,7 +14654,7 @@ interface operations {
|
|
|
12977
14654
|
[name: string]: unknown;
|
|
12978
14655
|
};
|
|
12979
14656
|
content: {
|
|
12980
|
-
"application/json": components["schemas"]["
|
|
14657
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
12981
14658
|
};
|
|
12982
14659
|
};
|
|
12983
14660
|
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13027,26 +14704,32 @@ interface operations {
|
|
|
13027
14704
|
};
|
|
13028
14705
|
};
|
|
13029
14706
|
};
|
|
13030
|
-
|
|
14707
|
+
admin_stores_compliance_schema_retrieve: {
|
|
13031
14708
|
parameters: {
|
|
13032
|
-
query
|
|
14709
|
+
query: {
|
|
14710
|
+
/** @description Language code for translated labels. Defaults to 'en'. */
|
|
14711
|
+
lang?: string;
|
|
14712
|
+
/** @description ProductType slug, e.g. 'product' or 'food-product' (products.constants.PLATFORM_PRODUCT_TYPES). */
|
|
14713
|
+
product_type: string;
|
|
14714
|
+
};
|
|
13033
14715
|
header?: {
|
|
13034
14716
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13035
14717
|
"X-Sous-Company-Id"?: number;
|
|
13036
14718
|
};
|
|
13037
14719
|
path: {
|
|
13038
|
-
|
|
14720
|
+
store_public_id: string;
|
|
13039
14721
|
};
|
|
13040
14722
|
cookie?: never;
|
|
13041
14723
|
};
|
|
13042
14724
|
requestBody?: never;
|
|
13043
14725
|
responses: {
|
|
13044
|
-
|
|
13045
|
-
204: {
|
|
14726
|
+
200: {
|
|
13046
14727
|
headers: {
|
|
13047
14728
|
[name: string]: unknown;
|
|
13048
14729
|
};
|
|
13049
|
-
content
|
|
14730
|
+
content: {
|
|
14731
|
+
"application/json": components["schemas"]["ComplianceSchemaResponse"];
|
|
14732
|
+
};
|
|
13050
14733
|
};
|
|
13051
14734
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13052
14735
|
400: {
|
|
@@ -13104,7 +14787,7 @@ interface operations {
|
|
|
13104
14787
|
};
|
|
13105
14788
|
};
|
|
13106
14789
|
};
|
|
13107
|
-
|
|
14790
|
+
admin_stores_delivery_areas_list: {
|
|
13108
14791
|
parameters: {
|
|
13109
14792
|
query?: never;
|
|
13110
14793
|
header?: {
|
|
@@ -13112,24 +14795,18 @@ interface operations {
|
|
|
13112
14795
|
"X-Sous-Company-Id"?: number;
|
|
13113
14796
|
};
|
|
13114
14797
|
path: {
|
|
13115
|
-
|
|
14798
|
+
store_public_id: string;
|
|
13116
14799
|
};
|
|
13117
14800
|
cookie?: never;
|
|
13118
14801
|
};
|
|
13119
|
-
requestBody
|
|
13120
|
-
content: {
|
|
13121
|
-
"application/json": components["schemas"]["AdminProductSurchargesRequest"];
|
|
13122
|
-
"application/x-www-form-urlencoded": components["schemas"]["AdminProductSurchargesRequest"];
|
|
13123
|
-
"multipart/form-data": components["schemas"]["AdminProductSurchargesRequest"];
|
|
13124
|
-
};
|
|
13125
|
-
};
|
|
14802
|
+
requestBody?: never;
|
|
13126
14803
|
responses: {
|
|
13127
14804
|
200: {
|
|
13128
14805
|
headers: {
|
|
13129
14806
|
[name: string]: unknown;
|
|
13130
14807
|
};
|
|
13131
14808
|
content: {
|
|
13132
|
-
"application/json": components["schemas"]["
|
|
14809
|
+
"application/json": components["schemas"]["DeliveryArea"][];
|
|
13133
14810
|
};
|
|
13134
14811
|
};
|
|
13135
14812
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13188,30 +14865,32 @@ interface operations {
|
|
|
13188
14865
|
};
|
|
13189
14866
|
};
|
|
13190
14867
|
};
|
|
13191
|
-
|
|
14868
|
+
admin_stores_delivery_areas_create: {
|
|
13192
14869
|
parameters: {
|
|
13193
14870
|
query?: never;
|
|
13194
14871
|
header?: {
|
|
13195
14872
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13196
14873
|
"X-Sous-Company-Id"?: number;
|
|
13197
14874
|
};
|
|
13198
|
-
path
|
|
14875
|
+
path: {
|
|
14876
|
+
store_public_id: string;
|
|
14877
|
+
};
|
|
13199
14878
|
cookie?: never;
|
|
13200
14879
|
};
|
|
13201
14880
|
requestBody: {
|
|
13202
14881
|
content: {
|
|
13203
|
-
"application/json": components["schemas"]["
|
|
13204
|
-
"application/x-www-form-urlencoded": components["schemas"]["
|
|
13205
|
-
"multipart/form-data": components["schemas"]["
|
|
14882
|
+
"application/json": components["schemas"]["DeliveryArea"];
|
|
14883
|
+
"application/x-www-form-urlencoded": components["schemas"]["DeliveryArea"];
|
|
14884
|
+
"multipart/form-data": components["schemas"]["DeliveryArea"];
|
|
13206
14885
|
};
|
|
13207
14886
|
};
|
|
13208
14887
|
responses: {
|
|
13209
|
-
|
|
14888
|
+
201: {
|
|
13210
14889
|
headers: {
|
|
13211
14890
|
[name: string]: unknown;
|
|
13212
14891
|
};
|
|
13213
14892
|
content: {
|
|
13214
|
-
"application/json": components["schemas"]["
|
|
14893
|
+
"application/json": components["schemas"]["DeliveryArea"];
|
|
13215
14894
|
};
|
|
13216
14895
|
};
|
|
13217
14896
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13270,28 +14949,27 @@ interface operations {
|
|
|
13270
14949
|
};
|
|
13271
14950
|
};
|
|
13272
14951
|
};
|
|
13273
|
-
|
|
14952
|
+
admin_stores_delivery_areas_destroy: {
|
|
13274
14953
|
parameters: {
|
|
13275
|
-
query?:
|
|
13276
|
-
/** @description The pagination cursor value. */
|
|
13277
|
-
cursor?: string;
|
|
13278
|
-
};
|
|
14954
|
+
query?: never;
|
|
13279
14955
|
header?: {
|
|
13280
14956
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13281
14957
|
"X-Sous-Company-Id"?: number;
|
|
13282
14958
|
};
|
|
13283
|
-
path
|
|
14959
|
+
path: {
|
|
14960
|
+
shape_id: string;
|
|
14961
|
+
store_public_id: string;
|
|
14962
|
+
};
|
|
13284
14963
|
cookie?: never;
|
|
13285
14964
|
};
|
|
13286
14965
|
requestBody?: never;
|
|
13287
14966
|
responses: {
|
|
13288
|
-
|
|
14967
|
+
/** @description No response body */
|
|
14968
|
+
204: {
|
|
13289
14969
|
headers: {
|
|
13290
14970
|
[name: string]: unknown;
|
|
13291
14971
|
};
|
|
13292
|
-
content
|
|
13293
|
-
"application/json": components["schemas"]["PaginatedAdminPromotionList"];
|
|
13294
|
-
};
|
|
14972
|
+
content?: never;
|
|
13295
14973
|
};
|
|
13296
14974
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
13297
14975
|
400: {
|
|
@@ -13349,21 +15027,24 @@ interface operations {
|
|
|
13349
15027
|
};
|
|
13350
15028
|
};
|
|
13351
15029
|
};
|
|
13352
|
-
|
|
15030
|
+
admin_stores_delivery_areas_partial_update: {
|
|
13353
15031
|
parameters: {
|
|
13354
15032
|
query?: never;
|
|
13355
15033
|
header?: {
|
|
13356
15034
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13357
15035
|
"X-Sous-Company-Id"?: number;
|
|
13358
15036
|
};
|
|
13359
|
-
path
|
|
15037
|
+
path: {
|
|
15038
|
+
shape_id: string;
|
|
15039
|
+
store_public_id: string;
|
|
15040
|
+
};
|
|
13360
15041
|
cookie?: never;
|
|
13361
15042
|
};
|
|
13362
|
-
requestBody
|
|
15043
|
+
requestBody?: {
|
|
13363
15044
|
content: {
|
|
13364
|
-
"application/json": components["schemas"]["
|
|
13365
|
-
"application/x-www-form-urlencoded": components["schemas"]["
|
|
13366
|
-
"multipart/form-data": components["schemas"]["
|
|
15045
|
+
"application/json": components["schemas"]["PatchedDeliveryAreaUpdate"];
|
|
15046
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryAreaUpdate"];
|
|
15047
|
+
"multipart/form-data": components["schemas"]["PatchedDeliveryAreaUpdate"];
|
|
13367
15048
|
};
|
|
13368
15049
|
};
|
|
13369
15050
|
responses: {
|
|
@@ -13372,7 +15053,7 @@ interface operations {
|
|
|
13372
15053
|
[name: string]: unknown;
|
|
13373
15054
|
};
|
|
13374
15055
|
content: {
|
|
13375
|
-
"application/json": components["schemas"]["
|
|
15056
|
+
"application/json": components["schemas"]["DeliveryArea"];
|
|
13376
15057
|
};
|
|
13377
15058
|
};
|
|
13378
15059
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13431,7 +15112,7 @@ interface operations {
|
|
|
13431
15112
|
};
|
|
13432
15113
|
};
|
|
13433
15114
|
};
|
|
13434
|
-
|
|
15115
|
+
admin_stores_delivery_exclusions_list: {
|
|
13435
15116
|
parameters: {
|
|
13436
15117
|
query?: never;
|
|
13437
15118
|
header?: {
|
|
@@ -13439,8 +15120,7 @@ interface operations {
|
|
|
13439
15120
|
"X-Sous-Company-Id"?: number;
|
|
13440
15121
|
};
|
|
13441
15122
|
path: {
|
|
13442
|
-
|
|
13443
|
-
id: number;
|
|
15123
|
+
store_public_id: string;
|
|
13444
15124
|
};
|
|
13445
15125
|
cookie?: never;
|
|
13446
15126
|
};
|
|
@@ -13451,7 +15131,7 @@ interface operations {
|
|
|
13451
15131
|
[name: string]: unknown;
|
|
13452
15132
|
};
|
|
13453
15133
|
content: {
|
|
13454
|
-
"application/json": components["schemas"]["
|
|
15134
|
+
"application/json": components["schemas"]["DeliveryExclusion"][];
|
|
13455
15135
|
};
|
|
13456
15136
|
};
|
|
13457
15137
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13510,7 +15190,7 @@ interface operations {
|
|
|
13510
15190
|
};
|
|
13511
15191
|
};
|
|
13512
15192
|
};
|
|
13513
|
-
|
|
15193
|
+
admin_stores_delivery_exclusions_create: {
|
|
13514
15194
|
parameters: {
|
|
13515
15195
|
query?: never;
|
|
13516
15196
|
header?: {
|
|
@@ -13518,25 +15198,24 @@ interface operations {
|
|
|
13518
15198
|
"X-Sous-Company-Id"?: number;
|
|
13519
15199
|
};
|
|
13520
15200
|
path: {
|
|
13521
|
-
|
|
13522
|
-
id: number;
|
|
15201
|
+
store_public_id: string;
|
|
13523
15202
|
};
|
|
13524
15203
|
cookie?: never;
|
|
13525
15204
|
};
|
|
13526
15205
|
requestBody: {
|
|
13527
15206
|
content: {
|
|
13528
|
-
"application/json": components["schemas"]["
|
|
13529
|
-
"application/x-www-form-urlencoded": components["schemas"]["
|
|
13530
|
-
"multipart/form-data": components["schemas"]["
|
|
15207
|
+
"application/json": components["schemas"]["DeliveryExclusion"];
|
|
15208
|
+
"application/x-www-form-urlencoded": components["schemas"]["DeliveryExclusion"];
|
|
15209
|
+
"multipart/form-data": components["schemas"]["DeliveryExclusion"];
|
|
13531
15210
|
};
|
|
13532
15211
|
};
|
|
13533
15212
|
responses: {
|
|
13534
|
-
|
|
15213
|
+
201: {
|
|
13535
15214
|
headers: {
|
|
13536
15215
|
[name: string]: unknown;
|
|
13537
15216
|
};
|
|
13538
15217
|
content: {
|
|
13539
|
-
"application/json": components["schemas"]["
|
|
15218
|
+
"application/json": components["schemas"]["DeliveryExclusion"];
|
|
13540
15219
|
};
|
|
13541
15220
|
};
|
|
13542
15221
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13595,7 +15274,7 @@ interface operations {
|
|
|
13595
15274
|
};
|
|
13596
15275
|
};
|
|
13597
15276
|
};
|
|
13598
|
-
|
|
15277
|
+
admin_stores_delivery_exclusions_destroy: {
|
|
13599
15278
|
parameters: {
|
|
13600
15279
|
query?: never;
|
|
13601
15280
|
header?: {
|
|
@@ -13603,8 +15282,8 @@ interface operations {
|
|
|
13603
15282
|
"X-Sous-Company-Id"?: number;
|
|
13604
15283
|
};
|
|
13605
15284
|
path: {
|
|
13606
|
-
|
|
13607
|
-
|
|
15285
|
+
shape_id: string;
|
|
15286
|
+
store_public_id: string;
|
|
13608
15287
|
};
|
|
13609
15288
|
cookie?: never;
|
|
13610
15289
|
};
|
|
@@ -13673,7 +15352,7 @@ interface operations {
|
|
|
13673
15352
|
};
|
|
13674
15353
|
};
|
|
13675
15354
|
};
|
|
13676
|
-
|
|
15355
|
+
admin_stores_delivery_exclusions_partial_update: {
|
|
13677
15356
|
parameters: {
|
|
13678
15357
|
query?: never;
|
|
13679
15358
|
header?: {
|
|
@@ -13681,16 +15360,16 @@ interface operations {
|
|
|
13681
15360
|
"X-Sous-Company-Id"?: number;
|
|
13682
15361
|
};
|
|
13683
15362
|
path: {
|
|
13684
|
-
|
|
13685
|
-
|
|
15363
|
+
shape_id: string;
|
|
15364
|
+
store_public_id: string;
|
|
13686
15365
|
};
|
|
13687
15366
|
cookie?: never;
|
|
13688
15367
|
};
|
|
13689
15368
|
requestBody?: {
|
|
13690
15369
|
content: {
|
|
13691
|
-
"application/json": components["schemas"]["
|
|
13692
|
-
"application/x-www-form-urlencoded": components["schemas"]["
|
|
13693
|
-
"multipart/form-data": components["schemas"]["
|
|
15370
|
+
"application/json": components["schemas"]["PatchedDeliveryExclusionUpdate"];
|
|
15371
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedDeliveryExclusionUpdate"];
|
|
15372
|
+
"multipart/form-data": components["schemas"]["PatchedDeliveryExclusionUpdate"];
|
|
13694
15373
|
};
|
|
13695
15374
|
};
|
|
13696
15375
|
responses: {
|
|
@@ -13699,7 +15378,7 @@ interface operations {
|
|
|
13699
15378
|
[name: string]: unknown;
|
|
13700
15379
|
};
|
|
13701
15380
|
content: {
|
|
13702
|
-
"application/json": components["schemas"]["
|
|
15381
|
+
"application/json": components["schemas"]["DeliveryExclusion"];
|
|
13703
15382
|
};
|
|
13704
15383
|
};
|
|
13705
15384
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13758,14 +15437,16 @@ interface operations {
|
|
|
13758
15437
|
};
|
|
13759
15438
|
};
|
|
13760
15439
|
};
|
|
13761
|
-
|
|
15440
|
+
admin_stores_delivery_fee_retrieve: {
|
|
13762
15441
|
parameters: {
|
|
13763
15442
|
query?: never;
|
|
13764
15443
|
header?: {
|
|
13765
15444
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
13766
15445
|
"X-Sous-Company-Id"?: number;
|
|
13767
15446
|
};
|
|
13768
|
-
path
|
|
15447
|
+
path: {
|
|
15448
|
+
store_public_id: string;
|
|
15449
|
+
};
|
|
13769
15450
|
cookie?: never;
|
|
13770
15451
|
};
|
|
13771
15452
|
requestBody?: never;
|
|
@@ -13775,7 +15456,7 @@ interface operations {
|
|
|
13775
15456
|
[name: string]: unknown;
|
|
13776
15457
|
};
|
|
13777
15458
|
content: {
|
|
13778
|
-
"application/json": components["schemas"]["
|
|
15459
|
+
"application/json": components["schemas"]["DeliveryFee"];
|
|
13779
15460
|
};
|
|
13780
15461
|
};
|
|
13781
15462
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13834,7 +15515,7 @@ interface operations {
|
|
|
13834
15515
|
};
|
|
13835
15516
|
};
|
|
13836
15517
|
};
|
|
13837
|
-
|
|
15518
|
+
admin_stores_delivery_fee_update: {
|
|
13838
15519
|
parameters: {
|
|
13839
15520
|
query?: never;
|
|
13840
15521
|
header?: {
|
|
@@ -13846,14 +15527,20 @@ interface operations {
|
|
|
13846
15527
|
};
|
|
13847
15528
|
cookie?: never;
|
|
13848
15529
|
};
|
|
13849
|
-
requestBody
|
|
15530
|
+
requestBody: {
|
|
15531
|
+
content: {
|
|
15532
|
+
"application/json": components["schemas"]["DeliveryFee"];
|
|
15533
|
+
"application/x-www-form-urlencoded": components["schemas"]["DeliveryFee"];
|
|
15534
|
+
"multipart/form-data": components["schemas"]["DeliveryFee"];
|
|
15535
|
+
};
|
|
15536
|
+
};
|
|
13850
15537
|
responses: {
|
|
13851
15538
|
200: {
|
|
13852
15539
|
headers: {
|
|
13853
15540
|
[name: string]: unknown;
|
|
13854
15541
|
};
|
|
13855
15542
|
content: {
|
|
13856
|
-
"application/json": components["schemas"]["
|
|
15543
|
+
"application/json": components["schemas"]["DeliveryFee"];
|
|
13857
15544
|
};
|
|
13858
15545
|
};
|
|
13859
15546
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13912,7 +15599,7 @@ interface operations {
|
|
|
13912
15599
|
};
|
|
13913
15600
|
};
|
|
13914
15601
|
};
|
|
13915
|
-
|
|
15602
|
+
admin_stores_delivery_fee_split_retrieve: {
|
|
13916
15603
|
parameters: {
|
|
13917
15604
|
query?: never;
|
|
13918
15605
|
header?: {
|
|
@@ -13924,20 +15611,14 @@ interface operations {
|
|
|
13924
15611
|
};
|
|
13925
15612
|
cookie?: never;
|
|
13926
15613
|
};
|
|
13927
|
-
requestBody?:
|
|
13928
|
-
content: {
|
|
13929
|
-
"application/json": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
13930
|
-
"application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
13931
|
-
"multipart/form-data": components["schemas"]["PatchedAdminStoreComplianceDefaults"];
|
|
13932
|
-
};
|
|
13933
|
-
};
|
|
15614
|
+
requestBody?: never;
|
|
13934
15615
|
responses: {
|
|
13935
15616
|
200: {
|
|
13936
15617
|
headers: {
|
|
13937
15618
|
[name: string]: unknown;
|
|
13938
15619
|
};
|
|
13939
15620
|
content: {
|
|
13940
|
-
"application/json": components["schemas"]["
|
|
15621
|
+
"application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
|
|
13941
15622
|
};
|
|
13942
15623
|
};
|
|
13943
15624
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -13996,14 +15677,9 @@ interface operations {
|
|
|
13996
15677
|
};
|
|
13997
15678
|
};
|
|
13998
15679
|
};
|
|
13999
|
-
|
|
15680
|
+
admin_stores_delivery_fee_split_partial_update: {
|
|
14000
15681
|
parameters: {
|
|
14001
|
-
query
|
|
14002
|
-
/** @description Language code for translated labels. Defaults to 'en'. */
|
|
14003
|
-
lang?: string;
|
|
14004
|
-
/** @description ProductType slug, e.g. 'product' or 'food-product' (products.constants.PLATFORM_PRODUCT_TYPES). */
|
|
14005
|
-
product_type: string;
|
|
14006
|
-
};
|
|
15682
|
+
query?: never;
|
|
14007
15683
|
header?: {
|
|
14008
15684
|
/** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
|
|
14009
15685
|
"X-Sous-Company-Id"?: number;
|
|
@@ -14013,14 +15689,20 @@ interface operations {
|
|
|
14013
15689
|
};
|
|
14014
15690
|
cookie?: never;
|
|
14015
15691
|
};
|
|
14016
|
-
requestBody?:
|
|
15692
|
+
requestBody?: {
|
|
15693
|
+
content: {
|
|
15694
|
+
"application/json": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
|
|
15695
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
|
|
15696
|
+
"multipart/form-data": components["schemas"]["PatchedAdminStoreDeliveryFeeSplit"];
|
|
15697
|
+
};
|
|
15698
|
+
};
|
|
14017
15699
|
responses: {
|
|
14018
15700
|
200: {
|
|
14019
15701
|
headers: {
|
|
14020
15702
|
[name: string]: unknown;
|
|
14021
15703
|
};
|
|
14022
15704
|
content: {
|
|
14023
|
-
"application/json": components["schemas"]["
|
|
15705
|
+
"application/json": components["schemas"]["AdminStoreDeliveryFeeSplit"];
|
|
14024
15706
|
};
|
|
14025
15707
|
};
|
|
14026
15708
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
@@ -19245,6 +20927,107 @@ interface operations {
|
|
|
19245
20927
|
};
|
|
19246
20928
|
};
|
|
19247
20929
|
};
|
|
20930
|
+
checkout_marketing_consent_partial_update: {
|
|
20931
|
+
parameters: {
|
|
20932
|
+
query?: never;
|
|
20933
|
+
header?: never;
|
|
20934
|
+
path: {
|
|
20935
|
+
checkout_id: string;
|
|
20936
|
+
};
|
|
20937
|
+
cookie?: never;
|
|
20938
|
+
};
|
|
20939
|
+
requestBody?: {
|
|
20940
|
+
content: {
|
|
20941
|
+
"application/json": components["schemas"]["PatchedMarketingConsentInput"];
|
|
20942
|
+
"application/x-www-form-urlencoded": components["schemas"]["PatchedMarketingConsentInput"];
|
|
20943
|
+
"multipart/form-data": components["schemas"]["PatchedMarketingConsentInput"];
|
|
20944
|
+
};
|
|
20945
|
+
};
|
|
20946
|
+
responses: {
|
|
20947
|
+
200: {
|
|
20948
|
+
headers: {
|
|
20949
|
+
[name: string]: unknown;
|
|
20950
|
+
};
|
|
20951
|
+
content: {
|
|
20952
|
+
"application/json": {
|
|
20953
|
+
[key: string]: unknown;
|
|
20954
|
+
};
|
|
20955
|
+
};
|
|
20956
|
+
};
|
|
20957
|
+
/** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
20958
|
+
400: {
|
|
20959
|
+
headers: {
|
|
20960
|
+
[name: string]: unknown;
|
|
20961
|
+
};
|
|
20962
|
+
content: {
|
|
20963
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
20964
|
+
};
|
|
20965
|
+
};
|
|
20966
|
+
/** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
20967
|
+
401: {
|
|
20968
|
+
headers: {
|
|
20969
|
+
[name: string]: unknown;
|
|
20970
|
+
};
|
|
20971
|
+
content: {
|
|
20972
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
20973
|
+
};
|
|
20974
|
+
};
|
|
20975
|
+
/** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
20976
|
+
403: {
|
|
20977
|
+
headers: {
|
|
20978
|
+
[name: string]: unknown;
|
|
20979
|
+
};
|
|
20980
|
+
content: {
|
|
20981
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
20982
|
+
};
|
|
20983
|
+
};
|
|
20984
|
+
/** @description Possible error codes: `CHECKOUT_NOT_FOUND`. Retryable: no. Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_GROUP_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_RATE_NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
20985
|
+
404: {
|
|
20986
|
+
headers: {
|
|
20987
|
+
[name: string]: unknown;
|
|
20988
|
+
};
|
|
20989
|
+
content: {
|
|
20990
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
20991
|
+
};
|
|
20992
|
+
};
|
|
20993
|
+
/** @description Possible error codes: `CHECKOUT_INVALID_STATUS`. Retryable: no. Possible error codes include `CHECKOUT_INVALID_STATUS`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PAYMENT_IN_FLIGHT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `store_closed_for_date`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
20994
|
+
409: {
|
|
20995
|
+
headers: {
|
|
20996
|
+
[name: string]: unknown;
|
|
20997
|
+
};
|
|
20998
|
+
content: {
|
|
20999
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
21000
|
+
};
|
|
21001
|
+
};
|
|
21002
|
+
/** @description Possible error codes include `SHIPPING_RATE_EXPIRED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
21003
|
+
410: {
|
|
21004
|
+
headers: {
|
|
21005
|
+
[name: string]: unknown;
|
|
21006
|
+
};
|
|
21007
|
+
content: {
|
|
21008
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
21009
|
+
};
|
|
21010
|
+
};
|
|
21011
|
+
/** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MERCHANT_AT_CAPACITY`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
21012
|
+
429: {
|
|
21013
|
+
headers: {
|
|
21014
|
+
[name: string]: unknown;
|
|
21015
|
+
};
|
|
21016
|
+
content: {
|
|
21017
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
21018
|
+
};
|
|
21019
|
+
};
|
|
21020
|
+
/** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
21021
|
+
500: {
|
|
21022
|
+
headers: {
|
|
21023
|
+
[name: string]: unknown;
|
|
21024
|
+
};
|
|
21025
|
+
content: {
|
|
21026
|
+
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
21027
|
+
};
|
|
21028
|
+
};
|
|
21029
|
+
};
|
|
21030
|
+
};
|
|
19248
21031
|
checkout_packaging_choice_create: {
|
|
19249
21032
|
parameters: {
|
|
19250
21033
|
query?: never;
|
|
@@ -19373,7 +21156,7 @@ interface operations {
|
|
|
19373
21156
|
};
|
|
19374
21157
|
};
|
|
19375
21158
|
};
|
|
19376
|
-
/** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
21159
|
+
/** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
19377
21160
|
400: {
|
|
19378
21161
|
headers: {
|
|
19379
21162
|
[name: string]: unknown;
|
|
@@ -25863,7 +27646,7 @@ interface operations {
|
|
|
25863
27646
|
[name: string]: unknown;
|
|
25864
27647
|
};
|
|
25865
27648
|
content: {
|
|
25866
|
-
"application/json": components["schemas"]["
|
|
27649
|
+
"application/json": components["schemas"]["StorePublishResponse"];
|
|
25867
27650
|
};
|
|
25868
27651
|
};
|
|
25869
27652
|
/** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
|