ItemMasterDetails (POST) | GEP TECH DOCUMENTATION

Overview

This POST API can be used to capture new additions in Item master details from ERP into GEP SMART to be used as a reference in P2P transactions. Item master processing results can be posted to the callback URL using callbackurl feature. To provide callbackurl in the bulk API add “UserContext” http request header along with the data volume.

URL Format:
https://<Instance>/SmartBulkInterfaceAPI/api/ItemMaster/ItemMasterDetails

Request

[
  {
    "itemNumber": "string",
    "division": "string",
    "basicDetails": {
      "action": "string",
      "shortName": "string",
      "itemDescription": "string",
      "unspsc": "string",
      "clientPasCode": "string",
      "uomCode": "string",
      "isActive": "string",
      "itemStandardFieldDetails": {
        "itemType": "string",
        "gtin": "string",
        "aslOnly": "string",
        "isProcurable": "string",
        "isTaxExempt": "string",
        "isActive": "string",
        "isAutomaticallyCreateOrders": "string",
        "qLevel": "string",
        "minOrderedQty": 0,
        "maxOrderedQty": 0,
        "bandingQty": 0,
        "relatedKeywords": "string",
        "itemSpecification": "string",
        "standardPrice": 0,
        "movingAvgPrice": 0,
        "buyerName": "string",
        "currency": "string",
        "leadTime": 0,
        "buyerCode": 0,
        "stockable": "string",
        "consigned": "string",
        "nonStock": "string",
        "itemControlType": "string",
        "storageCondition": "string",
        "criticalItems": "string",
        "internalPlantMemo": "string",
        "pricePerQty": 0
      },
      "itemCustomAttributeDetailsList": [
        {}
      ],
      "itemAdditionalFieldDetails": [
        {}
      ],
      "errorDescription": "string"
    },
    "itemOrgDetailsList": [
      {
        "action": "string",
        "entityCode": "string",
        "itemStandardFieldDetails": {
          "itemType": "string",
          "gtin": "string",
          "aslOnly": "string",
          "isProcurable": "string",
          "isTaxExempt": "string",
          "isActive": "string",
          "isAutomaticallyCreateOrders": "string",
          "qLevel": "string",
          "minOrderedQty": 0,
          "maxOrderedQty": 0,
          "bandingQty": 0,
          "relatedKeywords": "string",
          "itemSpecification": "string",
          "standardPrice": 0,
          "movingAvgPrice": 0,
          "buyerName": "string",
          "currency": "string",
          "leadTime": 0,
          "buyerCode": 0,
          "stockable": "string",
          "consigned": "string",
          "nonStock": "string",
          "itemControlType": "string",
          "storageCondition": "string",
          "criticalItems": "string",
          "internalPlantMemo": "string",
          "pricePerQty": 0
        },
        "itemCustomAttributeDetailsList": [
          {}
        ],
        "itemAdditionalFieldDetails": [
          {}
        ],
        "errorDescription": "string"
      }
    ],
    "itemManufacturerDetailsList": [
      {
        "manufacturerName": "string",
        "manufacturerModelNumber": "string",
        "manufacturerPartNumber": "string",
        "isActive": "string",
        "errorDescription": "string"
      }
    ],
    "itemNotesList": [
      {
        "action": "string",
        "serialNumber": 0,
        "type": "string",
        "classification": "string",
        "noteName": "string",
        "noteDescription": "string",
        "accessibleToSupplier": "string",
        "errorDescription": "string"
      }
    ],
    "itemImageDetailsList": [
      {
        "action": "string",
        "serialNumber": 0,
        "imageName": "string",
        "imageUrl": "string",
        "errorDescription": "string"
      }
    ],
    "itemSupportedUOMList": [
      {
        "fromUOM": "string",
        "fromConversionFactor": 0,
        "toUOM": "string",
        "toConversionFactor": 0,
        "unitPricePerUOM": 0,
        "pricePerQty": 0,
        "errorDescription": "string"
      }
    ],
    "itemStorageLocation": [
      {
        "action": "string",
        "entityCode": "string",
        "serialNumber": "string",
        "itemAdditionalFieldDetails": [
          {}
        ],
        "errorDescription": "string"
      }
    ],
    "itemTranslationsList": [
      {
        "action": "string",
        "language": "string",
        "shortName": "string",
        "itemDescription": "string",
        "relatedKeywords": "string",
        "itemSpecification": "string",
        "manufacturerName": "string",
        "errorDescription": "string"
      }
    ],
    "itemProductAttributes": [
      {
        "action": "string",
        "entityCode": "string",
        "serialNumber": "string",
        "itemAdditionalFieldDetails": [
          {}
        ],
        "errorDescription": "string"
      }
    ],
    "errorDescription": [
      {
        "section": "string",
        "errorDetails": [
          {
            "key": "string",
            "errorMessage": "string"
          }
        ]
      }
    ]
  }
]

Response

{

    "statusCode": 0,

    "url": "string”,

    "batchID": "string",

    "interval": 0,

    "interval Type": "string",

    "receivedCount": 1

}

Examples

Success Scenario – Request

{
    "ItemNumber": "85.37.20.674.9",
    "Division": "900",
    "BasicDetails": {
      "Action": null,
      "ShortName": "GASKET,RTJ,CS,CAD,OCT,RX74",
      "ItemDescription": "GASKET,RTJ,CS,CAD,OCT,RX74",
      "UNSPSC": null,
      "ClientPasCode": "99.85",
      "UOMCode": "EA",
      "IsActive": "Yes",
      "ItemStandardFieldDetails": {
        "ItemType": "Material",
        "GTIN": null,
        "ASLOnly": null,
        "IsProcurable": null,
        "IsTaxExempt": null,
        "IsActive": null,
        "IsAutomaticallyCreateOrders": null,
        "QLevel": null,
        "MinOrderedQty": null,
        "MaxOrderedQty": null,
        "BandingQty": null,
        "RelatedKeywords": null,
        "ItemSpecification": "Noun: Gaskets<br>Modifiers: Ring Joint<br>Design spec: ASME B16.20: API SPEC 6A<br>Mat: LOW CARBON STEEL,CADMIUM PLATED<br>Type of gaskets: OCTAGONAL<br>Ring identif no.: RX 74<br>Size, flange: 20.3/4 inch",
        "StandardPrice": null,
        "MovingAvgPrice": null,
        "BuyerName": null,
        "Currency": null,
        "LeadTime": null,
        "BuyerCode": null,
        "Stockable": null,
        "Consigned": null,
        "NonStock": null,
        "ItemControlType": null,
        "StorageCondition": null,
        "CriticalItems": null,
        "InternalPlantMemo": null,
        "PricePerQty": null
      },
      "ItemCustomAttributeDetailsList": null,
      "ItemAdditionalFieldDetails": null,
      "ErrorDescription": null
    },
    "ItemOrgDetailsList": [
      {
        "Action": null,
        "EntityCode": "1501",
        "ItemStandardFieldDetails": {
          "ItemType": null,
          "GTIN": null,
          "ASLOnly": null,
          "IsProcurable": null,
          "IsTaxExempt": null,
          "IsActive": "Yes",
          "IsAutomaticallyCreateOrders": null,
          "QLevel": null,
          "MinOrderedQty": null,
          "MaxOrderedQty": null,
          "BandingQty": null,
          "RelatedKeywords": null,
          "ItemSpecification": null,
          "StandardPrice": 0,
          "MovingAvgPrice": 22360.55,
          "BuyerName": null,
          "Currency": "DZD",
          "LeadTime": 15,
          "BuyerCode": null,
          "Stockable": "Yes",
          "Consigned": null,
          "NonStock": "No",
          "ItemControlType": null,
          "StorageCondition": null,
          "CriticalItems": null,
          "InternalPlantMemo": null,
          "PricePerQty": null
        },
        "ItemCustomAttributeDetailsList": null,
        "ItemAdditionalFieldDetails": null,
        "ErrorDescription": null
      },
      {
        "Action": null,
        "EntityCode": "1502",
        "ItemStandardFieldDetails": {
          "ItemType": null,
          "GTIN": null,
          "ASLOnly": null,
          "IsProcurable": null,
          "IsTaxExempt": null,
          "IsActive": "Yes",
          "IsAutomaticallyCreateOrders": null,
          "QLevel": null,
          "MinOrderedQty": null,
          "MaxOrderedQty": null,
          "BandingQty": null,
          "RelatedKeywords": null,
          "ItemSpecification": null,
          "StandardPrice": 0,
          "MovingAvgPrice": 31003.25,
          "BuyerName": null,
          "Currency": "DZD",
          "LeadTime": 0,
          "BuyerCode": null,
          "Stockable": "Yes",
          "Consigned": null,
          "NonStock": "No",
          "ItemControlType": null,
          "StorageCondition": null,
          "CriticalItems": null,
          "InternalPlantMemo": null,
          "PricePerQty": null
        },
        "ItemCustomAttributeDetailsList": null,
        "ItemAdditionalFieldDetails": null,
        "ErrorDescription": null
      }
    ],
    "ItemManufacturerDetailsList": [],
    "ItemNotesList": [],
    "ItemImageDetailsList": [],
    "ItemSupportedUOMList": [],
    "ItemStorageLocation": [],
    "ItemTranslationsList": [],
    "ErrorDescription": []
  }

Success Scenario – Response

{

    "statusCode": 202,

    "url": "https://api-smartdevafd.gep.com/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId=b982fbd47737494ba8b7af3c0d57854a",

    "batchID": "b982fbd47737494ba8b7af3c0d57854a",

    "interval": 60,

    "interval Type": "Minutes",

    "receivedCount": 1

}

Data Elements

ItemMaster
Property	Required?	Data type	Description	Validations / Exceptions
ItemNumber	Yes	String (50)	This Is BIN Number	You must provide a value for the attribute.
Division	Yes	String (50)	This value has an impact on access to items. In case a catalog is used across Source Systems (Divisions), this column will decide which division the line belongs to. If left blank, the item will be applicable for all the lines from the catalog header.	You must provide a value for the attribute. You must provide a value for the attribute from the given dropdown.
BasicDetails		BasicDetails object	Check Data Type BasicDetails for details
ItemOrgDetailsList		List of ItemOrgDetails object	Check Data Type ItemOrgDetails for details
ItemManufacturerDetailsList		List of ItemManufacturerDetails object	Check Data Type ItemManufacturerDetails for details
ItemNotesList		List of ItemNotes object	Check Data Type ItemNotes for details
ItemImageDetailsList		List of ItemImageDetails object	Check Data Type ItemImageDetails for details
ItemSupportedUOMList		List of ItemSupportedUOM objects	Check Data Type ItemSupportedUOM for details
ItemStorageLocation		List of ItemStorageLocation object	List of ItemStorageLocation object
ItemTranslationsList		List Of ItemTranslations object	Item Translation List
ItemProductAttributes		List Of Item product attributes	Item attribute list
ErrorDescription	No	List Of ErrorDescription object

BasicDetails
Property	Required?	Data type	Description	Validations / Exceptions
Action	No	String	Field to indicate the action to be performed on the record. "Create", "Update" or "Delete"
ShortName	Yes	String (1000)	Material Description Short Text	You must provide a value for the attribute.
ItemDescription	Yes	String (1000)	Material Description	You must provide a value for the attribute.
UNSPSC	No	String (50)	UNSPSC ID	Either UNSPSC or Category ID needs to be populated - the other field will be mapped as pre-uploaded taxonomy. If both are populated, they need to match to each other
ClientPasCode	No	String	Client PasCode
UOMCode	Yes	String (10)	Unit of measure code	You must provide a value for the attribute. For Items with BINs, only UOMs specified for a line in the item master can be uploaded.
IsActive	Yes	String	IsActive Yes/No	You must provide a value for the attribute. You must provide a value for the attribute from the given drop down.
ItemStandardFieldDetails	No	ItemStandardFieldDetails Object	Check Data Tyoe ItemStandardFieldDetails object for details
ItemCustomAttributeDetailsList	No	List of KeyValuePair<string, string>>	ItemCustomAttributeDetails List
ItemAdditionalFieldDetails	No	List of KeyValuePair<string, string>>	ItemAdditionalFieldDetails List
ErrorDescription		String	Error Description

ItemOrgDetails
Property	Required?	Data type	Description	Validations/ Exceptions
Action	Yes	String	Operation selection from update/create/delete
EntityCode	Yes	String	EntityCode
ItemStandardFieldDetails	Depends on setup	ItemStandardFieldDetails object	Check Data Type ItemStandardFieldDetails for details
ItemCustomAttributeDetailsList	Depends on setup	List of KeyValuePair<string, string>>	ItemCustomAttributeDetailsList
ItemAdditionalFieldDetails	Depends on setup	List of KeyValuePair<string, string>>	ItemAdditionalFieldDetails
ErrorDescription		String	ErrorDescription

ItemManufacturerDetails
Property	Required?	Data type	Description	Validations/ Exceptions
ManufacturerName	Yes	String (100)	ManufacturerName	You must provide a value for the attribute.
ManufacturerModelNumber	If ManufacturerName is filled, either of the 2 values need to be filled	String (100)	ManufacturerModelNumber
ManufacturerPartNumber		String (100)	ManufacturerPartNumber
IsActive	No	String	IsActive Values accepted: Yes No	You must provide a value for the attribute from the given drop down.
ErrorDescription	No	String	ErrorDescription

ItemNotesList
Property	Required?	Data type	Description	Validations/ Exceptions
Action	No	String	Action Field to indicate the action to be performed on the record. "Create", "Update" or "Delete" Do not fill any value if you intend to leave the data blank. It could be null or empty array "[ ]"
SerialNumber	Yes	Nullable int ( 2,14,74,83,647 )	SerialNumber
Type	Yes	String (100)	Type
Classification	Yes	String (100)	Classification
NoteName	Yes	String (100)	NoteName
NoteDescription	Yes	String (13000)	NoteDescription
AccessibleToSupplier	No	String	AccessibleToSupplier Values accepted: Yes No
ErrorDescription		String	ErrorDescription

ItemImageDetailsList
Property	Required?	Data type	Description	Validations / Exceptions
Action	No	String	Action Field to indicate the action to be performed on the record. "Create", "Update" or "Delete" Do not fill any value if you intend to leave the data blank. It could be null or empty array "[ ]'
SerialNumber	Yes	Nullable int	SerialNumber	You must provide a value for the attribute. You must provide a valid value for the attribute. Item Number\|Division\|Serial Number: Item not present to perform Operation. Item Number\|Division\|Serial Number : Combination already exists. Provide a unique record
ImageName	If SerialNumber is filled, either of the 2 values needs to be filled	String	ImageName	You must provide either the Image Name or the Image URL. Validated after clicking - Upload Image. Must match the name of the relevant image. ONLY .jpg, jpeg. image format is accepted. For the Image Name column, valid image names uploaded separately through a zipped folder will be taken into consideration.
ImageUrl		String	ImageUrl	Validated after clicking - Extract Image URL. URL link should open the image directly
ErrorDescription		String	ErrorDescription

ItemStorageLocation
Property	Required?	Data type	Description	Validations/ Exceptions
Action	No	String	Action Field to indicate the action to be performed on the record. "Create", "Update" or "Delete"
EntityCode	Depends on Setup	String	Entity code
SerialNumber		String	Serial Number
ItemAdditionalFieldDetails		List of KeyValuePair<string, string>>	ItemAdditionalFieldDetails
ErrorDescription		String	Description of the error

ItemSupportedUOM
Property	Required?	Data type	Description	Validations/ Exceptions
FromUOM	Yes	String (10)	FromUOM	You must provide a value for the attribute. You must provide a value for the attribute from the given drop down.
FromConversionFactor	Yes	Nullable decimal ( 2,14,74,83,647 )	FromConversionFactor	You must provide a value for the attribute.
ToUOM	Yes	String (10)	ToUOM	You must provide a value for the attribute. You must provide a value for the attribute from the given drop down.
ToConversionFactor	Yes	Nullable decimal ( 2,14,74,83,647 )	ToConversionFactor	You must provide a value for the attribute.
UnitPricePerUOM	No	Nullable decimal ( 2,14,74,83,647 )	UnitPricePerUOM
ErrorDescription		String	ErrorDescription

ItemStandardFieldDetails
Property	Required?	Data type	Description	Validations / Exceptions
ItemType	Depends on Setup	String	ItemType Flag to Indicate between "Material" / "Service" Values accepted: Material Fixed Service Variable Service
GTIN		String (40)	GTIN
ASLOnly		String	ASLOnly Values accepted: Yes No
IsProcurable		String	IsProcurable Values accepted: Yes No
IsTaxExempt		String	IsTaxExempt Values accepted: Yes No
IsActive		String	IsActive Values accepted: Yes No	You must provide a value for the attribute from the given drop down.
IsAutomaticallyCreateOrders		String	IsAutomaticallyCreateOrders Values accepted: Yes No
QLevel		String (50)	QLevel
MinOrderedQty		Nullable decimal ( 2,14,74,83,647 )	MinOrderedQty	You must provide a valid value for the attribute.
MaxOrderedQty		Nullable decimal ( 2,14,74,83,647 )	MaxOrderedQty	You must provide a valid value for the attribute.
BandingQty		Nullable decimal ( 2,14,74,83,647 )	BandingQty	You must provide a valid value for the attribute.
RelatedKeywords		String (500)	RelatedKeywords
ItemSpecification		String (6000)	ItemSpecification
StandardPrice		Nullable decimal ( 2,14,74,83,647 )	StandardPrice
MovingAvgPrice		Nullable decimal ( "99999999999.9999" )	MovingAvgPrice	You must provide a valid value for the attribute.
BuyerName		String (50)	BuyerName
Currency		String (20)	Currency
LeadTime		Nullable int	LeadTime	You must provide a valid value for the attribute.
BuyerCode		Nullable long	BuyerCode
Stockable		String	Stockable Values accepted: Yes No
Consigned		String	Consigned Values accepted: Yes No
NonStock		String	NonStock Values accepted: Yes No
ItemControlType		String	ItemControlType
StorageCondition		String	StorageCondition
CriticalItems		String	CriticalItems
InternalPlantMemo		String (12000)	InternalPlantMemo

ItemStandardFieldDetails
Property	Required?	Data type	Description	Validations/Exceptions
ItemType	No	String	Item type selector.	Select from the dropdown.
GTIN	No	String	GTIN number of an item	Max. 40 characters.
ASLOnly	No	String	AslOnly
IsProcurable	NO	string	This Indicated whether the item is procurable or not
IsTaxExempt	No	string	This indicated whether the item is Taxexemt or not
IsActive	YES	String	This indicates whether the item is active or not	Select value from the dropdown.
IsAutomaticallyCreateOrders	No	String	This indicated whether the Order create automatically or not
QLevel	No	String	QLevel of an item
MinOrderedQty	NO	decimal	Predifined minimum quantity of the order	Limitation is the max. integer value: 2,147,483,647
MaxOrderedQty	NO	decimal	Predifined miximum quantity of the order	Limitation is the max. integer value: 2,147,483,647
BandingQty	NO	decimal	Intervals in which the quantity can be increased	Limitation is the max. integer value: 2,147,483,647
RelatedKeywords	No	String	Related Keywords of an item
ItemSpecification	NO	String	Helps to specify the item.	Max. 1000 characters.
StandardPrice	No	decimal	Helps to specify the standard price of item
MovingAvgPrice	No	decimal	Helps to specify the Moving average price of item
BuyerName	No	String	Helps to specify the Buyer Name
Currency	NO	string	Corresponding Currency of line item	Only dropdown values allowed
LeadTime	NO	Integer	The time the delivery takes in days	Limitation is the max. integer value: 2,147,483,647
BuyerCode	No	String	Buyer code of the item
Stockable	NO	string	This indicated whether the item is stockable or not
Consigned	No	string	Consigned
ItemControlType	No	string	Helps to specify the control type of item
StorageCondition	No	string	Helps to specify the Storage condition of item
CriticalItems	No	String	Critical items
InternalPlantMemo	NO	String	Internal Plant Memo
PricePerQty	No	integer	Price per quantity

itemSupportedUOMList
Property	Required?	Data type	Description	Validations / Exceptions
fromUOM	No	String	Unit of Measure	Select values from drop down. For Items with BINs, only UOMs specifified for a line in the item master can be uploaded.
fromConversionFactor	No	decimal	Conversion factor
toUOM	No	String	To Uom
toConversionFactor	No	decimal	To conversion factor
unitPricePerUOM	No	decimal	Unit price per UOM
pricePerQty	no	int	Price for each quantity
errorDescription	No	string	Error description

itemTranslationsList
Property	Required?	Data type	Description	Validations / Exceptions
action	No	String	Operation selection from update/create/delete	By default action will be selected
language	No	String	language
shortName	No	String	The Short description of the item.	Max. 40 characters.
itemDescription	No	String	The Long description of the item	Max. 1000 characters.
relatedKeywords	No	String	Keywords for search engine.	Max. 400 characters.
itemSpecification	No	String	Helps to specify the item.	Max. 1000 characters.
manufacturerName	No	String	Name of the corresponding Item's manufacturer	Max. 50 characters.
errorDescription	No	String	Error description

itemProductAttributes
Property	Required?	Data type	Description	Validations / Exceptions
action	No	String	Operation selection from update/create/delete	By default action will be selected
entityCode	No	String	Entity code from which item is shared
serialNumber	No	String	Serial number
itemAdditionalFieldDetails	No	List of Key value pair	List of key value pair of Item additional field details
errorDescription	No	String	Error description

errorDescription
Property	Required?	Data type	Description	Validations / Exceptions
section	No	String	Specify in which section error is coming
errorDetails	No	List of error details	Error details

errorDetails
Property	Required?	Data type	Description	Validations / Exceptions
key	No	String	Key name
errorMessage	No	String	Error messege