Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder

Index

Constructors

constructor

new ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: {
            associateId: string;
            businessUnitKey: string;
            projectKey: string;
        };
    },
): ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: {
          associateId: string;
          businessUnitKey: string;
          projectKey: string;
      };
  }
Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder
- Defined in generated/client/carts/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:15

Properties

`Protected` `Readonly`args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: {
        associateId: string;
        businessUnitKey: string;
        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<CartPagedQueryResponse>
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-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:66

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. 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-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:98

post

post(
    methodArgs: {
        body: CartDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Cart>
Creates a Cart in the BusinessUnit referenced by businessUnitKey. As such, the businessUnit field on CartDraft is ignored for this request. Creating a Cart can fail with an InvalidOperation if the referenced ShippingMethod in the CartDraft has a predicate that does not match the Cart.
```
Specific Error Codes:

- [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError)
- [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError)
- [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError)
- [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError)
```
Parameters
- methodArgs: {
      body: CartDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<Cart>
- Defined in generated/client/carts/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:134

replicate

replicate(): ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder
Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder
- Defined in generated/client/carts/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:54

withId

withId(
childPathArgs: { ID: string },
): ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder
Parameters
- childPathArgs: { ID: string }
Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder
- Defined in generated/client/carts/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:40

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder
- Defined in generated/client/carts/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-carts-request-builder.ts:26

Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder

Properties

`Protected` `Readonly`args

Methods

get

Parameters

Returns ApiRequest<CartPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<Cart>

replicate

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder

withId

Parameters

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder

Settings

On This Page

Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsRequestBuilder

Properties

Protected Readonlyargs

Methods

get

Parameters

Returns ApiRequest<CartPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<Cart>

replicate

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsReplicateRequestBuilder

withId

Parameters

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyRequestBuilder

Settings

On This Page

`Protected` `Readonly`args