Class ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Index

Constructors

constructor

new ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder(args): ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder
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 ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:16

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<CartPagedQueryResponse>
Queries carts in a specific Store.
Parameters
- Optional 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;
      };
  }
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - Optional queryArgs?: {
        expand?: string | string[];
        limit?: number;
        offset?: number;
        sort?: string | string[];
        where?: string | string[];
        withTotal?: boolean;
        [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - Optional expand?: string | string[]
    - Optional limit?: number
    - Optional offset?: number
    - Optional sort?: string | string[]
    - Optional where?: string | string[]
    - Optional withTotal?: boolean
Returns ApiRequest<CartPagedQueryResponse>
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:77

head

head(methodArgs?): ApiRequest<void>
Checks if a Cart exists for a given Query Predicate. Returns a 200 OK status if any Carts match the Query Predicate or a 404 Not Found otherwise.
Parameters
- Optional methodArgs: {
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs?: {
          where?: string | string[];
          [key: string]: QueryParam;
      };
  }
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - Optional queryArgs?: {
    where?: string | string[];
    [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - Optional where?: string | string[]
Returns ApiRequest<void>
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:108

post

post(methodArgs): ApiRequest<Cart>
Creates a Cart in the Store specified by storeKey. When using this endpoint the Cart's store field is always set to the Store specified in the path parameter. If the referenced ShippingMethod in the CartDraft has a predicate that does not match, an InvalidOperation error is returned.
Parameters
- methodArgs: {
      body: CartDraft;
      headers?: {
          [key: string]: string | string[];
      };
      queryArgs?: {
          expand?: string | string[];
          [key: string]: QueryParam;
      };
  }
  - body: CartDraft
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - Optional queryArgs?: {
    expand?: string | string[];
    [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - Optional expand?: string | string[]
Returns ApiRequest<Cart>
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:137

replicate

withCustomerId

withCustomerId(childPathArgs): ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder
Parameters
- childPathArgs: {
  customerId: string;
  }
  - customerId: string
Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:26

withId

withId(childPathArgs): ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder
Parameters
- childPathArgs: {
  ID: string;
  }
  - ID: string
Returns ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:61

withKey

withKey(childPathArgs): ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder
Parameters
- childPathArgs: {
  key: string;
  }
  - key: string
Returns ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:40

Class ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional baseUri?: string

executeRequest: executeRequest

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

projectKey: string

storeKey: string

Returns ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

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[]

Optional queryArgs?: { expand?: string | string[]; limit?: number; offset?: number; sort?: string | string[]; where?: string | string[]; withTotal?: boolean; [key: string]: QueryParam; }

[key: string]: QueryParam

Optional expand?: string | string[]

Optional limit?: number

Optional offset?: number

Optional sort?: string | string[]

Optional where?: string | string[]

Optional withTotal?: boolean

Returns ApiRequest<CartPagedQueryResponse>

head

Parameters

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

[key: string]: string | string[]

Optional queryArgs?: { where?: string | string[]; [key: string]: QueryParam; }

[key: string]: QueryParam

Optional where?: string | string[]

Returns ApiRequest<void>

post

Parameters

body: CartDraft

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

[key: string]: string | string[]

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

[key: string]: QueryParam

Optional expand?: string | string[]

Returns ApiRequest<Cart>

replicate

Returns ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder

withCustomerId

Parameters

customerId: string

Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder

withId

Parameters

ID: string

Returns ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder

withKey

Parameters

key: string

Returns ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder

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[];
}

`Optional` queryArgs?: {
expand?: string | string[];
limit?: number;
offset?: number;
sort?: string | string[];
where?: string | string[];
withTotal?: boolean;
[key: string]: QueryParam;
}

`Optional` expand?: string | string[]

`Optional` limit?: number

`Optional` offset?: number

`Optional` sort?: string | string[]

`Optional` where?: string | string[]

`Optional` withTotal?: boolean

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

`Optional` queryArgs?: {
where?: string | string[];
[key: string]: QueryParam;
}

`Optional` where?: string | string[]

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

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

`Optional` expand?: string | string[]