Class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Index

Constructors

constructor

new ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder(args): ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: {
          projectKey: string;
          storeKey: string;
      };
  }
  - Optional baseUri?: string
  - executeRequest: executeRequest
  - pathArgs: {
    projectKey: string;
    storeKey: string;
    }
    - 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;
    };
}

Type declaration

Optional baseUri?: string
executeRequest: executeRequest
pathArgs: {
projectKey: string;
storeKey: string;
}
- projectKey: string
- storeKey: string

Methods

get

get(methodArgs): ApiRequest<ShippingMethodPagedQueryResponse>
Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given 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.
Parameters
- methodArgs: {
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs: {
          cartId: string;
          expand?: string | string[];
          [key: string]: QueryParam;
      };
  }
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - queryArgs: {
        cartId: string;
        expand?: string | string[];
        [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - cartId: string
    - Optional expand?: string | string[]
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:28

head

head(methodArgs): ApiRequest<void>
Checks if a ShippingMethod that can ship to the shipping address of the given Cart exists in the given Store. Returns a 200 OK status if the ShippingMethod exists or a 404 Not Found otherwise.
Parameters
- methodArgs: {
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs: {
          cartId: string;
          [key: string]: QueryParam;
      };
  }
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - queryArgs: {
    cartId: string;
    [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - cartId: string
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:56

Class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; storeKey: string; }

projectKey: string

storeKey: string

Returns ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartRequestBuilder

Properties

Protected Readonly args

Type declaration

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; storeKey: string; }

projectKey: string

storeKey: string

Methods

get

Parameters

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

queryArgs: { cartId: string; expand?: string | string[]; [key: string]: QueryParam; }

[key: string]: QueryParam

cartId: string

Optional expand?: string | string[]

Returns ApiRequest<ShippingMethodPagedQueryResponse>

head

Parameters

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

queryArgs: { cartId: string; [key: string]: QueryParam; }

[key: string]: QueryParam

cartId: string

Returns ApiRequest<void>

Settings

Member Visibility

Theme

On This Page

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
storeKey: string;
}

`Protected` `Readonly` args

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
storeKey: string;
}

`Optional` headers?: {
[key: string]: string | string[];
}

queryArgs: {
cartId: string;
expand?: string | string[];
[key: string]: QueryParam;
}

`Optional` expand?: string | string[]

`Optional` headers?: {
[key: string]: string | string[];
}

queryArgs: {
cartId: string;
[key: string]: QueryParam;
}