Get Purchase Order Details

This REST API is used to fetch purchase order (PO) details from Uniware using purchaseOrderCode.

Tip

It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Basic Information

NAME DETAILS
Endpoint: /services/rest/v1/purchase/purchaseOrder/getPurchaseOrderDetails
Request Type: POST
Level: Facility
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa
Header (Facility): facility code as in Uniware (refer FAQs)

Request Payload

{
   "purchaseOrderCode": "string"
}

Request Payload Details

PARAMETER TYPE DESCRIPTION MANDATORY NOTES
purchaseOrderCode string Purchase order code Yes -

Response Payload

{
   "successful": true,
   "message": "string",
   "errors": [
      {
         "code": 0,
         "fieldName": "string",
         "description": "string",
         "message": "string",
         "errorParams": {
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
         }
      }
   ],
   "warnings": [
      {
         "code": 0,
         "message": "string",
         "description": "string"
      }
   ],
    "id": 72863,
    "amendedPurchaseOrderCode": null,
    "amendmentPurchaseOrderCode": null,
    "name": null,
    "code": "PO0194",
    "type": "Manual",
    "fromParty": "neemka",
    "statusCode": "APPROVED",
    "vendorCode": "Sachin123",
    "vendorId": 2432,
    "vendorName": "Sachin Enterprise",
    "created": 1642151793000,
    "createdBy": "xyz@gmail.com",
    "expiryDate": "2022-01-22",
    "deliveryDate": "2022-01-20",
    "vendorAgreementName": "string",
    "inflowReceiptsCount": 2,
    "customFieldValues": [
        {
            "fieldName": "Currency",
            "fieldValue": "INR",
            "valueType": "select",
            "displayName": "Currency",
            "required": false,
            "possibleValues": [
                "USD",
                "EURO",
                "INR",
                "SGN"
            ]
        },
        {
            "fieldName": "Currency_Conversion",
            "fieldValue": "",
            "valueType": "text",
            "displayName": "Currency_Conversion",
            "required": false,
            "possibleValues": [
                ""
            ]
        }
    ],
    "purchaseOrderItems": [
        {
            "id": 1295811,
            "itemSKU": "Shirt27",
            "itemTypeCustomFields": null,
            "itemTypeId": 1831417,
            "itemTypeImageUrl": null,
            "itemTypePageUrl": null,
            "itemTypeName": "Shirt",
            "vendorSkuCode": "shirt27",
            "color": null,
            "brand": null,
            "size": null,
            "quantity": 6,
            "rejectedQuantity": 1,
            "pendingQuantity": 1,
            "unitPrice": 100.00,
            "maxRetailPrice": 400.00,
            "discount": 0.00,
            "discountPercentage": 0.00,
            "subtotal": 600.00,
            "total": 600.00,
            "taxPercentage": 0.000,
            "tax": 0.00,
            "taxType": "gst18_",
            "logisticCharges": 0.00,
            "expirable": false,
            "shelfLife": 0,
            "determineExpiryFrom": "MANUFACTURING_DATE",
            "grnExpiryTolerance": 0,
            "scanIdentifier": "Shirt27",
            "customFieldValues": [],
            "batchGroupCode": null
        }
    ],
    "partyAddressDTO": {
        "addressType": "SHIPPING",
        "addressTypeName": "Shipping Address",
        "stateCode": "HR",
        "stateName": "Haryana",
        "countryCode": "IN",
        "addressLine1": "SCO 43, SECOND FLOOR",
        "addressLine2": "SECTOR 30-C",
        "city": "GGN",
        "pincode": "122003",
        "phone": "8210888566",
        "enabled": true
    },
    "logisticCharges": 0.00,
    "logisticChargesDivisionMethod": null,
    "purchaseOrderPriceSummary": {
        "discount": 0.00,
        "taxOnSales": 0.00,
        "subTotalBeforeTaxesAndDiscount": 0.00,
        "totalAmount": 600.00,
        "logisticCharges": 0.00,
        "tcsAmount": 0.0000,
        "totalItems": 1
    },
    "rejectionReason": null,
    "tcsAmount": 0.0000,
    "tcsadditionEnabled": false
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION NOTES
1 successful true Request success status -
2 message string Response message -
3 errors list List of errors (if any) -
3.1 code number Error code -
3.2 fieldName string Field with error -
3.3 description string Error description -
3.4 message string Error message -
3.5 errorParams object Parameters with error -
3.5.1 additionalProp1 object Parameter 1 with error -
3.5.2 additionalProp2 object Parameter 2 with error -
3.5.3 additionalProp3 object Parameter 3 with error -
4 warnings list List of warnings (if any) -
4.1 code number Warning code -
4.2 message string Warning message -
4.3 description string Warning description -
5 id string Unique identifier for an PO Eg: PO1234
6 amendedPurchaseOrderCode string Amended Purchase Order Code Eg: PO1423
7 amendmentPurchaseOrderCode string Amendment Purchase Order Code -
8 name string User who amended -
9 code string Purchase order code Eg: PO1423
10 type enum Purchase order creation type MANUAL or CART
11 fromParty string From Party Code -
12 statusCode enum Purchase Order Status Code Eg: CREATED,APPROVED,COMPLETE
13 vendorCode string Vendor code -
14 vendorId integer Vendor ID -
15 vendorName string Vendor name -
16 created Date Purchase order creation Date Eg: 1593590417000
17 createdBy string Username -
18 expiryDate Date PO expiry Date Eg: 2022-01-31
19 deliveryDate Date PO deliveryDate Eg: 2022-01-22
20 vendorAgreementName string Vendor aggrement name -
21 inflowReceiptsCount number GRNs Counts -
22 customFieldValues list Custom field details -
22.1 fieldName string Custom field name -
22.2 fieldValue object Custom field value -
22.3 valueType string Value type -
22.4 displayName string Name to be displayed -
22.5 required boolean True if required -
22.6 possibleValues list Possible values for custom field Eg: USD, EURO, INR, SGN
23 purchaseOrderItems list Purchase order item details -
23.1 id string Id -
23.2 itemSKU string SKU code -
23.3 itemTypeCustomFields list Item Type Custom Fields -
23.4 itemTypeId integer Item Type Id -
23.5 itemTypeImageUrl string Item type image URL -
23.6 itemTypePageUrl string Item type page URL -
23.7 itemTypeName string Item type name -
23.8 vendorSkuCode string Vendor SKU code -
23.9 color string Color description -
23.10 brand string Brand of the item Eg: Bombay Dyeing
23.11 size string Size Format: LxBxH, Unit: mm, Eg: 60.00X40.00X2.00
23.12 quantity integer Quantity -
23.13 rejectedQuantity integer Rejected quantity -
23.14 pendingQuantity integer Pending quantity -
23.15 unitPrice number Unit price -
23.16 maxRetailPrice number Max. retail price -
23.17 discount number Discount amount -
23.18 discountPercentage number Discount percentage -
23.19 subtotal number Sub-total -
23.20 total number Total amount -
23.21 taxPercentage number Tax percentage -
23.22 tax number Tax -
23.23 taxType string Tax type -
23.24 logisticCharges number Logistics charges -
23.25 expirable boolean True if expirable -
23.26 shelfLife integer Duration for which item remains in good condition while storing -
23.27 determineExpiryFrom string Expiry From Expiry or MFG date Eg: MANUFACTURING_DATE
23.28 grnExpiryTolerance integer GRN Expiry tolerance -
23.29 scanIdentifier string Data to be matched during item scan -
23.30 customFieldValues list Custom Field Details -
23.30.1 name string Custom field name -
23.30.2 value string Custom field value -
23.31 batchGroupCode string Batch Group Code -
24 partyAddressDTO object Party Address Details -
24.1 addressType string Address Type -
24.2 addressTypeName string Address Type Name -
24.3 stateCode string State code State Codes
24.4 stateName string State Name -
24.5 countryCode string Country code not name Country Codes
24.6 addressLine1 string Precise address -
24.7 addressLine2 string Additional address information -
24.8 city string City name Eg: Surat
24.9 pincode string Area pincode (min. 6 digits) -
24.10 phone string Contact no. -
24.11 enabled boolean True if enabled -
25 logisticCharges number LogisticCharges -
26 logisticChargesDivisionMethod string Logistic Charges Division Method -
27 purchaseOrderPriceSummary list Purchase Order Price Summary -
27.1 discount number Discount amount -
27.2 taxOnSales number Tax On Sales -
27.3 subTotalBeforeTaxesAndDiscount number SubTotal Before Taxes And Discount -
27.4 totalAmount number TotalAmount -
27.5 logisticCharges number LogisticCharges -
27.6 tcsAmount number TCS Amount -
27.7 totalItems integer Total Items -
28 rejectionReason string Rejection Reason -
29 tcsAmount number Tcs Amount -
30 tcsadditionEnabled boolean True if tcs addition Enabled -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.