Class ByProjectKeyShippingMethodsRequestBuilder

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`args

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

Methods

get

get(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: {
            expand?: string | string[];
            limit?: number;
            offset?: number;
            sort?: string | string[];
            where?: string | string[];
            withTotal?: boolean;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<ShippingMethodPagedQueryResponse>
Retrieves all ShippingMethods in the Project.
Parameters
- OptionalmethodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs?: {
          expand?: string | string[];
          limit?: number;
          offset?: number;
          sort?: string | string[];
          where?: string | string[];
          withTotal?: boolean;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<ShippingMethodPagedQueryResponse>
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:107

head

head(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if one or more ShippingMethods exist for the provided query predicate. Returns a 200 OK status if any ShippingMethods match the query predicate or a Not Found error otherwise.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:138

matchingCart

matchingCart(): ByProjectKeyShippingMethodsMatchingCartRequestBuilder
Get matching ShippingMethods for a Cart

Returns ByProjectKeyShippingMethodsMatchingCartRequestBuilder
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:46

matchingCartLocation

matchingCartLocation(): ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder
Get matching ShippingMethods for a Cart and Location

Returns ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:58

matchingLocation

matchingLocation(): ByProjectKeyShippingMethodsMatchingLocationRequestBuilder
Get matching ShippingMethods for a Location

Returns ByProjectKeyShippingMethodsMatchingLocationRequestBuilder
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:82

matchingOrderedit

matchingOrderedit(): ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder
Get matching ShippingMethods for an OrderEdit

Returns ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:70

post

post(
    methodArgs: {
        body: ShippingMethodDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<ShippingMethod>
Creates a ShippingMethod in the Project.
Parameters
- methodArgs: {
      body: ShippingMethodDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<ShippingMethod>
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:164

withId

withId(
childPathArgs: { ID: string },
): ByProjectKeyShippingMethodsByIDRequestBuilder
Parameters
- childPathArgs: { ID: string }
Returns ByProjectKeyShippingMethodsByIDRequestBuilder
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:91

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyShippingMethodsKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyShippingMethodsKeyByKeyRequestBuilder
- Defined in generated/client/shipping-methods/by-project-key-shipping-methods-request-builder.ts:31

Class ByProjectKeyShippingMethodsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyShippingMethodsRequestBuilder

Properties

`Protected` `Readonly`args

Methods

get

Parameters

Returns ApiRequest<ShippingMethodPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

matchingCart

Returns ByProjectKeyShippingMethodsMatchingCartRequestBuilder

matchingCartLocation

Returns ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder

matchingLocation

Returns ByProjectKeyShippingMethodsMatchingLocationRequestBuilder

matchingOrderedit

Returns ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder

post

Parameters

Returns ApiRequest<ShippingMethod>

withId

Parameters

Returns ByProjectKeyShippingMethodsByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyShippingMethodsKeyByKeyRequestBuilder

Settings

On This Page

Class ByProjectKeyShippingMethodsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyShippingMethodsRequestBuilder

Properties

Protected Readonlyargs

Methods

get

Parameters

Returns ApiRequest<ShippingMethodPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

matchingCart

Returns ByProjectKeyShippingMethodsMatchingCartRequestBuilder

matchingCartLocation

Returns ByProjectKeyShippingMethodsMatchingCartLocationRequestBuilder

matchingLocation

Returns ByProjectKeyShippingMethodsMatchingLocationRequestBuilder

matchingOrderedit

Returns ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder

post

Parameters

Returns ApiRequest<ShippingMethod>

withId

Parameters

Returns ByProjectKeyShippingMethodsByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyShippingMethodsKeyByKeyRequestBuilder

Settings

On This Page

`Protected` `Readonly`args