Function listOrdersForOrganizationHandler

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

  • Get orders for organization 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

    • customFieldDefinition: 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: paginated list of orders

    Description

    This handler is used to get orders for an organization by applying the following steps in sequence:

    1. Checks orgId provided

    2. Performs pagination query using query params

    3. Applies expansion using query params

    4. Returns paginated list

    Throws

    Error

    • orgId is missing in params

    Throws

    400 NBError Bad Request

Settings

Member Visibility

Theme

Generated using TypeDoc