Class ByProjectKeyMeOrdersByIDRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

new ByProjectKeyMeOrdersByIDRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { ID: string; projectKey: string };
    },
): ByProjectKeyMeOrdersByIDRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { ID: string; projectKey: string };
  }
Returns ByProjectKeyMeOrdersByIDRequestBuilder
- Defined in generated/client/orders/by-project-key-me-orders-by-id-request-builder.ts:12

Properties

`Protected` `Readonly`args

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

Methods

get

get(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Order>
Retrieves an Order with the provided id for the authenticated Customer or anonymous user. Returns a 200 status if successful.
```
A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:

- If no Order exists for the provided `id`.
- If the Order exists but does not have either a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or an `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>
- Defined in generated/client/orders/by-project-key-me-orders-by-id-request-builder.ts:31

head

head(
methodArgs?: { headers?: { [key: string]: string | string[] } },
): ApiRequest<void>
Checks if an Order exists with the provided id for the authenticated Customer or anonymous user. Returns a 200 status if successful.
```
A [Not Found](/../api/errors#404-not-found) error is returned in the following scenarios:

- If no Order exists for the provided `id`.
- If the Order exists but does not have either a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
```
Parameters
- OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }
Returns ApiRequest<void>
- Defined in generated/client/orders/by-project-key-me-orders-by-id-request-builder.ts:63