useOrderDataProvider

Types

export function useOrderDataProvider(): UseOrderDataProviderReturn

source code

export type UseOrderDataProviderReturn = {
  /**
   * Get order object including additional associations.
   * useDefaults describes what order object should look like.
   */
  loadOrderDetails(
    orderSearchData: { keyValue: string; field?: string },
    associations?: Schemas["Criteria"]["associations"],
  ): Promise<Schemas["Order"] | null>;

  /**
   * Get media content
   *
   * @param {string} downloadId
   * @returns {Blob}
   */
  getMediaFile: (orderId: string, downloadId: string) => Promise<Blob>;

  /**
   * Get order documents
   * @param {string} documentId
   * @param {string} deepLinkCode
   * @returns
   */
  getDocumentFile: (
    documentId: string,
    deepLinkCode: string,
  ) => Promise<Schemas["Document"]>;
};

source code