Class ByProjectKeyMeCartsByIDRequestBuilder

Constructors

constructor

Properties

args

Methods

delete get head post

Constructors

constructor

Properties

Protected Readonlyargs

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

Methods

delete

  • delete(
        methodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs: {
                expand?: string | string[];
                version: number;
                [key: string]: QueryParam;
            };
        },
    ): ApiRequest<Cart>

    Deletes the Cart for a given id. Returns a 200 OK status if successful.

    A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:

- If no Cart exists for a given `id`.
- If the Cart exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.

    Parameters

    • methodArgs: {
          headers?: { [key: string]: string | string[] };
          queryArgs: {
              expand?: string | string[];
              version: number;
              [key: string]: QueryParam;
          };
      }

    Returns ApiRequest<Cart>

get

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

    Returns a Cart for a given id. Returns a 200 OK status if successful.

    A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:

- If no Cart exists for a given `id`.
- If the Cart exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.

    Parameters

    • OptionalmethodArgs: {
          headers?: { [key: string]: string | string[] };
          queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
      }

    Returns ApiRequest<Cart>

head

  • head(
        methodArgs?: { headers?: { [key: string]: string | string[] } },
    ): ApiRequest<void>

    Checks if a Cart exists for a given id. Returns a 200 OK status if the Cart exists.

    A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:

- If no Cart exists for a given `id`.
- If the Cart exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.

    Parameters

    • OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }

    Returns ApiRequest<void>

post

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

    Updates the Cart for a given id. Returns a 200 OK status if successful.

    A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:

- If no Cart exists for a given `id`.
- If the Cart exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.

    Parameters

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

    Returns ApiRequest<Cart>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods