Function listOrdersHandler

  • listOrdersHandler(userServiceAPI, catalogServiceAPI, organizationServiceAPI, orderService, orderCustomFieldDefinitions, paginationConfiguration, logger, context): Promise<{
        data: {
            @nextLink: string;
            @previousLink: string;
            count: number;
            total: number;
            value: ExpandedOrder[];
        };
        status: StatusCodes;
    }>

  • Get orders handler

    Parameters

    • userServiceAPI: UserDefaultAdapterAPI

      injected API use to handle user related operations

    • catalogServiceAPI: CatalogDefaultAdapterAPI

      injected API use to handle catalog related operations

    • organizationServiceAPI: OrganizationDefaultAdapterAPI

      injected API use to handle organization related operations

    • orderService: OrderDataService

      injected service use to handle order related operations

      • getPaginatedOrders
    • orderCustomFieldDefinitions: CustomField[]
    • paginationConfiguration: PaginationConfigurations
    • logger: Logger

      injected logger use to handle logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

      • params.orgId is required

    Returns Promise<{
        data: {
            @nextLink: string;
            @previousLink: string;
            count: number;
            total: number;
            value: ExpandedOrder[];
        };
        status: StatusCodes;
    }>

    200 Status OK

    • data: orders list

    Description

    This handler is used to get orders across all users and organizations.

    1. Parse the query to get the pagination options (util.parsePaginatedListQuery)

    2. Performs pagination query using query params

    3. Applies expansion using query params

    4. Get a list of orders across all users and organizations

    5. Return a list of orders

    Throws

    400 NBError Bad Request

    • error when parse paginated list query, ${error.message}

    Throws

    400 NBError Bad Request

    • pagination must be set

    Throws

    400 NBError Bad Request

    • Page size exceeds ${MAXIMUM_PAGE_SIZE} mbs

Settings

Member Visibility

Theme

Generated using TypeDoc