Class ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberRequestBuilder

Constructors

Properties

Methods

Constructors

Properties

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

Type declaration

  • Optional baseUri?: string
  • executeRequest: executeRequest
  • pathArgs: {
        orderNumber: string;
        projectKey: string;
        storeKey: string;
    }
    • orderNumber: string
    • projectKey: string
    • storeKey: string

Methods

  • If the Order exists in the Project but does not have the store field, or the store field references a different Store, this method returns a ResourceNotFound error.

    Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message.
    

    Parameters

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

    Returns ApiRequest<Order>