commerce-sdk-isomorphic 4.0.0-unstable-20251202080814 → 4.0.0-unstable-20251204080831

package/lib/shopperOrders.d.ts

@@ -160,6 +160,56 @@ type Status = {
 } & {
     [key: string]: any;
 };
+/**
+ * @type OrderPaymentInstrumentPaymentReferenceGatewayProperties: The payment gateway specific properties.
+ *
+ * @property stripe: Stripe specific properties.
+ *
+ * @property adyen: Ayden specific properties.
+ *
+ * @property paypal: PayPal specific properties.
+ *
+ */
+type OrderPaymentInstrumentPaymentReferenceGatewayProperties = {
+    stripe?: {
+        [key: string]: any;
+    };
+    adyen?: {
+        [key: string]: any;
+    };
+    paypal?: {
+        [key: string]: any;
+    };
+} & {
+    [key: string]: any;
+};
+/**
+ * @type OrderPaymentInstrumentPaymentReference: Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
+ *
+ * @property paymentReferenceId: Payment reference identifier. Can be payment intent ID for Stripe, PSP reference for Adyen, PayPal order ID for PayPal, or similar identifier for other payment providers.
+ * - **Max Length:** 256
+ *
+ * @property clientSecret: Client secret for payment confirmation. Used primarily by Stripe for client-side payment confirmation.
+ * - **Max Length:** 256
+ *
+ * @property redirectUrl: Redirect URL for payment methods that require user redirection to complete payment.
+ * - **Max Length:** 2048
+ *
+ * @property gateway: The payment gateway used to process the payment.
+ *
+ * @property gatewayProperties:
+ *
+ */
+type OrderPaymentInstrumentPaymentReference = {
+    paymentReferenceId?: string;
+    clientSecret?: string;
+    redirectUrl?: string;
+    gateway?: OrderPaymentInstrumentPaymentReferenceGatewayEnum;
+    gatewayProperties?: OrderPaymentInstrumentPaymentReferenceGatewayProperties;
+} & {
+    [key: string]: any;
+};
+type OrderPaymentInstrumentPaymentReferenceGatewayEnum = "stripe" | "paypal" | "adyen";
 /**
  * @type PaymentCard: Document representing a payment card.
  *
@@ -225,6 +275,8 @@ type PaymentCard = {
  * @property paymentMethodId: The payment method ID. It is read only.
  * - **Max Length:** 256
  *
+ * @property paymentReference:
+ *
  */
 type OrderPaymentInstrument = {
     amount?: number;
@@ -234,6 +286,7 @@ type OrderPaymentInstrument = {
     paymentCard?: PaymentCard;
     paymentInstrumentId?: string;
     paymentMethodId?: string;
+    paymentReference?: OrderPaymentInstrumentPaymentReference;
 } & {
     [key: string]: any;
 };
@@ -773,6 +826,21 @@ type OptionItem = {
 } & {
     [key: string]: any;
 };
+/**
+ * @type SomInfo: Additional information retrieved from Salesforce Order Management (SOM)  See https://developer.salesforce.com/docs/atlas.en-us.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_orderitemsummary.htm for more information.
+ *
+ * @property status: Salesforce Order Management (SOM) status
+ *
+ * @property quantityAvailableToCancel: The quantity that can be cancelled.
+ *
+ */
+type SomInfo = {
+    status?: SomInfoStatusEnum;
+    quantityAvailableToCancel?: number;
+} & {
+    [key: string]: any;
+};
+type SomInfoStatusEnum = "ordered" | "returned" | "canceled" | "paid" | "reshipped" | "fulfilled" | "partially_fulfilled" | "allocated" | "partially_allocated" | "return_initiated";
 /**
  * @type ProductItem: Document representing a product item.
  *
@@ -823,6 +891,8 @@ type OptionItem = {
  *
  * @property shippingItemId: If the product line item has a related shipping item, this value is its ID. A related shipping item represents a surcharge applied to individual products using a particular shipping method. It is read only.
  *
+ * @property somInfo:
+ *
  * @property tax: The tax for the product item, not including price adjustments. It is read only.
  *
  * @property taxBasis: The price used to calculate the tax for this product item. It is read only.
@@ -855,6 +925,7 @@ type ProductItem = {
     quantity?: number;
     shipmentId?: string;
     shippingItemId?: string;
+    somInfo?: SomInfo;
     tax?: number;
     taxBasis?: number;
     taxClassId?: string;
@@ -992,11 +1063,86 @@ type ErrorResponse = {
 } & {
     [key: string]: any;
 };
+/**
+ * @type FailOrderRequest: Document representing a fail order request.
+ *
+ * @property reasonCode: The reason code for failing the order.
+ *
+ */
+type FailOrderRequest = {
+    reasonCode?: FailOrderRequestReasonCodeEnum;
+} & {
+    [key: string]: any;
+};
+type FailOrderRequestReasonCodeEnum = "payment_confirm_failure" | "payment_capture_failure" | "payment_auth_failure";
 /**
  * @type LocaleCode
  * A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
  */
 type LocaleCode$0 = DefaultFallback | string;
+/**
+ * @type ShipmentItem: Individual item within a shipment
+ *
+ * @property id: Unique identifier for the shipment item
+ *
+ * @property productItemId: Reference to the product item in the order
+ *
+ * @property quantity: Quantity of product items with the referenced productItemId in this shipment
+ *
+ */
+type ShipmentItem = {
+    id?: string;
+    productItemId?: string;
+    quantity?: number;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type SchemasShipment: Shipment information from Salesforce Order Management created during fulfillment process. See https://developer.salesforce.com/docs/atlas.en-us.230.0.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_fulfillmentorder.htm for more information.
+ *
+ * @property id: Unique identifier for the shipment
+ *
+ * @property status: Current status of the shipment
+ *
+ * @property provider: Shipping provider name
+ *
+ * @property trackingNumber: Tracking number for the shipment
+ *
+ * @property trackingUrl: URL to track the shipment
+ *
+ * @property expectedDeliveryDate: Expected delivery date and time
+ *
+ * @property actualDeliveryDate: Actual delivery date and time (null if not yet delivered)
+ *
+ * @property shipmentItems: Items included in this shipment
+ *
+ */
+type SchemasShipment = {
+    id?: string;
+    status?: string;
+    provider?: string;
+    trackingNumber?: string;
+    trackingUrl?: string;
+    expectedDeliveryDate?: string;
+    actualDeliveryDate?: string;
+    shipmentItems?: Array<ShipmentItem>;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type SchemasSomInfo: Additional information retrieved from Salesforce Order Management (SOM)  See https://developer.salesforce.com/docs/atlas.en-us.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_ordersummary.htm for more information.
+ *
+ * @property status: Current status of the order
+ *
+ * @property shipments: List of shipments associated with the order
+ *
+ */
+type SchemasSomInfo = {
+    status?: string;
+    shipments?: Array<SchemasShipment>;
+} & {
+    [key: string]: any;
+};
 /**
  * @type Order: Document representing an order.
  *
@@ -1074,6 +1220,8 @@ type LocaleCode$0 = DefaultFallback | string;
  * - **Min Length:** 1
  * - **Max Length:** 32
  *
+ * @property somInfo:
+ *
  * @property sourceCode: The source code assigned to the basket from which this order was created. It is read only.
  *
  * @property status: The status.
@@ -1123,6 +1271,7 @@ type Order = {
     shippingTotal?: number;
     shippingTotalTax?: number;
     siteId?: string;
+    somInfo?: SchemasSomInfo;
     sourceCode?: string;
     status?: OrderStatusEnum;
     taxTotal?: number;
@@ -1194,21 +1343,35 @@ type OrderPaymentCardRequest = {
     [key: string]: any;
 };
 /**
- * @type SalesforcePaymentsRequest: Document representing a Salesforce Payments request.
+ * @type PaymentReferenceRequest: Properties for Payments Reference Request
  *
- * @property paymentMethodType: The payment method type (for example: Visa).
- * - **Max Length:** 100
+ * @property paymentMethodType: Payment Method Type
+ * - **Max Length:** 64
  *
- * @property zoneId: The zone ID.
+ * @property zoneId: The unique identifier for a Payments zone.
+ * - **Pattern:** /^[a-zA-Z0-9\\-_]{1,100}$/
+ * - **Min Length:** 1
  * - **Max Length:** 100
  *
+ * @property shippingPreference: Shipping preference for PayPal payment processing. Applicable only for basket payment instruments.
+ * - **Max Length:** 64
+ *
+ * @property gateway: The payment gateway used to process the payment.
+ *
+ * @property gatewayProperties:
+ *
  */
-type SalesforcePaymentsRequest = {
+type PaymentReferenceRequest = {
     paymentMethodType?: string;
     zoneId?: string;
+    shippingPreference?: PaymentReferenceRequestShippingPreferenceEnum;
+    gateway?: PaymentReferenceRequestGatewayEnum;
+    gatewayProperties?: OrderPaymentInstrumentPaymentReferenceGatewayProperties;
 } & {
     [key: string]: any;
 };
+type PaymentReferenceRequestShippingPreferenceEnum = "GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS";
+type PaymentReferenceRequestGatewayEnum = "stripe" | "paypal" | "adyen";
 /**
  * @type OrderPaymentInstrumentRequest: Document representing an order payment instrument request.
  *
@@ -1225,7 +1388,7 @@ type SalesforcePaymentsRequest = {
  * @property paymentMethodId: The payment method ID.
  * - **Max Length:** 256
  *
- * @property paymentReferenceRequest: The payment reference request used by Salesforce Payments.
+ * @property paymentReferenceRequest: Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
  *
  */
 type OrderPaymentInstrumentRequest = {
@@ -1234,7 +1397,7 @@ type OrderPaymentInstrumentRequest = {
     giftCertificateCode?: string;
     paymentCard?: OrderPaymentCardRequest;
     paymentMethodId?: string;
-    paymentReferenceRequest?: SalesforcePaymentsRequest;
+    paymentReferenceRequest?: PaymentReferenceRequest;
 } & {
     [key: string]: any;
 };
@@ -1349,6 +1512,7 @@ type Taxes = {
 } & {
     [key: string]: any;
 };
+type GetOrderExpandEnum = "som" | "som_shipments";
 type createOrderQueryParameters = {
     siteId: string;
     locale?: LocaleCode$0;
@@ -1364,9 +1528,19 @@ type createPaymentInstrumentForOrderPathParameters = {
     organizationId: string;
     orderNo: string;
 };
+type failOrderQueryParameters = {
+    siteId: string;
+    locale?: LocaleCode$0;
+    reopenBasket?: boolean;
+};
+type failOrderPathParameters = {
+    organizationId: string;
+    orderNo: string;
+};
 type getOrderQueryParameters = {
     siteId: string;
     locale?: LocaleCode$0;
+    expand?: Array<"som" | "som_shipments">;
 };
 type getOrderPathParameters = {
     orderNo: string;
@@ -1416,11 +1590,11 @@ type updatePaymentInstrumentForOrderPathParameters = {
 /**
  * All path parameters that are used by at least one ShopperOrders method.
  */
-type ShopperOrdersPathParameters = Partial<createOrderPathParameters & createPaymentInstrumentForOrderPathParameters & getOrderPathParameters & getPaymentMethodsForOrderPathParameters & getTaxesFromOrderPathParameters & guestOrderLookupPathParameters & removePaymentInstrumentFromOrderPathParameters & updatePaymentInstrumentForOrderPathParameters & {}>;
+type ShopperOrdersPathParameters = Partial<createOrderPathParameters & createPaymentInstrumentForOrderPathParameters & failOrderPathParameters & getOrderPathParameters & getPaymentMethodsForOrderPathParameters & getTaxesFromOrderPathParameters & guestOrderLookupPathParameters & removePaymentInstrumentFromOrderPathParameters & updatePaymentInstrumentForOrderPathParameters & {}>;
 /**
  * All query parameters that are used by at least one ShopperOrders method.
  */
-type ShopperOrdersQueryParameters = Partial<createOrderQueryParameters & createPaymentInstrumentForOrderQueryParameters & getOrderQueryParameters & getPaymentMethodsForOrderQueryParameters & getTaxesFromOrderQueryParameters & guestOrderLookupQueryParameters & removePaymentInstrumentFromOrderQueryParameters & updatePaymentInstrumentForOrderQueryParameters & {}>;
+type ShopperOrdersQueryParameters = Partial<createOrderQueryParameters & createPaymentInstrumentForOrderQueryParameters & failOrderQueryParameters & getOrderQueryParameters & getPaymentMethodsForOrderQueryParameters & getTaxesFromOrderQueryParameters & guestOrderLookupQueryParameters & removePaymentInstrumentFromOrderQueryParameters & updatePaymentInstrumentForOrderQueryParameters & {}>;
 /**
  * All parameters that are used by ShopperOrders.
  */
@@ -1429,7 +1603,9 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
  * [Shopper Orders](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-orders:Summary)
  * ==================================
  *
- * *# API Overview
+ * *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-orders/shopper-orders-oas-v1-public.yaml)
+ 
+ # API Overview
  
  The Shopper Orders API enables you to:
  
@@ -1492,6 +1668,7 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
     static readonly apiPaths: {
         createOrder: string;
         createPaymentInstrumentForOrder: string;
+        failOrder: string;
         getOrder: string;
         getPaymentMethodsForOrder: string;
         getTaxesFromOrder: string;
@@ -1521,11 +1698,24 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
             "orderNo",
             "siteId"
         ];
+        readonly failOrder: readonly [
+            "organizationId",
+            "orderNo",
+            "siteId",
+            "locale",
+            "reopenBasket"
+        ];
+        readonly failOrderRequired: readonly [
+            "organizationId",
+            "orderNo",
+            "siteId"
+        ];
         readonly getOrder: readonly [
             "orderNo",
             "organizationId",
             "siteId",
-            "locale"
+            "locale",
+            "expand"
         ];
         readonly getOrderRequired: readonly [
             "orderNo",
@@ -1707,6 +1897,71 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
         };
         body: OrderPaymentInstrumentRequest & CustomRequestBody;
     }>, rawResponse?: T): Promise<T extends true ? Response : Order>;
+    /**
+     * Fails an unplaced order and optionally reopens the basket when indicated.
+     Creates a HistoryEntry in the failed Order with provided reasonCode.
+     *
+     * If you would like to get a raw Response object use the other failOrder function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.orderNo - The order number of the order to be modified.
+     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+     * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+     * @param options.parameters.reopenBasket - Set to true to reopen basket from the order.
+     A basket can only be reopened if no other basket for the customer exists at the moment of the call to fail Order,
+     since a customer is limited to 1 storefront basket at a time.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     *
+     * @returns A promise of type void.
+     */
+    failOrder(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            orderNo: string;
+            siteId: string;
+            locale?: LocaleCode$0;
+            reopenBasket?: boolean;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: FailOrderRequest & CustomRequestBody;
+    }>): Promise<void>;
+    /**
+     * Fails an unplaced order and optionally reopens the basket when indicated.
+     Creates a HistoryEntry in the failed Order with provided reasonCode.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.orderNo - The order number of the order to be modified.
+     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+     * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+     * @param options.parameters.reopenBasket - Set to true to reopen basket from the order.
+     A basket can only be reopened if no other basket for the customer exists at the moment of the call to fail Order,
+     since a customer is limited to 1 storefront basket at a time.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     * @param rawResponse - Set to true to return entire Response object instead of DTO.
+     *
+     * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
+     */
+    failOrder<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            orderNo: string;
+            siteId: string;
+            locale?: LocaleCode$0;
+            reopenBasket?: boolean;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: FailOrderRequest & CustomRequestBody;
+    }>, rawResponse?: T): Promise<T extends true ? Response : void>;
     /**
      * Gets information for an order.
      *
@@ -1718,6 +1973,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
      * @param options.parameters.organizationId - An identifier for the organization the request is being made by
      * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
      * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+     * @param options.parameters.expand - When a 'som' expand is selected, data is primarily loaded from Salesforce Order Management (SOM), if available.
+     When data is available in SOM, the expand parameter has the following behavior:
+     "expand=som": order and related order entities (product items, delivery group, etc) are returned.
+     "expand=som_shipments": order and fulfillment (shipment) data is returned.
+     "expand=som,som_shipments": order, related order entities and fulfillment (shipment) data is returned
+     If your instance is not integrated with SOM or the order data is not available, the `expand=som` command is disregarded.
      * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
      *
      * @returns A promise of type Order.
@@ -1728,6 +1989,7 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
             organizationId: string;
             siteId: string;
             locale?: LocaleCode$0;
+            expand?: Array<GetOrderExpandEnum>;
         } & QueryParameters, ConfigParameters>;
         headers?: {
             [key: string]: string;
@@ -1742,6 +2004,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
      * @param options.parameters.organizationId - An identifier for the organization the request is being made by
      * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
      * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+     * @param options.parameters.expand - When a 'som' expand is selected, data is primarily loaded from Salesforce Order Management (SOM), if available.
+     When data is available in SOM, the expand parameter has the following behavior:
+     "expand=som": order and related order entities (product items, delivery group, etc) are returned.
+     "expand=som_shipments": order and fulfillment (shipment) data is returned.
+     "expand=som,som_shipments": order, related order entities and fulfillment (shipment) data is returned
+     If your instance is not integrated with SOM or the order data is not available, the `expand=som` command is disregarded.
      * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
      * @param rawResponse - Set to true to return entire Response object instead of DTO.
      *
@@ -1753,6 +2021,7 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
             organizationId: string;
             siteId: string;
             locale?: LocaleCode$0;
+            expand?: Array<GetOrderExpandEnum>;
         } & QueryParameters, ConfigParameters>;
         headers?: {
             [key: string]: string;
@@ -2227,6 +2496,56 @@ declare namespace ShopperOrdersApiTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type OrderPaymentInstrumentPaymentReferenceGatewayProperties: The payment gateway specific properties.
+     *
+     * @property stripe: Stripe specific properties.
+     *
+     * @property adyen: Ayden specific properties.
+     *
+     * @property paypal: PayPal specific properties.
+     *
+     */
+    type OrderPaymentInstrumentPaymentReferenceGatewayProperties = {
+        stripe?: {
+            [key: string]: any;
+        };
+        adyen?: {
+            [key: string]: any;
+        };
+        paypal?: {
+            [key: string]: any;
+        };
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type OrderPaymentInstrumentPaymentReference: Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
+     *
+     * @property paymentReferenceId: Payment reference identifier. Can be payment intent ID for Stripe, PSP reference for Adyen, PayPal order ID for PayPal, or similar identifier for other payment providers.
+     * - **Max Length:** 256
+     *
+     * @property clientSecret: Client secret for payment confirmation. Used primarily by Stripe for client-side payment confirmation.
+     * - **Max Length:** 256
+     *
+     * @property redirectUrl: Redirect URL for payment methods that require user redirection to complete payment.
+     * - **Max Length:** 2048
+     *
+     * @property gateway: The payment gateway used to process the payment.
+     *
+     * @property gatewayProperties:
+     *
+     */
+    type OrderPaymentInstrumentPaymentReference = {
+        paymentReferenceId?: string;
+        clientSecret?: string;
+        redirectUrl?: string;
+        gateway?: OrderPaymentInstrumentPaymentReferenceGatewayEnum;
+        gatewayProperties?: OrderPaymentInstrumentPaymentReferenceGatewayProperties;
+    } & {
+        [key: string]: any;
+    };
+    type OrderPaymentInstrumentPaymentReferenceGatewayEnum = "stripe" | "paypal" | "adyen";
     /**
      * @type PaymentCard: Document representing a payment card.
      *
@@ -2292,6 +2611,8 @@ declare namespace ShopperOrdersApiTypes {
      * @property paymentMethodId: The payment method ID. It is read only.
      * - **Max Length:** 256
      *
+     * @property paymentReference:
+     *
      */
     type OrderPaymentInstrument = {
         amount?: number;
@@ -2301,6 +2622,7 @@ declare namespace ShopperOrdersApiTypes {
         paymentCard?: PaymentCard;
         paymentInstrumentId?: string;
         paymentMethodId?: string;
+        paymentReference?: OrderPaymentInstrumentPaymentReference;
     } & {
         [key: string]: any;
     };
@@ -2840,6 +3162,21 @@ declare namespace ShopperOrdersApiTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type SomInfo: Additional information retrieved from Salesforce Order Management (SOM)  See https://developer.salesforce.com/docs/atlas.en-us.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_orderitemsummary.htm for more information.
+     *
+     * @property status: Salesforce Order Management (SOM) status
+     *
+     * @property quantityAvailableToCancel: The quantity that can be cancelled.
+     *
+     */
+    type SomInfo = {
+        status?: SomInfoStatusEnum;
+        quantityAvailableToCancel?: number;
+    } & {
+        [key: string]: any;
+    };
+    type SomInfoStatusEnum = "ordered" | "returned" | "canceled" | "paid" | "reshipped" | "fulfilled" | "partially_fulfilled" | "allocated" | "partially_allocated" | "return_initiated";
     /**
      * @type ProductItem: Document representing a product item.
      *
@@ -2890,6 +3227,8 @@ declare namespace ShopperOrdersApiTypes {
      *
      * @property shippingItemId: If the product line item has a related shipping item, this value is its ID. A related shipping item represents a surcharge applied to individual products using a particular shipping method. It is read only.
      *
+     * @property somInfo:
+     *
      * @property tax: The tax for the product item, not including price adjustments. It is read only.
      *
      * @property taxBasis: The price used to calculate the tax for this product item. It is read only.
@@ -2922,6 +3261,7 @@ declare namespace ShopperOrdersApiTypes {
         quantity?: number;
         shipmentId?: string;
         shippingItemId?: string;
+        somInfo?: SomInfo;
         tax?: number;
         taxBasis?: number;
         taxClassId?: string;
@@ -3059,11 +3399,86 @@ declare namespace ShopperOrdersApiTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type FailOrderRequest: Document representing a fail order request.
+     *
+     * @property reasonCode: The reason code for failing the order.
+     *
+     */
+    type FailOrderRequest = {
+        reasonCode?: FailOrderRequestReasonCodeEnum;
+    } & {
+        [key: string]: any;
+    };
+    type FailOrderRequestReasonCodeEnum = "payment_confirm_failure" | "payment_capture_failure" | "payment_auth_failure";
     /**
      * @type LocaleCode
      * A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
      */
     type LocaleCode$0 = DefaultFallback | string;
+    /**
+     * @type ShipmentItem: Individual item within a shipment
+     *
+     * @property id: Unique identifier for the shipment item
+     *
+     * @property productItemId: Reference to the product item in the order
+     *
+     * @property quantity: Quantity of product items with the referenced productItemId in this shipment
+     *
+     */
+    type ShipmentItem = {
+        id?: string;
+        productItemId?: string;
+        quantity?: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type SchemasShipment: Shipment information from Salesforce Order Management created during fulfillment process. See https://developer.salesforce.com/docs/atlas.en-us.230.0.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_fulfillmentorder.htm for more information.
+     *
+     * @property id: Unique identifier for the shipment
+     *
+     * @property status: Current status of the shipment
+     *
+     * @property provider: Shipping provider name
+     *
+     * @property trackingNumber: Tracking number for the shipment
+     *
+     * @property trackingUrl: URL to track the shipment
+     *
+     * @property expectedDeliveryDate: Expected delivery date and time
+     *
+     * @property actualDeliveryDate: Actual delivery date and time (null if not yet delivered)
+     *
+     * @property shipmentItems: Items included in this shipment
+     *
+     */
+    type SchemasShipment = {
+        id?: string;
+        status?: string;
+        provider?: string;
+        trackingNumber?: string;
+        trackingUrl?: string;
+        expectedDeliveryDate?: string;
+        actualDeliveryDate?: string;
+        shipmentItems?: Array<ShipmentItem>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type SchemasSomInfo: Additional information retrieved from Salesforce Order Management (SOM)  See https://developer.salesforce.com/docs/atlas.en-us.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_ordersummary.htm for more information.
+     *
+     * @property status: Current status of the order
+     *
+     * @property shipments: List of shipments associated with the order
+     *
+     */
+    type SchemasSomInfo = {
+        status?: string;
+        shipments?: Array<SchemasShipment>;
+    } & {
+        [key: string]: any;
+    };
     /**
      * @type Order: Document representing an order.
      *
@@ -3141,6 +3556,8 @@ declare namespace ShopperOrdersApiTypes {
      * - **Min Length:** 1
      * - **Max Length:** 32
      *
+     * @property somInfo:
+     *
      * @property sourceCode: The source code assigned to the basket from which this order was created. It is read only.
      *
      * @property status: The status.
@@ -3190,6 +3607,7 @@ declare namespace ShopperOrdersApiTypes {
         shippingTotal?: number;
         shippingTotalTax?: number;
         siteId?: string;
+        somInfo?: SchemasSomInfo;
         sourceCode?: string;
         status?: OrderStatusEnum;
         taxTotal?: number;
@@ -3261,21 +3679,35 @@ declare namespace ShopperOrdersApiTypes {
         [key: string]: any;
     };
     /**
-     * @type SalesforcePaymentsRequest: Document representing a Salesforce Payments request.
+     * @type PaymentReferenceRequest: Properties for Payments Reference Request
      *
-     * @property paymentMethodType: The payment method type (for example: Visa).
-     * - **Max Length:** 100
+     * @property paymentMethodType: Payment Method Type
+     * - **Max Length:** 64
      *
-     * @property zoneId: The zone ID.
+     * @property zoneId: The unique identifier for a Payments zone.
+     * - **Pattern:** /^[a-zA-Z0-9\\-_]{1,100}$/
+     * - **Min Length:** 1
      * - **Max Length:** 100
      *
+     * @property shippingPreference: Shipping preference for PayPal payment processing. Applicable only for basket payment instruments.
+     * - **Max Length:** 64
+     *
+     * @property gateway: The payment gateway used to process the payment.
+     *
+     * @property gatewayProperties:
+     *
      */
-    type SalesforcePaymentsRequest = {
+    type PaymentReferenceRequest = {
         paymentMethodType?: string;
         zoneId?: string;
+        shippingPreference?: PaymentReferenceRequestShippingPreferenceEnum;
+        gateway?: PaymentReferenceRequestGatewayEnum;
+        gatewayProperties?: OrderPaymentInstrumentPaymentReferenceGatewayProperties;
     } & {
         [key: string]: any;
     };
+    type PaymentReferenceRequestShippingPreferenceEnum = "GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS";
+    type PaymentReferenceRequestGatewayEnum = "stripe" | "paypal" | "adyen";
     /**
      * @type OrderPaymentInstrumentRequest: Document representing an order payment instrument request.
      *
@@ -3292,7 +3724,7 @@ declare namespace ShopperOrdersApiTypes {
      * @property paymentMethodId: The payment method ID.
      * - **Max Length:** 256
      *
-     * @property paymentReferenceRequest: The payment reference request used by Salesforce Payments.
+     * @property paymentReferenceRequest: Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
      *
      */
     type OrderPaymentInstrumentRequest = {
@@ -3301,7 +3733,7 @@ declare namespace ShopperOrdersApiTypes {
         giftCertificateCode?: string;
         paymentCard?: OrderPaymentCardRequest;
         paymentMethodId?: string;
-        paymentReferenceRequest?: SalesforcePaymentsRequest;
+        paymentReferenceRequest?: PaymentReferenceRequest;
     } & {
         [key: string]: any;
     };
@@ -3416,6 +3848,7 @@ declare namespace ShopperOrdersApiTypes {
     } & {
         [key: string]: any;
     };
+    type GetOrderExpandEnum = "som" | "som_shipments";
     type createOrderQueryParameters = {
         siteId: string;
         locale?: LocaleCode$0;
@@ -3431,9 +3864,19 @@ declare namespace ShopperOrdersApiTypes {
         organizationId: string;
         orderNo: string;
     };
+    type failOrderQueryParameters = {
+        siteId: string;
+        locale?: LocaleCode$0;
+        reopenBasket?: boolean;
+    };
+    type failOrderPathParameters = {
+        organizationId: string;
+        orderNo: string;
+    };
     type getOrderQueryParameters = {
         siteId: string;
         locale?: LocaleCode$0;
+        expand?: Array<"som" | "som_shipments">;
     };
     type getOrderPathParameters = {
         orderNo: string;
@@ -3483,11 +3926,11 @@ declare namespace ShopperOrdersApiTypes {
     /**
      * All path parameters that are used by at least one ShopperOrders method.
      */
-    type ShopperOrdersPathParameters = Partial<createOrderPathParameters & createPaymentInstrumentForOrderPathParameters & getOrderPathParameters & getPaymentMethodsForOrderPathParameters & getTaxesFromOrderPathParameters & guestOrderLookupPathParameters & removePaymentInstrumentFromOrderPathParameters & updatePaymentInstrumentForOrderPathParameters & {}>;
+    type ShopperOrdersPathParameters = Partial<createOrderPathParameters & createPaymentInstrumentForOrderPathParameters & failOrderPathParameters & getOrderPathParameters & getPaymentMethodsForOrderPathParameters & getTaxesFromOrderPathParameters & guestOrderLookupPathParameters & removePaymentInstrumentFromOrderPathParameters & updatePaymentInstrumentForOrderPathParameters & {}>;
     /**
      * All query parameters that are used by at least one ShopperOrders method.
      */
-    type ShopperOrdersQueryParameters = Partial<createOrderQueryParameters & createPaymentInstrumentForOrderQueryParameters & getOrderQueryParameters & getPaymentMethodsForOrderQueryParameters & getTaxesFromOrderQueryParameters & guestOrderLookupQueryParameters & removePaymentInstrumentFromOrderQueryParameters & updatePaymentInstrumentForOrderQueryParameters & {}>;
+    type ShopperOrdersQueryParameters = Partial<createOrderQueryParameters & createPaymentInstrumentForOrderQueryParameters & failOrderQueryParameters & getOrderQueryParameters & getPaymentMethodsForOrderQueryParameters & getTaxesFromOrderQueryParameters & guestOrderLookupQueryParameters & removePaymentInstrumentFromOrderQueryParameters & updatePaymentInstrumentForOrderQueryParameters & {}>;
     /**
      * All parameters that are used by ShopperOrders.
      */
@@ -3496,7 +3939,9 @@ declare namespace ShopperOrdersApiTypes {
      * [Shopper Orders](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-orders:Summary)
      * ==================================
      *
-     * *# API Overview
+     * *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-orders/shopper-orders-oas-v1-public.yaml)
+     
+     # API Overview
      
      The Shopper Orders API enables you to:
      
@@ -3559,6 +4004,7 @@ declare namespace ShopperOrdersApiTypes {
         static readonly apiPaths: {
             createOrder: string;
             createPaymentInstrumentForOrder: string;
+            failOrder: string;
             getOrder: string;
             getPaymentMethodsForOrder: string;
             getTaxesFromOrder: string;
@@ -3588,11 +4034,24 @@ declare namespace ShopperOrdersApiTypes {
                 "orderNo",
                 "siteId"
             ];
+            readonly failOrder: readonly [
+                "organizationId",
+                "orderNo",
+                "siteId",
+                "locale",
+                "reopenBasket"
+            ];
+            readonly failOrderRequired: readonly [
+                "organizationId",
+                "orderNo",
+                "siteId"
+            ];
             readonly getOrder: readonly [
                 "orderNo",
                 "organizationId",
                 "siteId",
-                "locale"
+                "locale",
+                "expand"
             ];
             readonly getOrderRequired: readonly [
                 "orderNo",
@@ -3774,6 +4233,71 @@ declare namespace ShopperOrdersApiTypes {
             };
             body: OrderPaymentInstrumentRequest & CustomRequestBody;
         }>, rawResponse?: T): Promise<T extends true ? Response : Order>;
+        /**
+         * Fails an unplaced order and optionally reopens the basket when indicated.
+         Creates a HistoryEntry in the failed Order with provided reasonCode.
+         *
+         * If you would like to get a raw Response object use the other failOrder function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.orderNo - The order number of the order to be modified.
+         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+         * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+         * @param options.parameters.reopenBasket - Set to true to reopen basket from the order.
+         A basket can only be reopened if no other basket for the customer exists at the moment of the call to fail Order,
+         since a customer is limited to 1 storefront basket at a time.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         *
+         * @returns A promise of type void.
+         */
+        failOrder(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                orderNo: string;
+                siteId: string;
+                locale?: LocaleCode$0;
+                reopenBasket?: boolean;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: FailOrderRequest & CustomRequestBody;
+        }>): Promise<void>;
+        /**
+         * Fails an unplaced order and optionally reopens the basket when indicated.
+         Creates a HistoryEntry in the failed Order with provided reasonCode.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.orderNo - The order number of the order to be modified.
+         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+         * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+         * @param options.parameters.reopenBasket - Set to true to reopen basket from the order.
+         A basket can only be reopened if no other basket for the customer exists at the moment of the call to fail Order,
+         since a customer is limited to 1 storefront basket at a time.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         * @param rawResponse - Set to true to return entire Response object instead of DTO.
+         *
+         * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
+         */
+        failOrder<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                orderNo: string;
+                siteId: string;
+                locale?: LocaleCode$0;
+                reopenBasket?: boolean;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: FailOrderRequest & CustomRequestBody;
+        }>, rawResponse?: T): Promise<T extends true ? Response : void>;
         /**
          * Gets information for an order.
          *
@@ -3785,6 +4309,12 @@ declare namespace ShopperOrdersApiTypes {
          * @param options.parameters.organizationId - An identifier for the organization the request is being made by
          * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
          * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+         * @param options.parameters.expand - When a 'som' expand is selected, data is primarily loaded from Salesforce Order Management (SOM), if available.
+         When data is available in SOM, the expand parameter has the following behavior:
+         "expand=som": order and related order entities (product items, delivery group, etc) are returned.
+         "expand=som_shipments": order and fulfillment (shipment) data is returned.
+         "expand=som,som_shipments": order, related order entities and fulfillment (shipment) data is returned
+         If your instance is not integrated with SOM or the order data is not available, the `expand=som` command is disregarded.
          * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
          *
          * @returns A promise of type Order.
@@ -3795,6 +4325,7 @@ declare namespace ShopperOrdersApiTypes {
                 organizationId: string;
                 siteId: string;
                 locale?: LocaleCode$0;
+                expand?: Array<GetOrderExpandEnum>;
             } & QueryParameters, ConfigParameters>;
             headers?: {
                 [key: string]: string;
@@ -3809,6 +4340,12 @@ declare namespace ShopperOrdersApiTypes {
          * @param options.parameters.organizationId - An identifier for the organization the request is being made by
          * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
          * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+         * @param options.parameters.expand - When a 'som' expand is selected, data is primarily loaded from Salesforce Order Management (SOM), if available.
+         When data is available in SOM, the expand parameter has the following behavior:
+         "expand=som": order and related order entities (product items, delivery group, etc) are returned.
+         "expand=som_shipments": order and fulfillment (shipment) data is returned.
+         "expand=som,som_shipments": order, related order entities and fulfillment (shipment) data is returned
+         If your instance is not integrated with SOM or the order data is not available, the `expand=som` command is disregarded.
          * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
          * @param rawResponse - Set to true to return entire Response object instead of DTO.
          *
@@ -3820,6 +4357,7 @@ declare namespace ShopperOrdersApiTypes {
                 organizationId: string;
                 siteId: string;
                 locale?: LocaleCode$0;
+                expand?: Array<GetOrderExpandEnum>;
             } & QueryParameters, ConfigParameters>;
             headers?: {
                 [key: string]: string;
@@ -4187,6 +4725,56 @@ declare namespace ShopperOrdersModelTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type OrderPaymentInstrumentPaymentReferenceGatewayProperties: The payment gateway specific properties.
+     *
+     * @property stripe: Stripe specific properties.
+     *
+     * @property adyen: Ayden specific properties.
+     *
+     * @property paypal: PayPal specific properties.
+     *
+     */
+    type OrderPaymentInstrumentPaymentReferenceGatewayProperties = {
+        stripe?: {
+            [key: string]: any;
+        };
+        adyen?: {
+            [key: string]: any;
+        };
+        paypal?: {
+            [key: string]: any;
+        };
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type OrderPaymentInstrumentPaymentReference: Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
+     *
+     * @property paymentReferenceId: Payment reference identifier. Can be payment intent ID for Stripe, PSP reference for Adyen, PayPal order ID for PayPal, or similar identifier for other payment providers.
+     * - **Max Length:** 256
+     *
+     * @property clientSecret: Client secret for payment confirmation. Used primarily by Stripe for client-side payment confirmation.
+     * - **Max Length:** 256
+     *
+     * @property redirectUrl: Redirect URL for payment methods that require user redirection to complete payment.
+     * - **Max Length:** 2048
+     *
+     * @property gateway: The payment gateway used to process the payment.
+     *
+     * @property gatewayProperties:
+     *
+     */
+    type OrderPaymentInstrumentPaymentReference = {
+        paymentReferenceId?: string;
+        clientSecret?: string;
+        redirectUrl?: string;
+        gateway?: OrderPaymentInstrumentPaymentReferenceGatewayEnum;
+        gatewayProperties?: OrderPaymentInstrumentPaymentReferenceGatewayProperties;
+    } & {
+        [key: string]: any;
+    };
+    type OrderPaymentInstrumentPaymentReferenceGatewayEnum = "stripe" | "paypal" | "adyen";
     /**
      * @type PaymentCard: Document representing a payment card.
      *
@@ -4252,6 +4840,8 @@ declare namespace ShopperOrdersModelTypes {
      * @property paymentMethodId: The payment method ID. It is read only.
      * - **Max Length:** 256
      *
+     * @property paymentReference:
+     *
      */
     type OrderPaymentInstrument = {
         amount?: number;
@@ -4261,6 +4851,7 @@ declare namespace ShopperOrdersModelTypes {
         paymentCard?: PaymentCard;
         paymentInstrumentId?: string;
         paymentMethodId?: string;
+        paymentReference?: OrderPaymentInstrumentPaymentReference;
     } & {
         [key: string]: any;
     };
@@ -4800,6 +5391,21 @@ declare namespace ShopperOrdersModelTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type SomInfo: Additional information retrieved from Salesforce Order Management (SOM)  See https://developer.salesforce.com/docs/atlas.en-us.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_orderitemsummary.htm for more information.
+     *
+     * @property status: Salesforce Order Management (SOM) status
+     *
+     * @property quantityAvailableToCancel: The quantity that can be cancelled.
+     *
+     */
+    type SomInfo = {
+        status?: SomInfoStatusEnum;
+        quantityAvailableToCancel?: number;
+    } & {
+        [key: string]: any;
+    };
+    type SomInfoStatusEnum = "ordered" | "returned" | "canceled" | "paid" | "reshipped" | "fulfilled" | "partially_fulfilled" | "allocated" | "partially_allocated" | "return_initiated";
     /**
      * @type ProductItem: Document representing a product item.
      *
@@ -4850,6 +5456,8 @@ declare namespace ShopperOrdersModelTypes {
      *
      * @property shippingItemId: If the product line item has a related shipping item, this value is its ID. A related shipping item represents a surcharge applied to individual products using a particular shipping method. It is read only.
      *
+     * @property somInfo:
+     *
      * @property tax: The tax for the product item, not including price adjustments. It is read only.
      *
      * @property taxBasis: The price used to calculate the tax for this product item. It is read only.
@@ -4882,6 +5490,7 @@ declare namespace ShopperOrdersModelTypes {
         quantity?: number;
         shipmentId?: string;
         shippingItemId?: string;
+        somInfo?: SomInfo;
         tax?: number;
         taxBasis?: number;
         taxClassId?: string;
@@ -5019,11 +5628,86 @@ declare namespace ShopperOrdersModelTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type FailOrderRequest: Document representing a fail order request.
+     *
+     * @property reasonCode: The reason code for failing the order.
+     *
+     */
+    type FailOrderRequest = {
+        reasonCode?: FailOrderRequestReasonCodeEnum;
+    } & {
+        [key: string]: any;
+    };
+    type FailOrderRequestReasonCodeEnum = "payment_confirm_failure" | "payment_capture_failure" | "payment_auth_failure";
     /**
      * @type LocaleCode
      * A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
      */
     type LocaleCode = DefaultFallback | string;
+    /**
+     * @type ShipmentItem: Individual item within a shipment
+     *
+     * @property id: Unique identifier for the shipment item
+     *
+     * @property productItemId: Reference to the product item in the order
+     *
+     * @property quantity: Quantity of product items with the referenced productItemId in this shipment
+     *
+     */
+    type ShipmentItem = {
+        id?: string;
+        productItemId?: string;
+        quantity?: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type SchemasShipment: Shipment information from Salesforce Order Management created during fulfillment process. See https://developer.salesforce.com/docs/atlas.en-us.230.0.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_fulfillmentorder.htm for more information.
+     *
+     * @property id: Unique identifier for the shipment
+     *
+     * @property status: Current status of the shipment
+     *
+     * @property provider: Shipping provider name
+     *
+     * @property trackingNumber: Tracking number for the shipment
+     *
+     * @property trackingUrl: URL to track the shipment
+     *
+     * @property expectedDeliveryDate: Expected delivery date and time
+     *
+     * @property actualDeliveryDate: Actual delivery date and time (null if not yet delivered)
+     *
+     * @property shipmentItems: Items included in this shipment
+     *
+     */
+    type SchemasShipment = {
+        id?: string;
+        status?: string;
+        provider?: string;
+        trackingNumber?: string;
+        trackingUrl?: string;
+        expectedDeliveryDate?: string;
+        actualDeliveryDate?: string;
+        shipmentItems?: Array<ShipmentItem>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type SchemasSomInfo: Additional information retrieved from Salesforce Order Management (SOM)  See https://developer.salesforce.com/docs/atlas.en-us.order_management_developer_guide.meta/order_management_developer_guide/sforce_api_objects_ordersummary.htm for more information.
+     *
+     * @property status: Current status of the order
+     *
+     * @property shipments: List of shipments associated with the order
+     *
+     */
+    type SchemasSomInfo = {
+        status?: string;
+        shipments?: Array<SchemasShipment>;
+    } & {
+        [key: string]: any;
+    };
     /**
      * @type Order: Document representing an order.
      *
@@ -5101,6 +5785,8 @@ declare namespace ShopperOrdersModelTypes {
      * - **Min Length:** 1
      * - **Max Length:** 32
      *
+     * @property somInfo:
+     *
      * @property sourceCode: The source code assigned to the basket from which this order was created. It is read only.
      *
      * @property status: The status.
@@ -5150,6 +5836,7 @@ declare namespace ShopperOrdersModelTypes {
         shippingTotal?: number;
         shippingTotalTax?: number;
         siteId?: string;
+        somInfo?: SchemasSomInfo;
         sourceCode?: string;
         status?: OrderStatusEnum;
         taxTotal?: number;
@@ -5221,21 +5908,35 @@ declare namespace ShopperOrdersModelTypes {
         [key: string]: any;
     };
     /**
-     * @type SalesforcePaymentsRequest: Document representing a Salesforce Payments request.
+     * @type PaymentReferenceRequest: Properties for Payments Reference Request
      *
-     * @property paymentMethodType: The payment method type (for example: Visa).
-     * - **Max Length:** 100
+     * @property paymentMethodType: Payment Method Type
+     * - **Max Length:** 64
      *
-     * @property zoneId: The zone ID.
+     * @property zoneId: The unique identifier for a Payments zone.
+     * - **Pattern:** /^[a-zA-Z0-9\\-_]{1,100}$/
+     * - **Min Length:** 1
      * - **Max Length:** 100
      *
+     * @property shippingPreference: Shipping preference for PayPal payment processing. Applicable only for basket payment instruments.
+     * - **Max Length:** 64
+     *
+     * @property gateway: The payment gateway used to process the payment.
+     *
+     * @property gatewayProperties:
+     *
      */
-    type SalesforcePaymentsRequest = {
+    type PaymentReferenceRequest = {
         paymentMethodType?: string;
         zoneId?: string;
+        shippingPreference?: PaymentReferenceRequestShippingPreferenceEnum;
+        gateway?: PaymentReferenceRequestGatewayEnum;
+        gatewayProperties?: OrderPaymentInstrumentPaymentReferenceGatewayProperties;
     } & {
         [key: string]: any;
     };
+    type PaymentReferenceRequestShippingPreferenceEnum = "GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS";
+    type PaymentReferenceRequestGatewayEnum = "stripe" | "paypal" | "adyen";
     /**
      * @type OrderPaymentInstrumentRequest: Document representing an order payment instrument request.
      *
@@ -5252,7 +5953,7 @@ declare namespace ShopperOrdersModelTypes {
      * @property paymentMethodId: The payment method ID.
      * - **Max Length:** 256
      *
-     * @property paymentReferenceRequest: The payment reference request used by Salesforce Payments.
+     * @property paymentReferenceRequest: Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
      *
      */
     type OrderPaymentInstrumentRequest = {
@@ -5261,7 +5962,7 @@ declare namespace ShopperOrdersModelTypes {
         giftCertificateCode?: string;
         paymentCard?: OrderPaymentCardRequest;
         paymentMethodId?: string;
-        paymentReferenceRequest?: SalesforcePaymentsRequest;
+        paymentReferenceRequest?: PaymentReferenceRequest;
     } & {
         [key: string]: any;
     };
@@ -5384,6 +6085,9 @@ declare namespace ShopperOrdersTypes {
     type createOrderPathParameters = ShopperOrdersApiTypes.createOrderPathParameters;
     type createPaymentInstrumentForOrderQueryParameters = ShopperOrdersApiTypes.createPaymentInstrumentForOrderQueryParameters;
     type createPaymentInstrumentForOrderPathParameters = ShopperOrdersApiTypes.createPaymentInstrumentForOrderPathParameters;
+    type failOrderQueryParameters = ShopperOrdersApiTypes.failOrderQueryParameters;
+    type failOrderPathParameters = ShopperOrdersApiTypes.failOrderPathParameters;
+    type GetOrderExpandEnum = ShopperOrdersApiTypes.GetOrderExpandEnum;
     type getOrderQueryParameters = ShopperOrdersApiTypes.getOrderQueryParameters;
     type getOrderPathParameters = ShopperOrdersApiTypes.getOrderPathParameters;
     type getPaymentMethodsForOrderQueryParameters = ShopperOrdersApiTypes.getPaymentMethodsForOrderQueryParameters;
@@ -5408,6 +6112,8 @@ declare namespace ShopperOrdersTypes {
     type Discount = ShopperOrdersModelTypes.Discount;
     type DiscountTypeEnum = ShopperOrdersModelTypes.DiscountTypeEnum;
     type ErrorResponse = ShopperOrdersModelTypes.ErrorResponse;
+    type FailOrderRequest = ShopperOrdersModelTypes.FailOrderRequest;
+    type FailOrderRequestReasonCodeEnum = ShopperOrdersModelTypes.FailOrderRequestReasonCodeEnum;
     type GiftCertificateItem = ShopperOrdersModelTypes.GiftCertificateItem;
     type GroupedTaxItem = ShopperOrdersModelTypes.GroupedTaxItem;
     type LocaleCode = ShopperOrdersModelTypes.LocaleCode;
@@ -5425,11 +6131,17 @@ declare namespace ShopperOrdersTypes {
     type OrderLookupRequest = ShopperOrdersModelTypes.OrderLookupRequest;
     type OrderPaymentCardRequest = ShopperOrdersModelTypes.OrderPaymentCardRequest;
     type OrderPaymentInstrument = ShopperOrdersModelTypes.OrderPaymentInstrument;
+    type OrderPaymentInstrumentPaymentReference = ShopperOrdersModelTypes.OrderPaymentInstrumentPaymentReference;
+    type OrderPaymentInstrumentPaymentReferenceGatewayEnum = ShopperOrdersModelTypes.OrderPaymentInstrumentPaymentReferenceGatewayEnum;
+    type OrderPaymentInstrumentPaymentReferenceGatewayProperties = ShopperOrdersModelTypes.OrderPaymentInstrumentPaymentReferenceGatewayProperties;
     type OrderPaymentInstrumentRequest = ShopperOrdersModelTypes.OrderPaymentInstrumentRequest;
     type PaymentCard = ShopperOrdersModelTypes.PaymentCard;
     type PaymentCardSpec = ShopperOrdersModelTypes.PaymentCardSpec;
     type PaymentMethod = ShopperOrdersModelTypes.PaymentMethod;
     type PaymentMethodResult = ShopperOrdersModelTypes.PaymentMethodResult;
+    type PaymentReferenceRequest = ShopperOrdersModelTypes.PaymentReferenceRequest;
+    type PaymentReferenceRequestShippingPreferenceEnum = ShopperOrdersModelTypes.PaymentReferenceRequestShippingPreferenceEnum;
+    type PaymentReferenceRequestGatewayEnum = ShopperOrdersModelTypes.PaymentReferenceRequestGatewayEnum;
     type PriceAdjustment = ShopperOrdersModelTypes.PriceAdjustment;
     type ProductDetailsLink = ShopperOrdersModelTypes.ProductDetailsLink;
     type ProductItem = ShopperOrdersModelTypes.ProductItem;
@@ -5437,15 +6149,19 @@ declare namespace ShopperOrdersTypes {
     type ProductListItemReferenceTypeEnum = ShopperOrdersModelTypes.ProductListItemReferenceTypeEnum;
     type ProductListLink = ShopperOrdersModelTypes.ProductListLink;
     type ProductListLinkTypeEnum = ShopperOrdersModelTypes.ProductListLinkTypeEnum;
-    type SalesforcePaymentsRequest = ShopperOrdersModelTypes.SalesforcePaymentsRequest;
+    type SchemasShipment = ShopperOrdersModelTypes.SchemasShipment;
+    type SchemasSomInfo = ShopperOrdersModelTypes.SchemasSomInfo;
     type Shipment = ShopperOrdersModelTypes.Shipment;
     type ShipmentShippingStatusEnum = ShopperOrdersModelTypes.ShipmentShippingStatusEnum;
+    type ShipmentItem = ShopperOrdersModelTypes.ShipmentItem;
     type ShippingItem = ShopperOrdersModelTypes.ShippingItem;
     type ShippingMethod = ShopperOrdersModelTypes.ShippingMethod;
     type ShippingPromotion = ShopperOrdersModelTypes.ShippingPromotion;
+    type SomInfo = ShopperOrdersModelTypes.SomInfo;
+    type SomInfoStatusEnum = ShopperOrdersModelTypes.SomInfoStatusEnum;
     type Status = ShopperOrdersModelTypes.Status;
     type TaxItem = ShopperOrdersModelTypes.TaxItem;
     type TaxItems = ShopperOrdersModelTypes.TaxItems;
     type Taxes = ShopperOrdersModelTypes.Taxes;
 }
-export { defaultBaseUri, createOrderQueryParameters, createOrderPathParameters, createPaymentInstrumentForOrderQueryParameters, createPaymentInstrumentForOrderPathParameters, getOrderQueryParameters, getOrderPathParameters, getPaymentMethodsForOrderQueryParameters, getPaymentMethodsForOrderPathParameters, getTaxesFromOrderQueryParameters, getTaxesFromOrderPathParameters, guestOrderLookupQueryParameters, guestOrderLookupPathParameters, removePaymentInstrumentFromOrderQueryParameters, removePaymentInstrumentFromOrderPathParameters, updatePaymentInstrumentForOrderQueryParameters, updatePaymentInstrumentForOrderPathParameters, ShopperOrdersPathParameters, ShopperOrdersQueryParameters, ShopperOrdersParameters, ShopperOrders, Basket, BasketChannelTypeEnum, BasketTaxationEnum, BonusDiscountLineItem, CouponItem, CouponItemStatusCodeEnum, CurrencyCode, CustomerInfo, DefaultFallback, Discount, DiscountTypeEnum, ErrorResponse, GiftCertificateItem, GroupedTaxItem, LocaleCode$0 as LocaleCode, NoValue, OptionItem, Order, OrderChannelTypeEnum, OrderConfirmationStatusEnum, OrderExportStatusEnum, OrderPaymentStatusEnum, OrderShippingStatusEnum, OrderStatusEnum, OrderTaxationEnum, OrderAddress, OrderLookupRequest, OrderPaymentCardRequest, OrderPaymentInstrument, OrderPaymentInstrumentRequest, PaymentCard, PaymentCardSpec, PaymentMethod, PaymentMethodResult, PriceAdjustment, ProductDetailsLink, ProductItem, ProductListItemReference, ProductListItemReferenceTypeEnum, ProductListLink, ProductListLinkTypeEnum, SalesforcePaymentsRequest, Shipment, ShipmentShippingStatusEnum, ShippingItem, ShippingMethod, ShippingPromotion, Status, TaxItem, TaxItems, Taxes, ShopperOrdersTypes };
+export { defaultBaseUri, GetOrderExpandEnum, createOrderQueryParameters, createOrderPathParameters, createPaymentInstrumentForOrderQueryParameters, createPaymentInstrumentForOrderPathParameters, failOrderQueryParameters, failOrderPathParameters, getOrderQueryParameters, getOrderPathParameters, getPaymentMethodsForOrderQueryParameters, getPaymentMethodsForOrderPathParameters, getTaxesFromOrderQueryParameters, getTaxesFromOrderPathParameters, guestOrderLookupQueryParameters, guestOrderLookupPathParameters, removePaymentInstrumentFromOrderQueryParameters, removePaymentInstrumentFromOrderPathParameters, updatePaymentInstrumentForOrderQueryParameters, updatePaymentInstrumentForOrderPathParameters, ShopperOrdersPathParameters, ShopperOrdersQueryParameters, ShopperOrdersParameters, ShopperOrders, Basket, BasketChannelTypeEnum, BasketTaxationEnum, BonusDiscountLineItem, CouponItem, CouponItemStatusCodeEnum, CurrencyCode, CustomerInfo, DefaultFallback, Discount, DiscountTypeEnum, ErrorResponse, FailOrderRequest, FailOrderRequestReasonCodeEnum, GiftCertificateItem, GroupedTaxItem, LocaleCode$0 as LocaleCode, NoValue, OptionItem, Order, OrderChannelTypeEnum, OrderConfirmationStatusEnum, OrderExportStatusEnum, OrderPaymentStatusEnum, OrderShippingStatusEnum, OrderStatusEnum, OrderTaxationEnum, OrderAddress, OrderLookupRequest, OrderPaymentCardRequest, OrderPaymentInstrument, OrderPaymentInstrumentPaymentReference, OrderPaymentInstrumentPaymentReferenceGatewayEnum, OrderPaymentInstrumentPaymentReferenceGatewayProperties, OrderPaymentInstrumentRequest, PaymentCard, PaymentCardSpec, PaymentMethod, PaymentMethodResult, PaymentReferenceRequest, PaymentReferenceRequestShippingPreferenceEnum, PaymentReferenceRequestGatewayEnum, PriceAdjustment, ProductDetailsLink, ProductItem, ProductListItemReference, ProductListItemReferenceTypeEnum, ProductListLink, ProductListLinkTypeEnum, SchemasShipment, SchemasSomInfo, Shipment, ShipmentShippingStatusEnum, ShipmentItem, ShippingItem, ShippingMethod, ShippingPromotion, SomInfo, SomInfoStatusEnum, Status, TaxItem, TaxItems, Taxes, ShopperOrdersTypes };