Fetch PO Details
Fetch Purchase Order Details
This endpoint retrieves the details of a specific purchase order (PO) using the provided orderId. The request is made via an HTTP GET method.
Request Parameters
- orderId (string, required): The unique identifier for the purchase order you wish to fetch. For example,
PO-INDIAN-00407.
Response
On a successful request, the server responds with a status code of 200 and a JSON object containing the following key details:
-
remarks (string): Any remarks associated with the PO.
-
warnings (array): A list of warnings related to the PO, if any.
-
grns (array): An array of Goods Receipt Notes (GRNs) associated with the PO, each containing:
-
id (integer): Unique identifier for the GRN.
-
status (string): Current status of the GRN.
-
grnId (string): ID of the GRN.
-
invoiceId (string): Associated invoice ID.
-
invoiceAmount (number): Amount on the invoice.
-
currency (string): Currency type.
-
partial (boolean): Indicates if the GRN is partial.
-
date (integer): Date of the GRN.
-
createdAt (integer): Timestamp when the GRN was created.
-
amend (boolean): Indicates if the GRN has been amended.
-
-
attrs (object): Contains various attributes related to the PO, such as owner details, currency amount, and address.
-
orderId (string): The unique order ID.
-
title (string): Title of the PO.
-
currency (string): Currency used in the PO.
-
shipTo (object): Shipping details including tags.
-
billingTo (object): Billing details including name, registered name, address, and GSTIN.
-
vendor (object): Information about the vendor, including ID, name, GSTIN, and address.
-
payments (array): Payment details associated with the PO.
-
publicComments (array): Any public comments related to the PO.
-
procured (array): Details of procured items, including quantity, price, and status.
-
invoices (array): List of invoices related to the PO.
Example Response
Notes
-
Ensure that the
orderIdis valid to receive accurate details. -
The response may contain multiple GRNs, invoices, and procured items, which provide comprehensive information about the purchase order.
This endpoint retrieves the details of a specific purchase order (PO) using the provided orderId. The request is made via an HTTP GET method.
Request Parameters
- orderId (string, required): The unique identifier for the purchase order you wish to fetch. For example,
PO-INDIAN-00407.
Response
On a successful request, the server responds with a status code of 200 and a JSON object containing the following key details:
-
remarks (string): Any remarks associated with the PO.
-
warnings (array): A list of warnings related to the PO, if any.
-
grns (array): An array of Goods Receipt Notes (GRNs) associated with the PO, each containing:
-
id (integer): Unique identifier for the GRN.
-
status (string): Current status of the GRN.
-
grnId (string): ID of the GRN.
-
invoiceId (string): Associated invoice ID.
-
invoiceAmount (number): Amount on the invoice.
-
currency (string): Currency type.
-
partial (boolean): Indicates if the GRN is partial.
-
date (integer): Date of the GRN.
-
createdAt (integer): Timestamp when the GRN was created.
-
amend (boolean): Indicates if the GRN has been amended.
-
-
attrs (object): Contains various attributes related to the PO, such as owner details, currency amount, and address.
-
orderId (string): The unique order ID.
-
title (string): Title of the PO.
-
currency (string): Currency used in the PO.
-
shipTo (object): Shipping details including tags.
-
billingTo (object): Billing details including name, registered name, address, and GSTIN.
-
vendor (object): Information about the vendor, including ID, name, GSTIN, and address.
-
payments (array): Payment details associated with the PO.
-
publicComments (array): Any public comments related to the PO.
-
procured (array): Details of procured items, including quantity, price, and status.
-
invoices (array): List of invoices related to the PO.
Notes
-
Ensure that the
orderIdis valid to receive accurate details. -
The response may contain multiple GRNs, invoices, and procured items, which provide comprehensive information about the purchase order.