• Get order 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

    • orderCustomFieldDefinitions: CustomField[]
    • logger: Logger

      injected logger use to handle logging

    • context: AdapterHandlerContext

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

      • params.orderId is required

    Returns Promise<{
        data: ExpandedOrder;
        status: StatusCodes;
    }>

    200 Status OK

    Description

    This handler is used to get an order by applying the following steps in sequence:

    1. Checks orderId provided

    2. Fetches order (orderService.getOneOrder)

    3. Return order data (expand if any)

    Throws

    400 NBError Bad Request

    • missing parameter orderId

    Throws

    404 NBError Not Found

    • operation failed to get an order

    Throws

    500 NBError Internal Server Error

    • failed to get an order orderId:${params?.orderId}

Generated using TypeDoc