Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

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

    Methods

    • Retrieves an Order with the provided id in a Store 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 Orders exists in the Store with the provided `id`.
      - If an Order exists but does not have a `store` specified, or the `store` field references a different Store.
      - If an 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>

    • Checks if an Order exists with the provided id in a Store 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 in the Store with the provided `id`.
      - If an Order exists but does not have a `store` specified, or the `store` field references a different Store.
      - If an 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>