Requisition List Functions

The Requisition List drop-in provides API functions that enable you to programmatically control behavior, fetch data, and integrate with Adobe Commerce backend services.

Version: 0.7.0-beta

Function	Description
addProductsToRequisitionList	Adds products to a requisition list..
addRequisitionListItemsToCart	This function adds the chosen items from a requisition list to the logged-in user cart..
createRequisitionList	This function creates a new requisition list with the name and description provided for a logged-in user..
deleteRequisitionList	This function deletes a requisition list identified by uid..
deleteRequisitionListItems	Deletes items from a requisition list..
getRequisitionList	This function returns information about the desired requisition list from a logged-in user,..
getRequisitionLists	This function returns the requisition lists from a logged-in user..
updateRequisitionList	This function updates an existing requisition list with the name and description provided for a logged-in user..
updateRequisitionListItems	This function updates the items of an existing requisition list with the quantity and options provided for a logged-in user..

addProductsToRequisitionList

Adds products to a requisition list.

const addProductsToRequisitionList = async (
  requisitionListUid: string,
  requisitionListItems: Array<RequisitionListItemsInput>
): Promise<RequisitionList | null>

Parameter	Type	Req?	Description
requisitionListUid	string	Yes	See function signature above
requisitionListItems	Array<RequisitionListItemsInput>	Yes	See function signature above

Events

Emits the requisitionList/data event.

Returns

Returns RequisitionList or null.

---

addRequisitionListItemsToCart

This function adds the chosen items from a requisition list to the logged-in user cart.

const addRequisitionListItemsToCart = async (
  requisitionListUid: string,
  requisitionListItemUids: Array<string>
): Promise<Array<string> | null>

Parameter	Type	Req?	Description
requisitionListUid	string	Yes	See function signature above
requisitionListItemUids	Array<string>	Yes	See function signature above

Events

Does not emit any drop-in events.

Returns

Returns Array<string> | null.

---

createRequisitionList

This function creates a new requisition list with the name and description provided for a logged-in user.

const createRequisitionList = async (
  name: string,
  description?: string
): Promise<RequisitionList | null>

Parameter	Type	Req?	Description
name	string	Yes	See function signature above
description	string	No	A text description.

Events

Emits the requisitionList/data event.

Returns

Returns RequisitionList or null.

---

deleteRequisitionList

This function deletes a requisition list identified by uid.

const deleteRequisitionList = async (
  requisitionListUid: string
): Promise<{
  items: RequisitionList[];
  page_info: any;
  status: any;
} | null>

Parameter	Type	Req?	Description
requisitionListUid	string	Yes	See function signature above

Events

Emits the requisitionLists/data event.

Returns

Returns Promise<{ items: RequisitionList[]; page_info: any; status: any; } | null>. See RequisitionList.

---

deleteRequisitionListItems

Deletes items from a requisition list.

const deleteRequisitionListItems = async (
  requisitionListUid: string,
  items: Array<string>,
  pageSize: number,
  currentPage: number
): Promise<RequisitionList | null>

Parameter	Type	Req?	Description
requisitionListUid	string	Yes	See function signature above
items	Array<string>	Yes	An array of items to remove.
pageSize	number	Yes	See function signature above
currentPage	number	Yes	See function signature above

Events

Emits the requisitionList/data event.

Returns

Returns RequisitionList or null.

---

getRequisitionList

This function returns information about the desired requisition list from a logged-in user,

const getRequisitionList = async (
  requisitionListID: string,
  currentPage?: number,
  pageSize?: number
): Promise<RequisitionList | null>

Parameter	Type	Req?	Description
requisitionListID	string	Yes	See function signature above
currentPage	number	No	See function signature above
pageSize	number	No	See function signature above

Events

Emits the requisitionList/data event.

Returns

Returns RequisitionList or null.

---

getRequisitionLists

This function returns the requisition lists from a logged-in user.

const getRequisitionLists = async (
  currentPage?: number,
  pageSize?: number
): Promise<RequisitionList[] | null>

Parameter	Type	Req?	Description
currentPage	number	No	See function signature above
pageSize	number	No	See function signature above

Events

Emits the requisitionLists/data event.

Returns

Returns an array of RequisitionList objects or null.

---

updateRequisitionList

This function updates an existing requisition list with the name and description provided for a logged-in user.

const updateRequisitionList = async (
  requisitionListUid: string,
  name: string,
  description?: string,
  pageSize?: number,
  currentPage?: number
): Promise<RequisitionList | null>

Parameter	Type	Req?	Description
requisitionListUid	string	Yes	See function signature above
name	string	Yes	See function signature above
description	string	No	A text description.
pageSize	number	No	See function signature above
currentPage	number	No	See function signature above

Events

Emits the requisitionList/data event.

Returns

Returns RequisitionList or null.

---

updateRequisitionListItems

This function updates the items of an existing requisition list with the quantity and options provided for a logged-in user.

const updateRequisitionListItems = async (
  requisitionListUid: string,
  requisitionListItems: Array<UpdateRequisitionListItemsInput>,
  pageSize: number,
  currentPage: number
): Promise<RequisitionList | null>

Parameter	Type	Req?	Description
requisitionListUid	string	Yes	See function signature above
requisitionListItems	Array<UpdateRequisitionListItemsInput>	Yes	See function signature above
pageSize	number	Yes	See function signature above
currentPage	number	Yes	See function signature above

Events

Emits the requisitionList/data event.

Returns

Returns RequisitionList or null.

---

Data Models

The following data models are used by functions in this drop-in.

RequisitionList

The RequisitionList object is returned by the following functions: addProductsToRequisitionList, createRequisitionList, deleteRequisitionList, deleteRequisitionListItems, getRequisitionList, getRequisitionLists, updateRequisitionList, updateRequisitionListItems.

interface RequisitionList {
  uid: string;
  name: string;
  description: string;
  updated_at: string;
  items_count: number;
  items: Item[];
  page_info?: PageInfo;
}