@poweredbysous/storefront-sdk 3.4.0 → 3.5.1
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 +67 -19
- package/dist/index.d.ts +67 -19
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -173,9 +173,10 @@ interface paths {
|
|
|
173
173
|
* non-sensitive routing data is returned (public_id, name, URL slug,
|
|
174
174
|
* currency); catalogue and write endpoints remain store-scoped and signed.
|
|
175
175
|
*
|
|
176
|
-
* Stores with no active pickup location are
|
|
177
|
-
*
|
|
178
|
-
*
|
|
176
|
+
* Stores with no active pickup location are listed only when they are set up
|
|
177
|
+
* to deliver (an active delivery carrier, or an onboarding or store config that
|
|
178
|
+
* offers delivery), with a null address, coordinates and open status. The rest
|
|
179
|
+
* can't be ordered from, so they are omitted.
|
|
179
180
|
*/
|
|
180
181
|
get: operations["brand_locations_list"];
|
|
181
182
|
put?: never;
|
|
@@ -2591,6 +2592,11 @@ interface components {
|
|
|
2591
2592
|
/** @description Validates the request body for applying a discount code to a cart. */
|
|
2592
2593
|
ApplyDiscountInput: {
|
|
2593
2594
|
code: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* Format: uuid
|
|
2597
|
+
* @description Storefront CustomerProfile.id of the logged-in customer, as sent when creating the checkout, so the code is held to its per-customer limit from the cart onwards. Omitted for guests.
|
|
2598
|
+
*/
|
|
2599
|
+
customer_profile_id?: string | null;
|
|
2594
2600
|
};
|
|
2595
2601
|
/** @description Validates a gift card redemption request on a checkout. */
|
|
2596
2602
|
ApplyGiftCardInput: {
|
|
@@ -2661,11 +2667,10 @@ interface components {
|
|
|
2661
2667
|
/**
|
|
2662
2668
|
* @description One sellable location in a brand/company's storefront discovery list.
|
|
2663
2669
|
*
|
|
2664
|
-
*
|
|
2665
|
-
*
|
|
2666
|
-
*
|
|
2667
|
-
* geocoding is unavailable
|
|
2668
|
-
* for the schema. The storefront uses the coordinates to snap a customer's
|
|
2670
|
+
* A location without an active pickup location is listed only when it is set
|
|
2671
|
+
* up to deliver, and then ``address``, ``latitude``, ``longitude`` and
|
|
2672
|
+
* ``open_status`` are all null. ``latitude``/``longitude`` are also null when
|
|
2673
|
+
* geocoding is unavailable. The storefront uses the coordinates to snap a customer's
|
|
2669
2674
|
* delivery address to the nearest location, and the address for the manual
|
|
2670
2675
|
* location picker.
|
|
2671
2676
|
*/
|
|
@@ -2746,6 +2751,7 @@ interface components {
|
|
|
2746
2751
|
readonly discount: {
|
|
2747
2752
|
[key: string]: unknown;
|
|
2748
2753
|
} | null;
|
|
2754
|
+
readonly discount_notice: components["schemas"]["CartDiscountNotice"] | null;
|
|
2749
2755
|
readonly promotion: {
|
|
2750
2756
|
[key: string]: unknown;
|
|
2751
2757
|
} | null;
|
|
@@ -2756,6 +2762,7 @@ interface components {
|
|
|
2756
2762
|
* @description Last computed full shipping estimate (before delivery fee split). NULL means no estimate has been computed — which is not the same as an estimate of zero, and must never be read as free delivery.
|
|
2757
2763
|
*/
|
|
2758
2764
|
estimated_shipping_cost?: string | null;
|
|
2765
|
+
readonly delivery_address: components["schemas"]["CartDeliveryAddress"] | null;
|
|
2759
2766
|
readonly service_fees: {
|
|
2760
2767
|
/**
|
|
2761
2768
|
* Format: decimal
|
|
@@ -2778,10 +2785,13 @@ interface components {
|
|
|
2778
2785
|
}[];
|
|
2779
2786
|
};
|
|
2780
2787
|
/**
|
|
2781
|
-
* @description
|
|
2788
|
+
* @description What checkout will charge for this basket, before gift cards and
|
|
2789
|
+
* Zeemijlen: the items, surcharges, delivery fee and service fee, less
|
|
2790
|
+
* discounts. Leaves out only a delivery fee not priced yet, which
|
|
2791
|
+
* ``service_fees.estimated`` says.
|
|
2782
2792
|
*
|
|
2783
|
-
*
|
|
2784
|
-
*
|
|
2793
|
+
* Totalled by ``order_total_before_points``, the formula checkout
|
|
2794
|
+
* totals with, so the cart total is the checkout total.
|
|
2785
2795
|
*/
|
|
2786
2796
|
readonly estimated_total: string;
|
|
2787
2797
|
/**
|
|
@@ -2801,6 +2811,37 @@ interface components {
|
|
|
2801
2811
|
/** Format: date-time */
|
|
2802
2812
|
expires_at: string;
|
|
2803
2813
|
};
|
|
2814
|
+
/**
|
|
2815
|
+
* @description Where the shopper wants delivery, as the shipping estimate reads it.
|
|
2816
|
+
*
|
|
2817
|
+
* Given with the fulfilment choice, before the first item, so every cart
|
|
2818
|
+
* response carries the delivery fee checkout will charge (price
|
|
2819
|
+
* transparency). The same fields a cart GET takes as query parameters.
|
|
2820
|
+
*/
|
|
2821
|
+
CartDeliveryAddress: {
|
|
2822
|
+
/** Format: decimal */
|
|
2823
|
+
latitude: string;
|
|
2824
|
+
/** Format: decimal */
|
|
2825
|
+
longitude: string;
|
|
2826
|
+
postal_code?: string;
|
|
2827
|
+
address_street?: string;
|
|
2828
|
+
address_city?: string;
|
|
2829
|
+
/** @description ISO 3166-1 alpha-2, case-insensitive. A nationwide carrier prices by country, so it is enough without a street and city; a live courier quote needs all three. */
|
|
2830
|
+
address_country?: string;
|
|
2831
|
+
};
|
|
2832
|
+
/**
|
|
2833
|
+
* @description A code the shopper typed that the cart has since taken off.
|
|
2834
|
+
*
|
|
2835
|
+
* Present from the recalculation that removed the code until the shopper
|
|
2836
|
+
* applies or removes a code. Documentation only: the payload is built by
|
|
2837
|
+
* ``CartSerializer.get_discount_notice``.
|
|
2838
|
+
*/
|
|
2839
|
+
CartDiscountNotice: {
|
|
2840
|
+
/** @description The code that was removed. */
|
|
2841
|
+
code: string;
|
|
2842
|
+
/** @description The error code saying why, e.g. DISCOUNT_CUSTOMER_LIMIT, DISCOUNT_EXPIRED, DISCOUNT_MIN_ORDER. */
|
|
2843
|
+
reason: string;
|
|
2844
|
+
};
|
|
2804
2845
|
/** @description Validates a single cart item for eligibility checks. */
|
|
2805
2846
|
CartItem: {
|
|
2806
2847
|
product_id: number;
|
|
@@ -3063,6 +3104,11 @@ interface components {
|
|
|
3063
3104
|
discount_amount: string;
|
|
3064
3105
|
discount_code: string | null;
|
|
3065
3106
|
discount_name: string | null;
|
|
3107
|
+
/** @description A code the shopper typed that the cart took off, and the error code why. */
|
|
3108
|
+
discount_notice: {
|
|
3109
|
+
code: string;
|
|
3110
|
+
reason: string;
|
|
3111
|
+
} | null;
|
|
3066
3112
|
applied_promotion_id: number | null;
|
|
3067
3113
|
promotion_discount_amount: string;
|
|
3068
3114
|
total: string;
|
|
@@ -4069,6 +4115,8 @@ interface components {
|
|
|
4069
4115
|
fulfillment_type?: components["schemas"]["FulfillmentTypeEnum"];
|
|
4070
4116
|
/** Format: date */
|
|
4071
4117
|
fulfillment_date?: string;
|
|
4118
|
+
/** @description The shopper's delivery address. Stored on the cart so every cart response prices the delivery fee; null forgets it, and leaving it out keeps the one already given. */
|
|
4119
|
+
delivery_address?: components["schemas"]["CartDeliveryAddress"] | null;
|
|
4072
4120
|
};
|
|
4073
4121
|
/** @description Validates the request body for updating a line item quantity. */
|
|
4074
4122
|
PatchedUpdateItemQuantityInput: {
|
|
@@ -6088,7 +6136,7 @@ interface operations {
|
|
|
6088
6136
|
address_country?: string;
|
|
6089
6137
|
/** @description Delivery destination street line. Required together with address_city and address_country to trigger a live shipping quote (e.g. from Uber Direct); without all three the shipping_estimate group will report cost_known=false. */
|
|
6090
6138
|
address_street?: string;
|
|
6091
|
-
/** @description Delivery destination latitude. When paired with longitude, enables a per-group shipping estimate in the response. */
|
|
6139
|
+
/** @description Delivery destination latitude. When paired with longitude, enables a per-group shipping estimate in the response. Ignored, like every address parameter here, once the cart holds a `delivery_address` from the fulfilment PATCH. */
|
|
6092
6140
|
latitude?: number;
|
|
6093
6141
|
/** @description Delivery destination longitude. */
|
|
6094
6142
|
longitude?: number;
|
|
@@ -6203,7 +6251,7 @@ interface operations {
|
|
|
6203
6251
|
"application/json": components["schemas"]["Cart"];
|
|
6204
6252
|
};
|
|
6205
6253
|
};
|
|
6206
|
-
/** @description Possible error codes: `DISCOUNT_INVALID`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CART_MAX_ITEMS_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_INVALID_QUANTITY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_MAX_QUANTITY_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_SOLD_OUT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `OPTION_INVALID_FOR_PRODUCT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `REQUIRED_OPTIONS_MISSING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `FULFILLMENT_TYPE_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_INVALID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_NOT_ALLOWED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6254
|
+
/** @description Possible error codes: `DISCOUNT_INVALID`, `DISCOUNT_CUSTOMER_LIMIT`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CART_MAX_ITEMS_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_INVALID_QUANTITY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_MAX_QUANTITY_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_SOLD_OUT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `OPTION_INVALID_FOR_PRODUCT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `REQUIRED_OPTIONS_MISSING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `FULFILLMENT_TYPE_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_INVALID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_NOT_ALLOWED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6207
6255
|
400: {
|
|
6208
6256
|
headers: {
|
|
6209
6257
|
[name: string]: unknown;
|
|
@@ -7667,7 +7715,7 @@ interface operations {
|
|
|
7667
7715
|
"application/json": components["schemas"]["Checkout"];
|
|
7668
7716
|
};
|
|
7669
7717
|
};
|
|
7670
|
-
/** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7718
|
+
/** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `PRODUCT_UNAVAILABLE`, `DISCOUNT_CUSTOMER_LIMIT`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7671
7719
|
400: {
|
|
7672
7720
|
headers: {
|
|
7673
7721
|
[name: string]: unknown;
|
|
@@ -7870,7 +7918,7 @@ interface operations {
|
|
|
7870
7918
|
};
|
|
7871
7919
|
};
|
|
7872
7920
|
};
|
|
7873
|
-
/** @description 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7921
|
+
/** @description Possible error codes: `DISCOUNT_CUSTOMER_LIMIT`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7874
7922
|
400: {
|
|
7875
7923
|
headers: {
|
|
7876
7924
|
[name: string]: unknown;
|
|
@@ -7906,7 +7954,7 @@ interface operations {
|
|
|
7906
7954
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7907
7955
|
};
|
|
7908
7956
|
};
|
|
7909
|
-
/** @description 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7957
|
+
/** @description Possible error codes: `CHECKOUT_INVALID_STATUS`, `PAYMENT_IN_FLIGHT`. 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7910
7958
|
409: {
|
|
7911
7959
|
headers: {
|
|
7912
7960
|
[name: string]: unknown;
|
|
@@ -8487,7 +8535,7 @@ interface operations {
|
|
|
8487
8535
|
"application/json": components["schemas"]["Checkout"];
|
|
8488
8536
|
};
|
|
8489
8537
|
};
|
|
8490
|
-
/** @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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8538
|
+
/** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`, `DISCOUNT_CUSTOMER_LIMIT`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8491
8539
|
400: {
|
|
8492
8540
|
headers: {
|
|
8493
8541
|
[name: string]: unknown;
|
|
@@ -8884,7 +8932,7 @@ interface operations {
|
|
|
8884
8932
|
};
|
|
8885
8933
|
};
|
|
8886
8934
|
};
|
|
8887
|
-
/** @description Possible error codes: `MISSING_GATEWAY_ID`, `CHECKOUT_EMPTY`, `ZEEMIJLEN_IN_USE_ELSEWHERE`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`, `GIFT_CARD_HOLD_LAPSED`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8935
|
+
/** @description Possible error codes: `MISSING_GATEWAY_ID`, `CHECKOUT_EMPTY`, `ZEEMIJLEN_IN_USE_ELSEWHERE`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`, `DISCOUNT_CUSTOMER_LIMIT`, `GIFT_CARD_HOLD_LAPSED`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8888
8936
|
400: {
|
|
8889
8937
|
headers: {
|
|
8890
8938
|
[name: string]: unknown;
|
|
@@ -9315,7 +9363,7 @@ interface operations {
|
|
|
9315
9363
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9316
9364
|
};
|
|
9317
9365
|
};
|
|
9318
|
-
/** @description 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9366
|
+
/** @description Possible error codes: `CHECKOUT_INVALID_STATUS`, `PAYMENT_IN_FLIGHT`, `DISCOUNT_NOT_REMOVABLE`. 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9319
9367
|
409: {
|
|
9320
9368
|
headers: {
|
|
9321
9369
|
[name: string]: unknown;
|
package/dist/index.d.ts
CHANGED
|
@@ -173,9 +173,10 @@ interface paths {
|
|
|
173
173
|
* non-sensitive routing data is returned (public_id, name, URL slug,
|
|
174
174
|
* currency); catalogue and write endpoints remain store-scoped and signed.
|
|
175
175
|
*
|
|
176
|
-
* Stores with no active pickup location are
|
|
177
|
-
*
|
|
178
|
-
*
|
|
176
|
+
* Stores with no active pickup location are listed only when they are set up
|
|
177
|
+
* to deliver (an active delivery carrier, or an onboarding or store config that
|
|
178
|
+
* offers delivery), with a null address, coordinates and open status. The rest
|
|
179
|
+
* can't be ordered from, so they are omitted.
|
|
179
180
|
*/
|
|
180
181
|
get: operations["brand_locations_list"];
|
|
181
182
|
put?: never;
|
|
@@ -2591,6 +2592,11 @@ interface components {
|
|
|
2591
2592
|
/** @description Validates the request body for applying a discount code to a cart. */
|
|
2592
2593
|
ApplyDiscountInput: {
|
|
2593
2594
|
code: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* Format: uuid
|
|
2597
|
+
* @description Storefront CustomerProfile.id of the logged-in customer, as sent when creating the checkout, so the code is held to its per-customer limit from the cart onwards. Omitted for guests.
|
|
2598
|
+
*/
|
|
2599
|
+
customer_profile_id?: string | null;
|
|
2594
2600
|
};
|
|
2595
2601
|
/** @description Validates a gift card redemption request on a checkout. */
|
|
2596
2602
|
ApplyGiftCardInput: {
|
|
@@ -2661,11 +2667,10 @@ interface components {
|
|
|
2661
2667
|
/**
|
|
2662
2668
|
* @description One sellable location in a brand/company's storefront discovery list.
|
|
2663
2669
|
*
|
|
2664
|
-
*
|
|
2665
|
-
*
|
|
2666
|
-
*
|
|
2667
|
-
* geocoding is unavailable
|
|
2668
|
-
* for the schema. The storefront uses the coordinates to snap a customer's
|
|
2670
|
+
* A location without an active pickup location is listed only when it is set
|
|
2671
|
+
* up to deliver, and then ``address``, ``latitude``, ``longitude`` and
|
|
2672
|
+
* ``open_status`` are all null. ``latitude``/``longitude`` are also null when
|
|
2673
|
+
* geocoding is unavailable. The storefront uses the coordinates to snap a customer's
|
|
2669
2674
|
* delivery address to the nearest location, and the address for the manual
|
|
2670
2675
|
* location picker.
|
|
2671
2676
|
*/
|
|
@@ -2746,6 +2751,7 @@ interface components {
|
|
|
2746
2751
|
readonly discount: {
|
|
2747
2752
|
[key: string]: unknown;
|
|
2748
2753
|
} | null;
|
|
2754
|
+
readonly discount_notice: components["schemas"]["CartDiscountNotice"] | null;
|
|
2749
2755
|
readonly promotion: {
|
|
2750
2756
|
[key: string]: unknown;
|
|
2751
2757
|
} | null;
|
|
@@ -2756,6 +2762,7 @@ interface components {
|
|
|
2756
2762
|
* @description Last computed full shipping estimate (before delivery fee split). NULL means no estimate has been computed — which is not the same as an estimate of zero, and must never be read as free delivery.
|
|
2757
2763
|
*/
|
|
2758
2764
|
estimated_shipping_cost?: string | null;
|
|
2765
|
+
readonly delivery_address: components["schemas"]["CartDeliveryAddress"] | null;
|
|
2759
2766
|
readonly service_fees: {
|
|
2760
2767
|
/**
|
|
2761
2768
|
* Format: decimal
|
|
@@ -2778,10 +2785,13 @@ interface components {
|
|
|
2778
2785
|
}[];
|
|
2779
2786
|
};
|
|
2780
2787
|
/**
|
|
2781
|
-
* @description
|
|
2788
|
+
* @description What checkout will charge for this basket, before gift cards and
|
|
2789
|
+
* Zeemijlen: the items, surcharges, delivery fee and service fee, less
|
|
2790
|
+
* discounts. Leaves out only a delivery fee not priced yet, which
|
|
2791
|
+
* ``service_fees.estimated`` says.
|
|
2782
2792
|
*
|
|
2783
|
-
*
|
|
2784
|
-
*
|
|
2793
|
+
* Totalled by ``order_total_before_points``, the formula checkout
|
|
2794
|
+
* totals with, so the cart total is the checkout total.
|
|
2785
2795
|
*/
|
|
2786
2796
|
readonly estimated_total: string;
|
|
2787
2797
|
/**
|
|
@@ -2801,6 +2811,37 @@ interface components {
|
|
|
2801
2811
|
/** Format: date-time */
|
|
2802
2812
|
expires_at: string;
|
|
2803
2813
|
};
|
|
2814
|
+
/**
|
|
2815
|
+
* @description Where the shopper wants delivery, as the shipping estimate reads it.
|
|
2816
|
+
*
|
|
2817
|
+
* Given with the fulfilment choice, before the first item, so every cart
|
|
2818
|
+
* response carries the delivery fee checkout will charge (price
|
|
2819
|
+
* transparency). The same fields a cart GET takes as query parameters.
|
|
2820
|
+
*/
|
|
2821
|
+
CartDeliveryAddress: {
|
|
2822
|
+
/** Format: decimal */
|
|
2823
|
+
latitude: string;
|
|
2824
|
+
/** Format: decimal */
|
|
2825
|
+
longitude: string;
|
|
2826
|
+
postal_code?: string;
|
|
2827
|
+
address_street?: string;
|
|
2828
|
+
address_city?: string;
|
|
2829
|
+
/** @description ISO 3166-1 alpha-2, case-insensitive. A nationwide carrier prices by country, so it is enough without a street and city; a live courier quote needs all three. */
|
|
2830
|
+
address_country?: string;
|
|
2831
|
+
};
|
|
2832
|
+
/**
|
|
2833
|
+
* @description A code the shopper typed that the cart has since taken off.
|
|
2834
|
+
*
|
|
2835
|
+
* Present from the recalculation that removed the code until the shopper
|
|
2836
|
+
* applies or removes a code. Documentation only: the payload is built by
|
|
2837
|
+
* ``CartSerializer.get_discount_notice``.
|
|
2838
|
+
*/
|
|
2839
|
+
CartDiscountNotice: {
|
|
2840
|
+
/** @description The code that was removed. */
|
|
2841
|
+
code: string;
|
|
2842
|
+
/** @description The error code saying why, e.g. DISCOUNT_CUSTOMER_LIMIT, DISCOUNT_EXPIRED, DISCOUNT_MIN_ORDER. */
|
|
2843
|
+
reason: string;
|
|
2844
|
+
};
|
|
2804
2845
|
/** @description Validates a single cart item for eligibility checks. */
|
|
2805
2846
|
CartItem: {
|
|
2806
2847
|
product_id: number;
|
|
@@ -3063,6 +3104,11 @@ interface components {
|
|
|
3063
3104
|
discount_amount: string;
|
|
3064
3105
|
discount_code: string | null;
|
|
3065
3106
|
discount_name: string | null;
|
|
3107
|
+
/** @description A code the shopper typed that the cart took off, and the error code why. */
|
|
3108
|
+
discount_notice: {
|
|
3109
|
+
code: string;
|
|
3110
|
+
reason: string;
|
|
3111
|
+
} | null;
|
|
3066
3112
|
applied_promotion_id: number | null;
|
|
3067
3113
|
promotion_discount_amount: string;
|
|
3068
3114
|
total: string;
|
|
@@ -4069,6 +4115,8 @@ interface components {
|
|
|
4069
4115
|
fulfillment_type?: components["schemas"]["FulfillmentTypeEnum"];
|
|
4070
4116
|
/** Format: date */
|
|
4071
4117
|
fulfillment_date?: string;
|
|
4118
|
+
/** @description The shopper's delivery address. Stored on the cart so every cart response prices the delivery fee; null forgets it, and leaving it out keeps the one already given. */
|
|
4119
|
+
delivery_address?: components["schemas"]["CartDeliveryAddress"] | null;
|
|
4072
4120
|
};
|
|
4073
4121
|
/** @description Validates the request body for updating a line item quantity. */
|
|
4074
4122
|
PatchedUpdateItemQuantityInput: {
|
|
@@ -6088,7 +6136,7 @@ interface operations {
|
|
|
6088
6136
|
address_country?: string;
|
|
6089
6137
|
/** @description Delivery destination street line. Required together with address_city and address_country to trigger a live shipping quote (e.g. from Uber Direct); without all three the shipping_estimate group will report cost_known=false. */
|
|
6090
6138
|
address_street?: string;
|
|
6091
|
-
/** @description Delivery destination latitude. When paired with longitude, enables a per-group shipping estimate in the response. */
|
|
6139
|
+
/** @description Delivery destination latitude. When paired with longitude, enables a per-group shipping estimate in the response. Ignored, like every address parameter here, once the cart holds a `delivery_address` from the fulfilment PATCH. */
|
|
6092
6140
|
latitude?: number;
|
|
6093
6141
|
/** @description Delivery destination longitude. */
|
|
6094
6142
|
longitude?: number;
|
|
@@ -6203,7 +6251,7 @@ interface operations {
|
|
|
6203
6251
|
"application/json": components["schemas"]["Cart"];
|
|
6204
6252
|
};
|
|
6205
6253
|
};
|
|
6206
|
-
/** @description Possible error codes: `DISCOUNT_INVALID`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CART_MAX_ITEMS_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_INVALID_QUANTITY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_MAX_QUANTITY_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_SOLD_OUT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `OPTION_INVALID_FOR_PRODUCT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `REQUIRED_OPTIONS_MISSING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `FULFILLMENT_TYPE_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_INVALID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_NOT_ALLOWED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6254
|
+
/** @description Possible error codes: `DISCOUNT_INVALID`, `DISCOUNT_CUSTOMER_LIMIT`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CART_MAX_ITEMS_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_INVALID_QUANTITY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `LINE_ITEM_MAX_QUANTITY_EXCEEDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_SOLD_OUT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `OPTION_INVALID_FOR_PRODUCT`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `REQUIRED_OPTIONS_MISSING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `FULFILLMENT_TYPE_UNAVAILABLE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_REQUIRED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_INVALID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SERVICE_POINT_NOT_ALLOWED`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
6207
6255
|
400: {
|
|
6208
6256
|
headers: {
|
|
6209
6257
|
[name: string]: unknown;
|
|
@@ -7667,7 +7715,7 @@ interface operations {
|
|
|
7667
7715
|
"application/json": components["schemas"]["Checkout"];
|
|
7668
7716
|
};
|
|
7669
7717
|
};
|
|
7670
|
-
/** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7718
|
+
/** @description Possible error codes: `MISSING_CART_ID`, `CHECKOUT_VALIDATION_ERROR`, `PRODUCT_UNAVAILABLE`, `DISCOUNT_CUSTOMER_LIMIT`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7671
7719
|
400: {
|
|
7672
7720
|
headers: {
|
|
7673
7721
|
[name: string]: unknown;
|
|
@@ -7870,7 +7918,7 @@ interface operations {
|
|
|
7870
7918
|
};
|
|
7871
7919
|
};
|
|
7872
7920
|
};
|
|
7873
|
-
/** @description 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7921
|
+
/** @description Possible error codes: `DISCOUNT_CUSTOMER_LIMIT`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
7874
7922
|
400: {
|
|
7875
7923
|
headers: {
|
|
7876
7924
|
[name: string]: unknown;
|
|
@@ -7906,7 +7954,7 @@ interface operations {
|
|
|
7906
7954
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
7907
7955
|
};
|
|
7908
7956
|
};
|
|
7909
|
-
/** @description 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7957
|
+
/** @description Possible error codes: `CHECKOUT_INVALID_STATUS`, `PAYMENT_IN_FLIGHT`. 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
7910
7958
|
409: {
|
|
7911
7959
|
headers: {
|
|
7912
7960
|
[name: string]: unknown;
|
|
@@ -8487,7 +8535,7 @@ interface operations {
|
|
|
8487
8535
|
"application/json": components["schemas"]["Checkout"];
|
|
8488
8536
|
};
|
|
8489
8537
|
};
|
|
8490
|
-
/** @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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8538
|
+
/** @description Possible error codes: `CHECKOUT_VALIDATION_ERROR`, `DISCOUNT_CUSTOMER_LIMIT`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8491
8539
|
400: {
|
|
8492
8540
|
headers: {
|
|
8493
8541
|
[name: string]: unknown;
|
|
@@ -8884,7 +8932,7 @@ interface operations {
|
|
|
8884
8932
|
};
|
|
8885
8933
|
};
|
|
8886
8934
|
};
|
|
8887
|
-
/** @description Possible error codes: `MISSING_GATEWAY_ID`, `CHECKOUT_EMPTY`, `ZEEMIJLEN_IN_USE_ELSEWHERE`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`, `GIFT_CARD_HOLD_LAPSED`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8935
|
+
/** @description Possible error codes: `MISSING_GATEWAY_ID`, `CHECKOUT_EMPTY`, `ZEEMIJLEN_IN_USE_ELSEWHERE`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`, `DISCOUNT_CUSTOMER_LIMIT`, `GIFT_CARD_HOLD_LAPSED`. 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 `GIFT_CARD_BACKING_LOST_REFUNDED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_PENDING`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_REFUND_FAILED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_BACKING_LOST_NOT_CHARGED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GIFT_CARD_HOLD_LAPSED`. 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. */
|
|
8888
8936
|
400: {
|
|
8889
8937
|
headers: {
|
|
8890
8938
|
[name: string]: unknown;
|
|
@@ -9315,7 +9363,7 @@ interface operations {
|
|
|
9315
9363
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
9316
9364
|
};
|
|
9317
9365
|
};
|
|
9318
|
-
/** @description 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9366
|
+
/** @description Possible error codes: `CHECKOUT_INVALID_STATUS`, `PAYMENT_IN_FLIGHT`, `DISCOUNT_NOT_REMOVABLE`. 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 `DELIVERY_METHOD_UNAVAILABLE`. 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. Possible error codes include `PRODUCT_NOT_ORDERABLE_FOR_DATE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `PRODUCT_NO_LONGER_ORDERABLE`. Use `x-error-codes` for machine-readable retryability metadata. */
|
|
9319
9367
|
409: {
|
|
9320
9368
|
headers: {
|
|
9321
9369
|
[name: string]: unknown;
|