DownloadThis GET API can be used to retrieve all Ship to Location details in GEP SMART to post them into ERP.
URL Format: https://<Instance>/SmartInterfaceAPI/api/ShipToLocation/All
https://<Instance>/SmartInterfaceAPI/api/ShipToLocation/All
{
"data": [
{
"shiptoLocationName": " String",
"shiptoLocationNumber": " String",
"addressLine1": " String",
"addressLine2": "String",
"addressLine3": "String",
"city": " String",
"stateCode": "String",
"zip": " String",
"countryCode": "String",
"isDeleted": true,
"stateOther": "String",
"lobEntityCode": " String",
"lstOrgEntity": [
{
"entityCode": " String",
"isDefault": true,
"entityType": " String",
"lobEntityCode": "String"
}
]
}
],
"statusCode": "String",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": " String"
}
]
}
Success Scenario - Request
https://<Instance>/SmartInterfaceAPI/api/ShipToLocation/All
Success Scenario – Response
{
"data": [
{
"shiptoLocationName": "Mumbai",
"shiptoLocationNumber": "111",
"addressLine1": "Airoli Station",
"addressLine2": "Thane - Belapur Road",
"addressLine3": "Mind Space",
"city": "Navi Mumbai",
"stateCode": "",
"zip": "400708",
"countryCode": "IN",
"isDeleted": false,
"stateOther": "",
"lobEntityCode": null,
"lstOrgEntity": null
}
],
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
|
Get all Ship to Locations |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1 |
List of ShipToLocation object |
||||
|
2 |
StatusCode |
String |
|||
|
3 |
List of ErrorModel object |
||||
|
4 |
List of SuccessModel object |
||||
|
Data |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.1 |
ShiptoLocationName |
String(100) |
Name of this Ship to location |
||
|
1.2 |
ShiptoLocationNumber |
String(100) |
Number of this Ship to location |
||
|
1.3 |
AddressLine1 |
String(500) |
Address line 1 of the entity |
||
|
1.4 |
AddressLine2 |
String(100) |
Address line 2 of the entity |
||
|
1.5 |
AddressLine3 |
String(100) |
Address line 3 of the entity |
||
|
1.6 |
City |
String(50) |
City of the entity |
||
|
1.7 |
StateCode |
String(10) |
State code of the entity |
||
|
1.8 |
Zip |
String(10) |
Zip code of the entity |
||
|
1.9 |
CountryCode |
String(2) |
Country code of the entity |
||
|
1.10 |
IsDeleted |
Boolean |
A flag used to denote if the Ship to Location is the default Ship to Location or not |
||
|
1.11 |
StateOther |
String |
State which is different from the list of states provided |
||
|
1.12 |
LobEntityCode |
String(100) |
Line of Business Code for ShipToLocation |
||
|
1.13 |
List of OrgEntity object |
Check data type OrgEntity for details |
|||
|
LstOrgEntity |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.13.1 |
EntityCode |
String(100) |
Entity Code of entity |
||
|
1.13.2 |
IsDefault |
Boolean |
Status of the entity if this is default or not |
||
|
1.13.3 |
EntityType |
String(100) |
Entity Type of entity |
||
|
1.13.4 |
LobEntityCode |
String(100) |
Line of Business Entity Code of entity |
||
|
ErrorDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.1 |
Key |
String |
|||
|
3.2 |
List of error object |
||||
|
Errors |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.2.1 |
ErrorCode |
String |
|||
|
3.2.2 |
ErrorDescription |
String |
|||
|
SuccessDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
4.1 |
Key |
String |
|||