Class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Index

Constructors

constructor

new ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string; storeKey: string };
    },
): ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string; storeKey: string };
  }
Returns ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder
- Defined in generated/client/matching-cart/by-project-key-in-store-key-by-store-key-shipping-methods-matching-cart-request-builder.ts:12

Properties

`Protected` `Readonly`args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: { projectKey: string; storeKey: string };
}

Methods

get

get(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: {
            cartId: string;
            expand?: string | string[];
            [key: string]: QueryParam;
        };
    },
): ApiRequest<ShippingMethodPagedQueryResponse>
Retrieves the active ShippingMethods that can ship to the shipping address of the provided Cart in a Store.
```
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).

If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
```
Parameters
- methodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs: {
          cartId: string;
          expand?: string | string[];
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<ShippingMethodPagedQueryResponse>
- Defined in generated/client/matching-cart/by-project-key-in-store-key-by-store-key-shipping-methods-matching-cart-request-builder.ts:30

head

head(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: { cartId: string; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if an active ShippingMethod that can ship to the shipping address of the provided Cart exists in a Store. Returns a 200 OK status if the ShippingMethod exists or a Not Found error otherwise.
Parameters
- methodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs: { cartId: string; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/matching-cart/by-project-key-in-store-key-by-store-key-shipping-methods-matching-cart-request-builder.ts:58

Class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Properties

`Protected` `Readonly`args

Methods

get

Parameters

Returns ApiRequest<ShippingMethodPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

Settings

On This Page

Class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Properties

Protected Readonlyargs

Methods

get

Parameters

Returns ApiRequest<ShippingMethodPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

Settings

On This Page

`Protected` `Readonly`args