Class ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Index

Constructors

constructor

new ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string; storeKey: string };
    },
): ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string; storeKey: string };
  }
Returns ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:17

Properties

`Protected` `Readonly`args

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

Methods

customerIdWithCustomerIdValueMerge

customerIdWithCustomerIdValueMerge(
childPathArgs: { customerId: string },
): ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdMergeRequestBuilder
Parameters
- childPathArgs: { customerId: string }
Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdMergeRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:41

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<CartPagedQueryResponse>
Retrieves Carts in a Store.
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<CartPagedQueryResponse>
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:92

head

head(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if one or more Carts exist for the provided query predicate in a Store. Returns a 200 status if any Carts match the query predicate, or a 404 status otherwise.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:123

post

post(
    methodArgs: {
        body: CartDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Cart>

Creates a Cart in a Store.

If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match, or if the Shipping Method is not active, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.

Specific Error Codes:

- [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError)
- [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError)
- [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError)
- [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError)
- [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError)

Parameters

methodArgs: {
    body: CartDraft;
    headers?: { [key: string]: string | string[] };
    queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
}

Returns ApiRequest<Cart>

replicate

replicate(): ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder
Returns ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder
- Defined in generated/client/carts/by-project-key-in-store-key-by-store-key-carts-request-builder.ts:67

withCustomerId

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

withId

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

withKey

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

Class ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Properties

`Protected` `Readonly`args

Methods

customerIdWithCustomerIdValueMerge

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdMergeRequestBuilder

get

Parameters

Returns ApiRequest<CartPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<Cart>

replicate

Returns ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder

withCustomerId

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder

withId

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder

Settings

On This Page

Class ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder

Properties

Protected Readonlyargs

Methods

customerIdWithCustomerIdValueMerge

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdMergeRequestBuilder

get

Parameters

Returns ApiRequest<CartPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<Cart>

replicate

Returns ByProjectKeyInStoreKeyByStoreKeyCartsReplicateRequestBuilder

withCustomerId

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdRequestBuilder

withId

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyRequestBuilder

Settings

On This Page

`Protected` `Readonly`args