This GET API allows retrieval of ASN details created in GEP SMART to post them into ERP.
URL Format: https:// <Instance>/SmartInterfaceAPI/api/Asn/GetASNs
https://<Instance>/SmartInterfaceAPI/api/Asn/GetASNs
{
"data": [
{
"SupplierASNNumber": "String",
"expectedDeliveryDate": "2019-12-27T08:51:31.680Z",
"clientPartnerCode": "String",
"trackingNumber": "String",
"comments": [
{
"commentText": "String",
"commentAttachment": [
{
"fileName": "String",
"fileUri": "String"
}
]
}
],
"shippingMethod": {
"domain": "String",
"name": "String"
},
"asnItems": [
{
"itemLineNumber": 0,
"poLineNumber": 0,
"orderNumber": "String",
"quantity": 0,
"uom": "String",
"shippingQuantity": 0,
"previouslyShippedQuantity": 0,
"previouslyAcceptedQuantity": 0,
"description": "String",
"supplierPartId": "String",
"manufacturerPartNumber": "String",
"supplierPartAuxiliaryId": "String",
"shiptoLocation": {
"shiptoLocationName": "String",
"shiptoLocationNumber": "String",
"address": {
"addressline1": "String",
"addressline2": "String",
"addressline3": "String",
"city": "String",
"zipCode": "String",
"stateInfo": {
"stateAbbrevationCode": "String",
"stateName": "String"
},
"countryInfo": {
"countryCode": "String",
"countryName": "String"
},
"phoneNo1": "String",
"extenstionNo1": "String",
"phoneNo2": "String",
"extenstionNo2": "String",
"mobileNo": "String",
"faxNo": "String",
"county": "String",
"poBoxNumber": "String",
"isdCode": "String",
"geoCode": "String",
"areaCode": "String",
"createdOn": "2019-12-27T08:51:31.680Z"
}
},
"dateNeeded": "2019-12-27T08:51:31.680Z",
"comments": [
{
"commentText": "String",
"commentAttachment": [
{
"fileName": "String",
"fileUri": "String"
}
]
}
]
}
],
"documentName": "String",
"documentNumber": "String",
"documentStatus": "String",
"documentDescription": "String",
"documentCreator": "String",
"documentBU": [
{
"entityCode": "String",
"isDefault": false,
"entityType": "String",
"lobEntityCode": "String"
}
],
"operationName": "String"
}
],
"statusCode": "String",
"errorDetails": [],
"successDetails": []
}
Success Scenario – Request
https://api-smartdev.gep.com/SmartInterfaceAPI/api/Asn/GetASNs
Success Scenario – Response
{
"data": [
{
"SupplierASNNumber": "supGA00000042",
"expectedDeliveryDate": "2019-12-27T08:51:31.680Z",
"clientPartnerCode": "97423",
"trackingNumber": "1Z2X41596890867127",
"comments": [
{
"commentText": "com 1",
"commentAttachment": [
{
"fileName": "",
"fileUri": ""
}
]
}
],
"shippingMethod": {
"domain": "SCAC",
"name": "V1-UPS"
},
"asnItems": [
{
"itemLineNumber": 1,
"poLineNumber": 1,
"orderNumber": "G000017636",
"quantity": 1,
"uom": "EA",
"shippingQuantity": 1,
"previouslyShippedQuantity": 0,
"previouslyAcceptedQuantity": 0,
"description": "S311-0547 PLC-Proc Module, 5/01,1k,Reconditioned ladder V108R02",
"supplierPartId": "S311-0547",
"manufacturerPartNumber": "",
"supplierPartAuxiliaryId": "",
"shiptoLocation": {
"shiptoLocationName": "gep solutions",
"shiptoLocationNumber": "G101",
"address": {
"addressline1": "100 walnut ave",
"addressline2": "3rd floor",
"addressline3": "",
"city": "Clark",
"zipCode": "07066",
"stateInfo": {
"stateAbbrevationCode": "NJ",
"stateName": "New Jersey"
},
"countryInfo": {
"countryCode": "US",
"countryName": "United States"
},
"phoneNo1": "",
"extenstionNo1": "",
"phoneNo2": "",
"extenstionNo2": "",
"mobileNo": "",
"faxNo": "",
"county": "",
"poBoxNumber": "",
"isdCode": "",
"geoCode": "",
"areaCode": "",
"createdOn": "2019-12-27T08:51:31.680Z"
}
},
"dateNeeded": "2019-12-27T08:51:31.680Z",
"comments": [
{
"commentText": "com line1",
"commentAttachment": [
{
"fileName": "",
"fileUri": ""
}
]
}
]
}
],
"documentName": "ASN1 for ceg24 Requisition41",
"documentNumber": "GA00000042",
"documentStatus": "",
"documentDescription": "",
"documentCreator": "CC-21-10",
"documentBU": [
{
"entityCode": "1105",
"isDefault": false,
"entityType": "Company Code",
"lobEntityCode": "A101"
}
],
"header": {
"from": {
"domain": "",
"identity": ""
},
"to": {
"domain": "",
"identity": ""
},
"sender": {
"domain": "",
"identity": "",
"sharedSecret": "",
"userAgent": ""
}
},
"operationName": "new"
}
],
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
Failure Scenario – Request
https://api-smartdev.gep.com/SmartInterfaceAPI/api/Asn/GetASNs
Failure Scenario – Response
{
"data": [],
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
Get ASN details |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
Data |
ASN object |
|||
StatusCode |
String |
|||
List of ErrorModel object |
||||
List of SuccessModel object |
Data |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
SupplierASNNumber |
String |
Supplier ASN Number |
||
ExpectedDeliveryDate |
Datetime |
Expected Delivery Date |
||
ClientPartnerCode |
String |
Client Partner Code |
||
TrackingNumber |
String |
Tracking Number |
||
Comments |
List of InterfaceComment object |
Check data type InterfaceComment for details |
||
ShippingMethod |
ShippingMethod object |
Shipping Method |
||
AsnItems |
List of AsnItems object |
Asn Items |
||
DocumentName |
String |
Document Name |
||
DocumentNumber |
String |
Document Number |
||
DocumentStatus |
String |
Document Status |
||
DocumentDescription |
String |
Document Description |
||
DocumentCreator |
String |
Document Creator |
||
DocumentBU |
List of OrgEntity object |
Check data type OrgEntity for details |
||
Header |
Header object |
Check data type Header for details |
Comments |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
CommentText |
String |
Comment Text in a string |
||
CommentAttachment |
List of InterfaceCommentAttachment object |
Check data type Interface Comment Attachment for details |
CommentAttachment |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
FileName |
String |
FileName |
||
FileUri |
String |
FileUri |
ShippingMethod |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
Domain |
String |
Domain |
||
Name |
Datetime |
Name |
AsnItems |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
ItemLineNumber |
Int |
Item Line Number |
||
PoLineNumber |
Int |
Purchase Order Line Number |
||
OrderNumber |
String |
Order Number |
||
Quantity |
Decimal |
Quantity |
||
Uom |
String |
Unit of Measurement |
||
ShippingQuantity |
Decimal |
Shipping Quantity |
||
PreviouslyShippedQuantity |
Decimal |
Previously Shipped Quantity |
||
PreviouslyAcceptedQuantity |
Decimal |
Previously Accepted Quantity |
||
Description |
String |
Description |
||
SupplierPartId |
String |
Supplier Part Id |
||
ManufacturerPartNumber |
String |
Manufacturer Part Number |
||
SupplierPartAuxiliaryId |
String |
Supplier Part Auxiliary Id |
||
ShiptoLocation |
InterfaceShiptoLocation object |
Check data type InterfaceShiptoLocation for details |
||
DateNeeded |
Datetime |
Date Needed |
||
Comments |
List of InterfaceComment object |
Check data type InterfaceComment for details |
ShiptoLocation |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
ShiptoLocationName |
String |
Ship to Location Name |
||
ShiptoLocationNumber |
String |
Ship to Location Number |
||
Address |
Address object |
Check data type Address for details |
||
TelephoneNumber |
Int |
Telephone Number |
Address |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
IsdCode |
String |
Isd Code |
||
PoBoxNumber |
String |
Po Box Number |
||
County |
String |
County |
||
FaxNo |
String |
Fax No |
||
MobileNo |
String |
Mobile No |
||
ExtenstionNo2 |
String |
ExtenstionNo2 |
||
PhoneNo2 |
String |
PhoneNo2 |
||
GePCode |
String |
GeP Code |
||
ExtenstionNo1 |
String |
ExtenstionNo1 |
||
CountryInfo |
InterfaceCountryInfo object |
Check data type InterfaceCountryInfo for details |
||
StateInfo |
InterfaceStateInfo object |
Check data type InterfaceStateInfo for details |
||
ZipCode |
String |
Zip Code |
||
City |
String |
City |
||
Addressline3 |
String |
Addressline3 |
||
Addressline2 |
String |
Addressline2 |
||
Addressline1 |
String |
Addressline1 |
||
PhoneNo1 |
String |
PhoneNo1 |
||
AreaCode |
String |
Area Code |
CountryInfo |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
CountryCode |
String |
Country Code |
||
CountryName |
String |
Country Name |
StateInfo |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
StateAbbrevationCode |
String |
State Abbreviation Code |
||
StateName |
String |
State Name |
DocumentBU |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
EntityCode |
String |
Entity Code |
||
IsDefault |
Boolean |
|||
EntityType |
String |
Entity Type |
||
LOBEntityCode |
String |
ErrorDetails |
||||
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
Key |
String |
|||
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 |