Class ByProjectKeyShippingMethodsMatchingCartRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected` `Readonly`args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: { projectKey: 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.
```
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-shipping-methods-matching-cart-request-builder.ts:29

head

head(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: { cartId: string; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if an active ShippingMethod exists for the provided Cart. 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-shipping-methods-matching-cart-request-builder.ts:56