SaveCatalog (POST)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

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

 

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

Request 
{
   "catalogNumber": "String",
   "contractNumber": "String",
   "sourceSystemName": "String",
   "dateExpiry": "2019-11-29T09:55:18.799Z",
   "startDate": "2019-11-29T09:55:18.799Z",
   "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": 5,
               "isActive": true,
               "isTaxExempt": true,
               "lstCatalogItemPartnerUOM": [
                  {
                     "uom": "String",
                     "supportedUOM": "string",
                     "unitPrice": Int,
                     "pricePerSupportedUOM": "string",
                     "currencyCode": "String",
                     "conversionFactorsWRTDefaultUOM": "string"
                  }
               ]
            }
         ]
      }
   ]
}

 

Response 
{
   "data": null,
   "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": null,
   "statusCode": "200",
   "errorDetails": [
      {
         "key": "string",
         "errors": []
      }
   ],
   "successDetails": [
      {
         "key": "CAT-2019-20990"
      }
   ]
}

 

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
 

Catalog Details

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

CatalogNumber

Yes

String

Catalog Number of entity

 

  • Catalog items data is missing

     

2

LstCatalogItem

Yes

List of CatalogItem object

    

3

ContractNumber

No

String

Contract Number of entity

 

  • Invalid Contract Number (Contract Number)

     

4

SourceSystemName

No

String

Source System Name of entity

 

  • Invalid Source System

 

5

DateExpiry

No

DateTime

    

6

StartDate

No

DateTime

    

7

PartnerCode

No

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

 

  • Partner Code is mandatory
  • Max length for Partner Code is 100

     
 

LstCatalogItem

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

2.1

LineNumber

Yes

Long

Line Number of entity
  • Line Number is missing

     

  • For one or more Catalog items, line number or buyer item number or supplier item number is missing

2.2

BuyerItemNumber

Yes

String

Buyer Item Number of entity

 

  • Buyer Item Number is missing

7.3

SupplierItemNumber

Yes

String

Supplier Item Number of entity

 

  • Supplier Item is missing

2.4

SupplierPartNumber

No

String

 

Supplier Part Number of entity

  

2.5

ShortDescription

No

String

Short Description

  

2.6

Description

No

String

Description of entity

  

2.7

UNSPSC

No

String

UNSPSC of entity

  

2.8

IsActive

No

Bool

Status of the entity if active or not

  

2.9

ItemSpecification

No

String

Item Specification

  

2.10

MinimumOrderQuantity

No

Decimal

Minimum Order Quantity of entity

  

2.11

MaximumOrderQuantity

No

Decimal

Maximum Order Quantity of entity

  

2.12

Manufacturer

No

String

Manufacturer of entity

  

2.13

ManufacturerPartNumber

No

String

Manufacturer Part Number of entity

  

2.14

ManufacturerModelNumber

No

String

Manufacturer Model Number of entity

  

2.15

GTIN

No

String

GTIN of entity

  

2.16

Banding

No

Int

Banding of entity

  

2.17

RelatedKeywords

No

String

Related Keywords of entity

  

2.18

ImageFileName

No

String

Image File Name of entity

  

2.19

ItemType

No

String

ItemType of entity

  

2.20

ItemExtendedType

No

String

    

2.21

OrgEntities

No

List of OrgEntities object

Check data type Org Entity for details

  

2.22

LstCatalogItemPartner

No

List of CatalogItemPartner object

Check data type Catalog Item Partner

  
 

OrgEntities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

2.21.1

EntityCode

No

String 

Entity Code of the entity 

 

  • Validation- Invalid EntityCode

 

2.21.2

IsDefault

No

Boolean 

 

A flag used to denote if entity is the default or not 

 

  

2.21.3

EntityType

No

String 

 

Entity Type of the entity 

 

 

  • Validation- Invalid EntityType

 

2.21.4

 

LOBEntityCode

 

N0

String 

 

Lob Entity Code of the entity 

 

 

  • Validation- Invalid 

 
 

LstCatalogItemPartner

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

2.22.1

ContractNumber

No

String

 

Contract Number of the entity 

 

 

  • Invalid Contract Number

 

2.22.2

PartnerCode

No

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

 

 

  • Partnercode is mandatory
  • Max length for PartnerCode is 100

2.22.3

LeadTime

No

Int

    

2.22.4

IsActive

No

Bool

Status of the entity if active or not

  

2.22.5

IsTaxExempt

No

Bool

Is Tax Exempt of the entity 

  

2.22.6

LstCatalogItemPartnerUOM

No

List of CatalogItemPartnerUOM object

    
 

LstCatalogItemPartnerUOM

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

2.22.6.1

UOM

No

String

UOM of the entity 

  

2.22.6.2

SupportedUOM

No

String

Supported UOM of the entity 

  

2.22.6.3

UnitPrice

No

Decimal

Unit Price of the entity 

  

2.22.6.4

PricePerSupportedUOM

No

String

Price Per Supported UOM of the entity 

  

2.22.6.5

CurrencyCode

No

String

Currency Code of the entity 

  

2.22.6.6

ConversionFactorsWRTDefaultUOM

No

String

Conversion Factors WRT Default UOM of the entity