Class ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder

Constructors

constructor

Properties

args

Methods

get head

Constructors

constructor

Properties

Protected Readonlyargs

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

Methods

get

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

    Returns an Order for a given id in a Store. Returns a 200 OK status if successful.

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

- If no Order exists in the Store for the given `id`.
- If the Order exists but does not have a `store` specified, or the `store` field references a different Store.
- If the Order 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<Order>

head

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

    Checks if an Order exists for a given id in a Store. Returns a 200 OK status if successful.

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

- If no Order exists in the Store for the given `id`.
- If the Order exists but does not have a `store` specified, or the `store` field references a different Store.
- If the Order 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>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods