DownloadThis POST API allows pushing Catalog Details posted in ERP to GEP SMART for further processing.
URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/Catalog/CatalogDetails
{
"CatalogItem": [
{
"SupplierItemNumber": "String"
}
]
}
{
"totalPages": 1,
"catalogResult": [
{
"catalogNumber": "string",
"contractNumber": "string",
"sourceSystemName": "string",
"dateExpiry": "2020-01-21T10:51:07.501Z",
"startDate": "2020-01-21T10:51:07.501Z",
"partnerCode": "string",
"lstCatalogItem": [
{
"lineNumber": 0,
"buyerItemNumber": "string",
"supplierItemNumber": "string",
"supplierPartNumber": "string",
"shortDescription": "string",
"description": "string",
"unspsc": "string",
"isActive": true,
"itemSpecification": "string",
"minimumOrderQuantity": 0,
"maximumOrderQuantity": 0,
"manufacturer": "string",
"manufacturerPartNumber": "string",
"manufacturerModelNumber": "string",
"gtin": "string",
"banding": 0,
"relatedKeywords": "string",
"imageFileName": "string",
"itemType": "string",
"itemExtendedType": "string",
"orgEntities": [
{
"entityCode": "string",
"isDefault": true,
"entityType": "string",
"lobEntityCode": "string"
}
],
"lstCatalogItemPartner": [
{
"contractNumber": "string",
"partnerCode": "string",
"leadTime": 0,
"isActive": true,
"isTaxExempt": true,
"lstCatalogItemPartnerUOM": [
{
"uom": "string",
"supportedUOM": "string",
"unitPrice": 0,
"pricePerSupportedUOM": "string",
"currencyCode": "string",
"conversionFactorsWRTDefaultUOM": "string"
}
]
}
]
}
]
}
],
"totalCount": 1
}
Success Scenario - Request
Request below describes that this contains only the mandatory attributes:
{
"CatalogItem": [
{
"SupplierItemNumber": "03230566"
}
]
}
Success Scenario - Response
{
"totalPages": 1,
"catalogResult": [
{
"catalogNumber": "CAT-2018-00410",
"contractNumber": "2018.000459",
"sourceSystemName": "PC2_Tax",
"dateExpiry": "2020-02-09T00:00:00+00:00",
"startDate": "2006-02-08T00:00:00+00:00",
"partnerCode": "PC-2018.000190",
"catalogItem": [
{
"lineNumber": 1619,
"buyerItemNumber": "1235",
"supplierItemNumber": "03230566",
"supplierPartNumber": "03230566",
"shortDescription": "Pipe, 4 X 15.00#, XH, 0.337, FBE, 14-16,",
"description": "Pipe, 4 X 15.00#, XH, 0.337 L2",
"unspsc": "53A",
"isActive": true,
"itemSpecification": "Length - | Material - | Finish - | ",
"minimumOrderQuantity": null,
"maximumOrderQuantity": null,
"manufacturer": "",
"manufacturerPartNumber": "",
"manufacturerModelNumber": "",
"gtin": "",
"banding": null,
"relatedKeywords": "",
"imageFileName": "",
"itemType": "Material",
"itemExtendedType": "Material",
"orgEntities": null,
"lstCatalogItemPartner": [
{
"contractNumber": "2018.000459",
"partnerCode": null,
"leadTime": 10,
"isActive": true,
"isTaxExempt": false,
"lstCatalogItemPartnerUOM": [
{
"uom": "FT",
"supportedUOM": "",
"unitPrice": 12,
"pricePerSupportedUOM": null,
"currencyCode": "USD",
"conversionFactorsWRTDefaultUOM": null
},
{
"uom": "",
"supportedUOM": "",
"unitPrice": null,
"pricePerSupportedUOM": "",
"currencyCode": "USD",
"conversionFactorsWRTDefaultUOM": ""
}
]
}
]
}
]
}
],
"totalCount": 1
}
Error Scenario – Request
Request has a missing value of the Authorization Header which is mandatory: (401 – Unauthorized)
Error Scenario – Response
Access to interface BulkAPI is denied, Authorization Header is missing.
|
Catalog Details |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1 |
CatalogNumber |
|
String |
Catalog Number of entity |
|
|
2 |
|
List Of catalogItem object |
|
|
|
|
3 |
ContractNumber |
|
String |
Contract Number of entity |
|
|
4 |
SourceSystemName |
|
String |
Source System Name of entity |
|
|
5 |
DateExpiry |
|
DateTime |
|
|
|
6 |
StartDate |
|
DateTime |
|
|
|
7 |
PartnerCode |
|
String |
Note: Client Partner Code must be unique from the <CLIENT NAME> systems, so if there are duplicates within the service layer, the SSID will have to be appended to the Client Partner Code, and the resulting value will be Client Partner Code-SSID |
|
|
LstCatalogItem |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
2.1 |
LineNumber |
|
Long |
Line Number of entity |
|
|
2.2 |
BuyerItemNumber |
|
String |
Buyer Item Number of entity |
|
|
2.3 |
SupplierItemNumber |
|
String |
Supplier Item Number of entity |
|
|
2.4 |
SupplierPartNumber |
|
String |
Supplier Part Number of entity |
|
|
2.5 |
ShortDescription |
|
String |
Short Description |
|
|
2.6 |
Description |
|
String |
Description of entity |
|
|
2.7 |
UNSPSC |
|
String |
UNSPSC of entity |
|
|
2.8 |
IsActive |
|
Boolean |
Status of the entity if active or not |
|
|
2.9 |
ItemSpecification |
|
String |
Item Specification |
|
|
2.10 |
MinimumOrderQuantity |
|
Decimal |
Minimum Order Quantity of entity |
|
|
2.11 |
MaximumOrderQuantity |
|
Decimal |
Maximum Order Quantity of entity |
|
|
2.12 |
Manufacturer |
|
String |
Manufacturer of entity |
|
|
2.13 |
ManufacturerPartNumber |
|
String |
Manufacturer Part Number of entity |
|
|
2.14 |
ManufacturerModelNumber |
|
String |
Manufacturer Model Number of entity |
|
|
2.15 |
GTIN |
|
String |
GTIN of entity |
|
|
2.16 |
Banding |
|
Int |
Banding of entity |
|
|
2.17 |
RelatedKeywords |
|
String |
Related Keywords of entity |
|
|
2.18 |
ImageFileName |
|
String |
Image File Name of entity |
|
|
2.19 |
ItemType |
|
String |
ItemType of entity |
|
|
2.20 |
ItemExtendedType |
|
String |
|
|
|
2.21 |
|
List Of OrgEntities object |
Check data type Org Entity for details |
|
|
|
2.22 |
|
List Of CatalogItemPartner object |
Check data type Catalog Item Partner |
|
|
|
OrgEntities |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
2.21.1 |
EntityCode |
|
String |
Entity Code of the entity |
|
|
2.21.2 |
IsDefault |
|
Boolean |
A flag used to denote if entity is the default or not |
|
|
2.21.3 |
EntityType |
|
String |
Entity Type of the entity |
|
|
2.21.4 |
LOBEntityCode |
|
String |
Lob Entity Code of the entity |
|
|
lstCatalogItemPartner |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
2.22.1 |
ContractNumber |
|
String |
Contract Number of the entity |
|
|
2.22.2 |
PartnerCode |
|
String |
Note: Client Partner Code must be unique from the <CLIENT NAME> systems, so if there are duplicates within the service layer, the SSID will have to be appended to the Client Partner Code, and the resulting value will be Client Partner Code-SSID |
|
|
2.22.3 |
LeadTime |
|
Int |
|
|
|
2.22.4 |
IsActive |
|
Boolean |
Status of the entity if active or not |
|
|
2.22.5 |
IsTaxExempt |
|
Boolean |
Is Tax Exempt of the entity |
|
|
2.22.6 |
|
List Of CatalogItemPartnerUOM object |
|
|
|
|
lstCatalogItemPartnerUOM |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
2.22.6.1 |
UOM |
|
String |
UOM of the entity |
|
|
2.22.6.2 |
SupportedUOM |
|
String |
Supported UOM of the entity |
|
|
2.22.6.3 |
UnitPrice |
|
Decimal |
Unit Price of the entity |
|
|
2.22.6.4 |
PricePerSupportedUOM |
|
String |
Price Per Supported UOM of the entity |
|
|
2.22.6.5 |
CurrencyCode |
|
String |
Currency Code of the entity |
|
|
2.22.6.6 |
ConversionFactorsWRTDefaultUOM |
|
String |
Conversion Factors WRT Default UOM of the entity |
|