GetPORs (GET)

Overview

This GET API allows retrieval of Order details created in GEP SMART to post them into ERP.

 

URL Format: https://<Instance>/SmartInterfaceAPI/api/Order/GetPORs

Request

https://<Instance>/SmartInterfaceAPI/api/Order/GetPORs

Response
{
 "basicDetails": {
  "documentNumber": "4600003195",
  "documentStatus": "accept",
  "createdOn": "2022-11-11T07:06:04.787+00:00",
  "documentBu": [],
  "documentLobDetails": [
   {
    "entityCode": "COP",
    "isDefault": false,
    "isDeleted": false
   }
  ],
  "operationName": "new"
 },
 "additionalCharges": 0,
 "comment": [
  {
   "commentAttachment": []
  }
 ],
 "currency": "USD",
 "shipping": 0,
 "tax": 1,
 "customAttributes": [],
 "totalAmount": 21,
 "dateAcknowleged": "0001-01-01T00:00:00",
 "orderItem": [
  {
   "additionalCharges": 0,
   "parentPORItems": {
    "additionalCharges": 0,
    "comment": [],
    "dateNeeded": "0001-01-01T00:00:00",
    "isTaxExempt": false,
    "endDate": "0001-01-01T00:00:00",
    "itemLineNumber": 0,
    "tax": 0,
    "quantity": 0,
    "shippingCharges": 0,
    "startDate": "0001-01-01T00:00:00",
    "unitPrice": 0,
    "customAttributes": [],
    "promisedDate": "0001-01-01T00:00:00",
    "estimatedDeliveryDate": "0001-01-01T00:00:00"
   },
   "comment": [
    {
     "commentAttachment": []
    }
   ],
   "currency": "USD",
   "dateNeeded": "2022-11-25T12:00:00+00:00",
   "isTaxExempt": false,
   "endDate": "0001-01-01T00:00:00",
   "itemType": "Material",
   "itemExtendedType": "Material",
   "itemLineNumber": 1,
   "itemStatus": "detail",
   "tax": 0,
   "quantity": 1,
   "shippingCharges": 0,
   "startDate": "0001-01-01T00:00:00",
   "uom": "EA",
   "unitPrice": 20,
   "customAttributes": [],
   "promisedDate": "2022-11-28T12:00:00+00:00",
   "estimatedDeliveryDate": "0001-01-01T00:00:00"
  }
 ],
 "paymentTermCode": "N30N"
}

 

Examples

Success Scenario - Request 

https://<Instance>/SmartInterfaceAPI/api/Order/GetPORs

Success Scenario - Response 

{
   "data": [
      {
         "basicDetails": {
            "documentName": "",
            "documentNumber": "KetanPO_26022020_01",
            "documentStatus": "accept",
            "createdOn": "2020-02-26",
            "documentLobDetails": [
               {
                  "entityCode": "KNA-SAP",
                  "isDefault": true
               }
            ],
            "operationName": "new"
         },
         "additionalCharges": 0,
         "comment": [
            {
               "commentText": null,
               "accessType": null,
               "commentAttachment": []
            }
         ],
         "currency": "CAD",
         "shipping": 0,
         "tax": 0,
         "customAttributes": [],
         "totalAmount": 100000,
         "dateAcknowleged": "0001-01-01T00:00:00",
         "orderItem": [
            {
               "additionalCharges": 0,
               "parentPORItems": {
                  "additionalCharges": 0,
                  "parentPORItems": null,
                  "comment": [],
                  "contractNo": null,
                  "currency": null,
                  "dateNeeded": "2017-01-25T05:30:00+05:30",
                  "isTaxExempt": false,
                  "endDate": "2017-12-31T05:30:00+05:30",
                  "itemType": null,
                  "itemExtendedType": null,
                  "itemLineNumber": 0,
                  "itemStatus": null,
                  "tax": 0,
                  "manufacturerName": null,
                  "manufacturerPartNumber": null,
                  "quantity": 1,
                  "shippingCharges": 0,
                  "startDate": "2017-01-10T05:30:00+05:30",
                  "uom": "C62",
                  "unitPrice": 100000,
                  "customAttributes": []
               },
               "comment": [
                  {
                     "commentText": null,
                     "accessType": null,
                     "commentAttachment": []
                  }
               ],
               "contractNo": null,
               "currency": "CAD",
               "dateNeeded": "0001-01-01T00:00:00",
               "isTaxExempt": false,
               "endDate": "2017-12-31T05:30:00+05:30",
               "itemType": "Service",
               "itemExtendedType": "Fixed",
               "itemLineNumber": 1,
               "itemStatus": "accept",
               "tax": 0,
               "manufacturerName": null,
               "manufacturerPartNumber": null,
               "quantity": 1,
               "shippingCharges": 0,
               "startDate": "2017-01-10T05:30:00+05:30",
               "uom": "C62",
               "unitPrice": 100000,
               "customAttributes": [
                  {
                     "questionnaireTitle": "Delivery Schedule",
                     "questionnaireResponseValues": [
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "C62",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "1",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "CS",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "2485.690",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "01/27/2017",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "3.000",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "02/02/2017",
                           "rowId": null
                        },
                        {
                           "childQuestionSets": [],
                           "columnText": null,
                           "responseValue": "1",
                           "rowId": null
                        }
                     ]
                  }
               ]
            }
         ],
         "orderSource": null,
         "paymentTermCode": "NT60"
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": []
}

 

Data Elements

Get PORs

Property

Required?

Data type

Description

Validations/Exceptions

Data

 

Interface POR

Interface POR object

 

StatusCode

 

String (100)

Status Code

 

ErrorDetails

 

List of Error object

Error Details

 

SuccessDetails

 

List of Success object

Success Details

 

Data

Property

Required?

Data type

Description

Validations/Exceptions

BasicDetails

 

Document object

 

 

AdditionalCharges

 

Decimal

Additional Charges

 

Comment

 

Interface Comment Object

Comment

 

Currency

 

Sting

Currency

 

Precision

 

Decimal

Precision

 

Shipping

 

Decimal

Shipping

 

Tax

 

Decimal

Tax

 

TotalAmount

 

Decimal

Total Amount

 

DateAcknowleged

 

Data Time

Date Acknowleged

 

OrderItem

 

List of InterfacePORItem object

Order Item

 

OrderSource

 

String

Order Source

 

Document

Property

Required?

Data type

Description

Validations/Exceptions

DocumentName

 

String

Document Name of the entity.

 

DocumentNumber

 

String

Document Number of the entity.

 

DocumentStatus

 

String

Document Status of the entity.

 

DocumentDescription

 

String

Document Description of the entity.

 

DocumentCreator

 

String

Document Creator of the entity.

 

CreatedOn

 

String

Created on date

 

DocumentBU

 

List of OrgEntity object

Check data type OrgEntity for details

 

DocumentLobDetails

 

List of OrgEntity object

Check data type OrgEntity for details

 

OperationName

 

String

Operation Name of the entity.

 

InterfaceComment

Property

Required?

Data type

Description

Validations/Exceptions

CommentText

 

String

   

CommentAttachment

 

List of CommentAttachment object

   

CommentAttachment

Property

Required?

Data type

Description

Validations/Exceptions

FileName

 

String

 

 

FileUri

 

String

 

 

InterfacePORItem

Property

Required?

Data type

Description

Validations/Exceptions

AdditionalCharges

 

Decimal

Additional Charges

 

ParentPORItems

 

InterfacePORItem Object

Parent POR Items

 

Comment

 

List of InterfaceComment object

Comment

 

ContractNo

 

String

Contract No

 

Currency

 

String

Currency

 

DateNeeded

 

Date Time

Date Needed

 

IsTaxExempt

 

Boolean

Is Tax Exempt

 

IsTaxExempt

 

Boolean

Is Tax Exempt

 

EndDate

 

Date Time

End Date

 

ItemType

 

string

Item Type

 

ItemExtendedType

 

String

Item Extended Type

 

ItemLineNumber

 

Int

Item Line Number

 

ItemStatus

 

String

Item Status

 

ManufacturerName

 

String

Manufacturer Name

 

ManufacturerPartNumber

 

String

Manufacturer Part Number

 

Quantity

 

Decimal

Quantity

 

ShippingCharges

 

Decimal

Shipping Charges

 

StartDate

 

Data Time

StartDate

 

UOM

 

String

UOM

 

UnitPrice

 

Decimal

Unit Price

 

ErrorDetails

Property

Required?

Data type

Description

Validations/Exceptions

Key

 

String

   

Errors

 

List of Error object

   

Errors

Property

Required?

Data type

Description

Validations/Exceptions

ErrorCode

 

String

   

ErrorDescription

 

String

   

SuccessDetails

Property

Required?

Data type

Description

Validations/Exceptions

Key

 

String