@poweredbysous/storefront-all-sdk 4.14.0 → 4.15.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
|
@@ -1745,9 +1745,10 @@ interface paths {
|
|
|
1745
1745
|
* non-sensitive routing data is returned (public_id, name, URL slug,
|
|
1746
1746
|
* currency); catalogue and write endpoints remain store-scoped and signed.
|
|
1747
1747
|
*
|
|
1748
|
-
* Stores with no active pickup location are
|
|
1749
|
-
*
|
|
1750
|
-
*
|
|
1748
|
+
* Stores with no active pickup location are listed only when they are set up
|
|
1749
|
+
* to deliver (an active delivery carrier, or an onboarding or store config that
|
|
1750
|
+
* offers delivery), with a null address, coordinates and open status. The rest
|
|
1751
|
+
* can't be ordered from, so they are omitted.
|
|
1751
1752
|
*/
|
|
1752
1753
|
get: operations["brand_locations_list"];
|
|
1753
1754
|
put?: never;
|
|
@@ -7361,6 +7362,11 @@ interface components {
|
|
|
7361
7362
|
/** @description Validates the request body for applying a discount code to a cart. */
|
|
7362
7363
|
ApplyDiscountInput: {
|
|
7363
7364
|
code: string;
|
|
7365
|
+
/**
|
|
7366
|
+
* Format: uuid
|
|
7367
|
+
* @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.
|
|
7368
|
+
*/
|
|
7369
|
+
customer_profile_id?: string | null;
|
|
7364
7370
|
};
|
|
7365
7371
|
/** @description Validates a gift card redemption request on a checkout. */
|
|
7366
7372
|
ApplyGiftCardInput: {
|
|
@@ -7484,11 +7490,10 @@ interface components {
|
|
|
7484
7490
|
/**
|
|
7485
7491
|
* @description One sellable location in a brand/company's storefront discovery list.
|
|
7486
7492
|
*
|
|
7487
|
-
*
|
|
7488
|
-
*
|
|
7489
|
-
*
|
|
7490
|
-
* geocoding is unavailable
|
|
7491
|
-
* for the schema. The storefront uses the coordinates to snap a customer's
|
|
7493
|
+
* A location without an active pickup location is listed only when it is set
|
|
7494
|
+
* up to deliver, and then ``address``, ``latitude``, ``longitude`` and
|
|
7495
|
+
* ``open_status`` are all null. ``latitude``/``longitude`` are also null when
|
|
7496
|
+
* geocoding is unavailable. The storefront uses the coordinates to snap a customer's
|
|
7492
7497
|
* delivery address to the nearest location, and the address for the manual
|
|
7493
7498
|
* location picker.
|
|
7494
7499
|
*/
|
|
@@ -7633,6 +7638,7 @@ interface components {
|
|
|
7633
7638
|
readonly discount: {
|
|
7634
7639
|
[key: string]: unknown;
|
|
7635
7640
|
} | null;
|
|
7641
|
+
readonly discount_notice: components["schemas"]["CartDiscountNotice"] | null;
|
|
7636
7642
|
readonly promotion: {
|
|
7637
7643
|
[key: string]: unknown;
|
|
7638
7644
|
} | null;
|
|
@@ -7643,6 +7649,7 @@ interface components {
|
|
|
7643
7649
|
* @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.
|
|
7644
7650
|
*/
|
|
7645
7651
|
estimated_shipping_cost?: string | null;
|
|
7652
|
+
readonly delivery_address: components["schemas"]["CartDeliveryAddress"] | null;
|
|
7646
7653
|
readonly service_fees: {
|
|
7647
7654
|
/**
|
|
7648
7655
|
* Format: decimal
|
|
@@ -7665,10 +7672,13 @@ interface components {
|
|
|
7665
7672
|
}[];
|
|
7666
7673
|
};
|
|
7667
7674
|
/**
|
|
7668
|
-
* @description
|
|
7675
|
+
* @description What checkout will charge for this basket, before gift cards and
|
|
7676
|
+
* Zeemijlen: the items, surcharges, delivery fee and service fee, less
|
|
7677
|
+
* discounts. Leaves out only a delivery fee not priced yet, which
|
|
7678
|
+
* ``service_fees.estimated`` says.
|
|
7669
7679
|
*
|
|
7670
|
-
*
|
|
7671
|
-
*
|
|
7680
|
+
* Totalled by ``order_total_before_points``, the formula checkout
|
|
7681
|
+
* totals with, so the cart total is the checkout total.
|
|
7672
7682
|
*/
|
|
7673
7683
|
readonly estimated_total: string;
|
|
7674
7684
|
/**
|
|
@@ -7688,6 +7698,37 @@ interface components {
|
|
|
7688
7698
|
/** Format: date-time */
|
|
7689
7699
|
expires_at: string;
|
|
7690
7700
|
};
|
|
7701
|
+
/**
|
|
7702
|
+
* @description Where the shopper wants delivery, as the shipping estimate reads it.
|
|
7703
|
+
*
|
|
7704
|
+
* Given with the fulfilment choice, before the first item, so every cart
|
|
7705
|
+
* response carries the delivery fee checkout will charge (price
|
|
7706
|
+
* transparency). The same fields a cart GET takes as query parameters.
|
|
7707
|
+
*/
|
|
7708
|
+
CartDeliveryAddress: {
|
|
7709
|
+
/** Format: decimal */
|
|
7710
|
+
latitude: string;
|
|
7711
|
+
/** Format: decimal */
|
|
7712
|
+
longitude: string;
|
|
7713
|
+
postal_code?: string;
|
|
7714
|
+
address_street?: string;
|
|
7715
|
+
address_city?: string;
|
|
7716
|
+
/** @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. */
|
|
7717
|
+
address_country?: string;
|
|
7718
|
+
};
|
|
7719
|
+
/**
|
|
7720
|
+
* @description A code the shopper typed that the cart has since taken off.
|
|
7721
|
+
*
|
|
7722
|
+
* Present from the recalculation that removed the code until the shopper
|
|
7723
|
+
* applies or removes a code. Documentation only: the payload is built by
|
|
7724
|
+
* ``CartSerializer.get_discount_notice``.
|
|
7725
|
+
*/
|
|
7726
|
+
CartDiscountNotice: {
|
|
7727
|
+
/** @description The code that was removed. */
|
|
7728
|
+
code: string;
|
|
7729
|
+
/** @description The error code saying why, e.g. DISCOUNT_CUSTOMER_LIMIT, DISCOUNT_EXPIRED, DISCOUNT_MIN_ORDER. */
|
|
7730
|
+
reason: string;
|
|
7731
|
+
};
|
|
7691
7732
|
/** @description Validates a single cart item for eligibility checks. */
|
|
7692
7733
|
CartItem: {
|
|
7693
7734
|
product_id: number;
|
|
@@ -7973,6 +8014,11 @@ interface components {
|
|
|
7973
8014
|
discount_amount: string;
|
|
7974
8015
|
discount_code: string | null;
|
|
7975
8016
|
discount_name: string | null;
|
|
8017
|
+
/** @description A code the shopper typed that the cart took off, and the error code why. */
|
|
8018
|
+
discount_notice: {
|
|
8019
|
+
code: string;
|
|
8020
|
+
reason: string;
|
|
8021
|
+
} | null;
|
|
7976
8022
|
applied_promotion_id: number | null;
|
|
7977
8023
|
promotion_discount_amount: string;
|
|
7978
8024
|
total: string;
|
|
@@ -10469,6 +10515,8 @@ interface components {
|
|
|
10469
10515
|
fulfillment_type?: components["schemas"]["FulfillmentTypeEnum"];
|
|
10470
10516
|
/** Format: date */
|
|
10471
10517
|
fulfillment_date?: string;
|
|
10518
|
+
/** @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. */
|
|
10519
|
+
delivery_address?: components["schemas"]["CartDeliveryAddress"] | null;
|
|
10472
10520
|
};
|
|
10473
10521
|
PatchedSetNationwideShipping: {
|
|
10474
10522
|
is_enabled?: boolean;
|
|
@@ -20002,7 +20050,7 @@ interface operations {
|
|
|
20002
20050
|
address_country?: string;
|
|
20003
20051
|
/** @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. */
|
|
20004
20052
|
address_street?: string;
|
|
20005
|
-
/** @description Delivery destination latitude. When paired with longitude, enables a per-group shipping estimate in the response. */
|
|
20053
|
+
/** @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. */
|
|
20006
20054
|
latitude?: number;
|
|
20007
20055
|
/** @description Delivery destination longitude. */
|
|
20008
20056
|
longitude?: number;
|
|
@@ -20117,7 +20165,7 @@ interface operations {
|
|
|
20117
20165
|
"application/json": components["schemas"]["Cart"];
|
|
20118
20166
|
};
|
|
20119
20167
|
};
|
|
20120
|
-
/** @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. */
|
|
20168
|
+
/** @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. */
|
|
20121
20169
|
400: {
|
|
20122
20170
|
headers: {
|
|
20123
20171
|
[name: string]: unknown;
|
|
@@ -22373,7 +22421,7 @@ interface operations {
|
|
|
22373
22421
|
"application/json": components["schemas"]["Checkout"];
|
|
22374
22422
|
};
|
|
22375
22423
|
};
|
|
22376
|
-
/** @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. */
|
|
22424
|
+
/** @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. */
|
|
22377
22425
|
400: {
|
|
22378
22426
|
headers: {
|
|
22379
22427
|
[name: string]: unknown;
|
|
@@ -22576,7 +22624,7 @@ interface operations {
|
|
|
22576
22624
|
};
|
|
22577
22625
|
};
|
|
22578
22626
|
};
|
|
22579
|
-
/** @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. */
|
|
22627
|
+
/** @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. */
|
|
22580
22628
|
400: {
|
|
22581
22629
|
headers: {
|
|
22582
22630
|
[name: string]: unknown;
|
|
@@ -22612,7 +22660,7 @@ interface operations {
|
|
|
22612
22660
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
22613
22661
|
};
|
|
22614
22662
|
};
|
|
22615
|
-
/** @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. */
|
|
22663
|
+
/** @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. */
|
|
22616
22664
|
409: {
|
|
22617
22665
|
headers: {
|
|
22618
22666
|
[name: string]: unknown;
|
|
@@ -23193,7 +23241,7 @@ interface operations {
|
|
|
23193
23241
|
"application/json": components["schemas"]["Checkout"];
|
|
23194
23242
|
};
|
|
23195
23243
|
};
|
|
23196
|
-
/** @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. */
|
|
23244
|
+
/** @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. */
|
|
23197
23245
|
400: {
|
|
23198
23246
|
headers: {
|
|
23199
23247
|
[name: string]: unknown;
|
|
@@ -23590,7 +23638,7 @@ interface operations {
|
|
|
23590
23638
|
};
|
|
23591
23639
|
};
|
|
23592
23640
|
};
|
|
23593
|
-
/** @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. */
|
|
23641
|
+
/** @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. */
|
|
23594
23642
|
400: {
|
|
23595
23643
|
headers: {
|
|
23596
23644
|
[name: string]: unknown;
|
|
@@ -24021,7 +24069,7 @@ interface operations {
|
|
|
24021
24069
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
24022
24070
|
};
|
|
24023
24071
|
};
|
|
24024
|
-
/** @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. */
|
|
24072
|
+
/** @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. */
|
|
24025
24073
|
409: {
|
|
24026
24074
|
headers: {
|
|
24027
24075
|
[name: string]: unknown;
|
package/dist/index.d.ts
CHANGED
|
@@ -1745,9 +1745,10 @@ interface paths {
|
|
|
1745
1745
|
* non-sensitive routing data is returned (public_id, name, URL slug,
|
|
1746
1746
|
* currency); catalogue and write endpoints remain store-scoped and signed.
|
|
1747
1747
|
*
|
|
1748
|
-
* Stores with no active pickup location are
|
|
1749
|
-
*
|
|
1750
|
-
*
|
|
1748
|
+
* Stores with no active pickup location are listed only when they are set up
|
|
1749
|
+
* to deliver (an active delivery carrier, or an onboarding or store config that
|
|
1750
|
+
* offers delivery), with a null address, coordinates and open status. The rest
|
|
1751
|
+
* can't be ordered from, so they are omitted.
|
|
1751
1752
|
*/
|
|
1752
1753
|
get: operations["brand_locations_list"];
|
|
1753
1754
|
put?: never;
|
|
@@ -7361,6 +7362,11 @@ interface components {
|
|
|
7361
7362
|
/** @description Validates the request body for applying a discount code to a cart. */
|
|
7362
7363
|
ApplyDiscountInput: {
|
|
7363
7364
|
code: string;
|
|
7365
|
+
/**
|
|
7366
|
+
* Format: uuid
|
|
7367
|
+
* @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.
|
|
7368
|
+
*/
|
|
7369
|
+
customer_profile_id?: string | null;
|
|
7364
7370
|
};
|
|
7365
7371
|
/** @description Validates a gift card redemption request on a checkout. */
|
|
7366
7372
|
ApplyGiftCardInput: {
|
|
@@ -7484,11 +7490,10 @@ interface components {
|
|
|
7484
7490
|
/**
|
|
7485
7491
|
* @description One sellable location in a brand/company's storefront discovery list.
|
|
7486
7492
|
*
|
|
7487
|
-
*
|
|
7488
|
-
*
|
|
7489
|
-
*
|
|
7490
|
-
* geocoding is unavailable
|
|
7491
|
-
* for the schema. The storefront uses the coordinates to snap a customer's
|
|
7493
|
+
* A location without an active pickup location is listed only when it is set
|
|
7494
|
+
* up to deliver, and then ``address``, ``latitude``, ``longitude`` and
|
|
7495
|
+
* ``open_status`` are all null. ``latitude``/``longitude`` are also null when
|
|
7496
|
+
* geocoding is unavailable. The storefront uses the coordinates to snap a customer's
|
|
7492
7497
|
* delivery address to the nearest location, and the address for the manual
|
|
7493
7498
|
* location picker.
|
|
7494
7499
|
*/
|
|
@@ -7633,6 +7638,7 @@ interface components {
|
|
|
7633
7638
|
readonly discount: {
|
|
7634
7639
|
[key: string]: unknown;
|
|
7635
7640
|
} | null;
|
|
7641
|
+
readonly discount_notice: components["schemas"]["CartDiscountNotice"] | null;
|
|
7636
7642
|
readonly promotion: {
|
|
7637
7643
|
[key: string]: unknown;
|
|
7638
7644
|
} | null;
|
|
@@ -7643,6 +7649,7 @@ interface components {
|
|
|
7643
7649
|
* @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.
|
|
7644
7650
|
*/
|
|
7645
7651
|
estimated_shipping_cost?: string | null;
|
|
7652
|
+
readonly delivery_address: components["schemas"]["CartDeliveryAddress"] | null;
|
|
7646
7653
|
readonly service_fees: {
|
|
7647
7654
|
/**
|
|
7648
7655
|
* Format: decimal
|
|
@@ -7665,10 +7672,13 @@ interface components {
|
|
|
7665
7672
|
}[];
|
|
7666
7673
|
};
|
|
7667
7674
|
/**
|
|
7668
|
-
* @description
|
|
7675
|
+
* @description What checkout will charge for this basket, before gift cards and
|
|
7676
|
+
* Zeemijlen: the items, surcharges, delivery fee and service fee, less
|
|
7677
|
+
* discounts. Leaves out only a delivery fee not priced yet, which
|
|
7678
|
+
* ``service_fees.estimated`` says.
|
|
7669
7679
|
*
|
|
7670
|
-
*
|
|
7671
|
-
*
|
|
7680
|
+
* Totalled by ``order_total_before_points``, the formula checkout
|
|
7681
|
+
* totals with, so the cart total is the checkout total.
|
|
7672
7682
|
*/
|
|
7673
7683
|
readonly estimated_total: string;
|
|
7674
7684
|
/**
|
|
@@ -7688,6 +7698,37 @@ interface components {
|
|
|
7688
7698
|
/** Format: date-time */
|
|
7689
7699
|
expires_at: string;
|
|
7690
7700
|
};
|
|
7701
|
+
/**
|
|
7702
|
+
* @description Where the shopper wants delivery, as the shipping estimate reads it.
|
|
7703
|
+
*
|
|
7704
|
+
* Given with the fulfilment choice, before the first item, so every cart
|
|
7705
|
+
* response carries the delivery fee checkout will charge (price
|
|
7706
|
+
* transparency). The same fields a cart GET takes as query parameters.
|
|
7707
|
+
*/
|
|
7708
|
+
CartDeliveryAddress: {
|
|
7709
|
+
/** Format: decimal */
|
|
7710
|
+
latitude: string;
|
|
7711
|
+
/** Format: decimal */
|
|
7712
|
+
longitude: string;
|
|
7713
|
+
postal_code?: string;
|
|
7714
|
+
address_street?: string;
|
|
7715
|
+
address_city?: string;
|
|
7716
|
+
/** @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. */
|
|
7717
|
+
address_country?: string;
|
|
7718
|
+
};
|
|
7719
|
+
/**
|
|
7720
|
+
* @description A code the shopper typed that the cart has since taken off.
|
|
7721
|
+
*
|
|
7722
|
+
* Present from the recalculation that removed the code until the shopper
|
|
7723
|
+
* applies or removes a code. Documentation only: the payload is built by
|
|
7724
|
+
* ``CartSerializer.get_discount_notice``.
|
|
7725
|
+
*/
|
|
7726
|
+
CartDiscountNotice: {
|
|
7727
|
+
/** @description The code that was removed. */
|
|
7728
|
+
code: string;
|
|
7729
|
+
/** @description The error code saying why, e.g. DISCOUNT_CUSTOMER_LIMIT, DISCOUNT_EXPIRED, DISCOUNT_MIN_ORDER. */
|
|
7730
|
+
reason: string;
|
|
7731
|
+
};
|
|
7691
7732
|
/** @description Validates a single cart item for eligibility checks. */
|
|
7692
7733
|
CartItem: {
|
|
7693
7734
|
product_id: number;
|
|
@@ -7973,6 +8014,11 @@ interface components {
|
|
|
7973
8014
|
discount_amount: string;
|
|
7974
8015
|
discount_code: string | null;
|
|
7975
8016
|
discount_name: string | null;
|
|
8017
|
+
/** @description A code the shopper typed that the cart took off, and the error code why. */
|
|
8018
|
+
discount_notice: {
|
|
8019
|
+
code: string;
|
|
8020
|
+
reason: string;
|
|
8021
|
+
} | null;
|
|
7976
8022
|
applied_promotion_id: number | null;
|
|
7977
8023
|
promotion_discount_amount: string;
|
|
7978
8024
|
total: string;
|
|
@@ -10469,6 +10515,8 @@ interface components {
|
|
|
10469
10515
|
fulfillment_type?: components["schemas"]["FulfillmentTypeEnum"];
|
|
10470
10516
|
/** Format: date */
|
|
10471
10517
|
fulfillment_date?: string;
|
|
10518
|
+
/** @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. */
|
|
10519
|
+
delivery_address?: components["schemas"]["CartDeliveryAddress"] | null;
|
|
10472
10520
|
};
|
|
10473
10521
|
PatchedSetNationwideShipping: {
|
|
10474
10522
|
is_enabled?: boolean;
|
|
@@ -20002,7 +20050,7 @@ interface operations {
|
|
|
20002
20050
|
address_country?: string;
|
|
20003
20051
|
/** @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. */
|
|
20004
20052
|
address_street?: string;
|
|
20005
|
-
/** @description Delivery destination latitude. When paired with longitude, enables a per-group shipping estimate in the response. */
|
|
20053
|
+
/** @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. */
|
|
20006
20054
|
latitude?: number;
|
|
20007
20055
|
/** @description Delivery destination longitude. */
|
|
20008
20056
|
longitude?: number;
|
|
@@ -20117,7 +20165,7 @@ interface operations {
|
|
|
20117
20165
|
"application/json": components["schemas"]["Cart"];
|
|
20118
20166
|
};
|
|
20119
20167
|
};
|
|
20120
|
-
/** @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. */
|
|
20168
|
+
/** @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. */
|
|
20121
20169
|
400: {
|
|
20122
20170
|
headers: {
|
|
20123
20171
|
[name: string]: unknown;
|
|
@@ -22373,7 +22421,7 @@ interface operations {
|
|
|
22373
22421
|
"application/json": components["schemas"]["Checkout"];
|
|
22374
22422
|
};
|
|
22375
22423
|
};
|
|
22376
|
-
/** @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. */
|
|
22424
|
+
/** @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. */
|
|
22377
22425
|
400: {
|
|
22378
22426
|
headers: {
|
|
22379
22427
|
[name: string]: unknown;
|
|
@@ -22576,7 +22624,7 @@ interface operations {
|
|
|
22576
22624
|
};
|
|
22577
22625
|
};
|
|
22578
22626
|
};
|
|
22579
|
-
/** @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. */
|
|
22627
|
+
/** @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. */
|
|
22580
22628
|
400: {
|
|
22581
22629
|
headers: {
|
|
22582
22630
|
[name: string]: unknown;
|
|
@@ -22612,7 +22660,7 @@ interface operations {
|
|
|
22612
22660
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
22613
22661
|
};
|
|
22614
22662
|
};
|
|
22615
|
-
/** @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. */
|
|
22663
|
+
/** @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. */
|
|
22616
22664
|
409: {
|
|
22617
22665
|
headers: {
|
|
22618
22666
|
[name: string]: unknown;
|
|
@@ -23193,7 +23241,7 @@ interface operations {
|
|
|
23193
23241
|
"application/json": components["schemas"]["Checkout"];
|
|
23194
23242
|
};
|
|
23195
23243
|
};
|
|
23196
|
-
/** @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. */
|
|
23244
|
+
/** @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. */
|
|
23197
23245
|
400: {
|
|
23198
23246
|
headers: {
|
|
23199
23247
|
[name: string]: unknown;
|
|
@@ -23590,7 +23638,7 @@ interface operations {
|
|
|
23590
23638
|
};
|
|
23591
23639
|
};
|
|
23592
23640
|
};
|
|
23593
|
-
/** @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. */
|
|
23641
|
+
/** @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. */
|
|
23594
23642
|
400: {
|
|
23595
23643
|
headers: {
|
|
23596
23644
|
[name: string]: unknown;
|
|
@@ -24021,7 +24069,7 @@ interface operations {
|
|
|
24021
24069
|
"application/json": components["schemas"]["APIErrorEnvelope"];
|
|
24022
24070
|
};
|
|
24023
24071
|
};
|
|
24024
|
-
/** @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. */
|
|
24072
|
+
/** @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. */
|
|
24025
24073
|
409: {
|
|
24026
24074
|
headers: {
|
|
24027
24075
|
[name: string]: unknown;
|