GetCatalogDetails (POST) | GEP TECH DOCUMENTATION

Overview

This POST API allows pushing catalog details posted in ERP into GEP SMART for further processing.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Catalog/CatalogDetails

Request

[
   {
      "catalogNumber": "string",
      "contractNumber": "string",
      "sourceSystemName": "string",
      "dateExpiry": "2020-01-22T09:14:53.576Z",
      "startDate": "2020-01-22T09:14:53.576Z",
      "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"
                     }
                  ]
               }
            ]
         }
      ]
   }
]

Response

{
   "data":
[
   {
      "catalogNumber": "string",
      "contractNumber": "string",
      "sourceSystemName": "string",
      "dateExpiry": "2020-01-22T09:14:53.576Z",
      "startDate": "2020-01-22T09:14:53.576Z",
      "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"
                     }
                  ]
               }
            ]
         }
      ]
   }
],
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

Examples

Success Scenario - Request

[
   {
      "catalogNumber": "CAT-2019-20990",
      "lstCatalogItem": [
         {
            "supplierItemNumber": "12356"
         }
      ]
   }
]

Success Scenario – Response

{
   "data": [
      {
         "catalogNumber": "CAT-2019-20990",
         "contractNumber": "",
         "sourceSystemName": "AMB",
         "dateExpiry": "2024-08-31T00:00:00+00:00",
         "startDate": "2018-08-30T00:00:00+00:00",
         "partnerCode": "PC-2017.000308",
         "lstCatalogItem": [
            {
               "lineNumber": 0,
               "buyerItemNumber": "",
               "supplierItemNumber": "12356",
               "supplierPartNumber": "12356",
               "shortDescription": "SerCatTest12_TEST_AK_2",
               "description": "desc2",
               "unspsc": "10141502",
               "isActive": true,
               "itemSpecification": "",
               "minimumOrderQuantity": null,
               "maximumOrderQuantity": null,
               "manufacturer": "",
               "manufacturerPartNumber": "",
               "manufacturerModelNumber": "",
               "gtin": "",
               "banding": null,
               "relatedKeywords": "",
               "imageFileName": "",
               "itemType": "Service",
               "itemExtendedType": "Fixed",
               "orgEntities": null,
               "lstCatalogItemPartner": [
                  {
                     "contractNumber": "",
                     "partnerCode": null,
                     "leadTime": 5,
                     "isActive": true,
                     "isTaxExempt": false,
                     "lstCatalogItemPartnerUOM": [
                        {
                           "uom": "KE",
                           "supportedUOM": "",
                           "unitPrice": 1234,
                           "pricePerSupportedUOM": null,
                           "currencyCode": "USD",
                           "conversionFactorsWRTDefaultUOM": null
                        },
                        {
                           "uom": "",
                           "supportedUOM": "",
                           "unitPrice": null,
                           "pricePerSupportedUOM": "",
                           "currencyCode": "USD",
                           "conversionFactorsWRTDefaultUOM": ""
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": []
}

Error Scenario - Request
Request below contains invalid catalog number:

[
   {
      "catalogNumber": "aaaa",
      "lstCatalogItem": [
         {
            "supplierItemNumber": "12356"
         }
      ]
   }
]

Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "Validation Exception",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "aaaa"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

	Get Catalog details
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Data		List of CatalogDetailsModel object
2	StatusCode		String
3	ErrorDetails		List of ErrorModel object
4	SuccessDetails		List of SuccessModel object

	Data
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.1	CatalogNumber		String	Catalog Number of entity
1.2	LstCatalogItem		List of CatalogItem object
1.3	ContractNumber		String	Contract Number of entity
1.4	SourceSystemName		String	Source System Name of entity
1.5	DateExpiry		DateTime
1.6	StartDate		DateTime
1.7	PartnerCode		String

	LstCatalogItem
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.2.1	LineNumber		Long	Line Number of entity
1.2.2	BuyerItemNumber		String	Buyer Item Number of entity
1.2.3	SupplierItemNumber		String	Supplier Item Number of entity
1.2.4	SupplierPartNumber		String	Supplier Part Number of entity
1.2.5	ShortDescription		String	Short Description
1.2.6	Description		String	Description of entity
1.2.7	UNSPSC		String	United Nations Standard Products and Services Code of entity
1.2.8	IsActive		Boolean	Status of the entity if active or not
1.2.9	ItemSpecification		String	Item Specification
1.2.10	MinimumOrderQuantity		Decimal	Minimum Order Quantity of entity
1.2.11	MaximumOrderQuantity		Decimal	Maximum Order Quantity of entity
1.2.12	Manufacturer		String	Manufacturer of entity
1.2.13	ManufacturerPartNumber		String	Manufacturer Part Number of entity
1.2.14	ManufacturerModelNumber		String	Manufacturer Model Number of entity
1.2.15	GTIN		String	Global Trade Item Number of entity
1.2.16	Banding		Int	Banding of entity
1.2.17	RelatedKeywords		String	Related Keywords of entity
1.2.18	ImageFileName		String	Image File Name of entity
1.2.19	ItemType		String	ItemType of entity
1.2.20	ItemExtendedType		String
1.2.21	OrgEntities		List of OrgEntity object	Check data type OrgEntity for details
1.2.22	LstCatalogItemPartner		List of CatalogItemPartner object	Check data type Catalog Item Partner

	OrgEntities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.2.21.1	EntityCode		String	Entity Code of the entity
1.2.21.2	IsDefault		Boolean	A flag used to denote if entity is the default or not
1.2.21.3	EntityType		String	Entity Type of the entity
1.2.21.4	LOBEntityCode		String	Lob Entity Code of the entity

	LstCatalogItemPartner
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.2.22.1	ContractNumber		String	Contract Number of the entity
1.2.22.2	PartnerCode		String
1.2.22.3	LeadTime		Int
1.2.22.4	IsActive		Boolean	Status of the entity if active or not
1.2.22.5	IsTaxExempt		Boolean	Is Tax Exempt of the entity
1.2.22.6	LstCatalogItemPartnerUOM		List of CatalogItemPartnerUOM object	Check data type CatalogItemPartnerUOM for details

	LstCatalogItemPartnerUOM
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.2.22.6.1	UOM		String	Unit of Measurement of the entity
1.2.22.6.2	SupportedUOM		String	Supported Unit of Measurement of the entity
1.2.22.6.3	UnitPrice		Decimal	Unit Price of the entity
1.2.22.6.4	PricePerSupportedUOM		String	Price Per Supported Unit of Measurement of the entity
1.2.22.6.5	CurrencyCode		String	Currency Code of the entity
1.2.22.6.6	ConversionFactorsWRTDefaultUOM		String	Conversion Factors with respect to Default Unit of Measurement of the entity

	ErrorDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.1	Key		String
3.2	Errors		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