InBoundCatalogDetails (POST)

Overview

This POST API allows creating and updating of catalog details.

URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/InBoundCatalog/InBoundCatalogDetails

 

Request
{
  "catalogBasicDetails": {
    "catalogName": "string",
    "division": "string",
    "supplierCode": "string",
    "administratorName": "string",
    "administratorEmailId": "string",
    "contractNumber": "string",
    "startDate": "2022-03-10T11:04:32.927Z",
    "endDate": "2022-03-10T11:04:32.927Z",
    "errorDescription": "string"
  },
  "linesDetailsList": [
    {
      "action": "string",
      "lineNumber": 0,
      "buyerItemNumber": "string",
      "supplierItemNumber": "string",
      "currencyCode": "string",
      "division": "string",
      "type": "string",
      "shortName": "string",
      "itemDescription": "string",
      "unspsc": "string",
      "clientPasCode": "string",
      "isActive": "string",
      "keywords": "string",
      "leadTime": 0,
      "price": 0,
      "uom": "string",
      "orgEntities": [
        "string"
      ],
      "itemSpecification": "string",
      "supportedUOM": [
        {
          "supportedUOM": "string",
          "conversionFactorsForSupportedUOMWRTUOM": "string",
          "pricePerSupportedUOM": "string",
          "pricePerQtyForSupportedUOM": "string"
        }
      ],
      "manufacturer": "string",
      "manufacturerPartNumber": "string",
      "manufacturerModelNumber": "string",
      "minimumOrderQuantity": 0,
      "maximumOrderQuantity": 0,
      "banding": 0,
      "isTaxExempt": "string",
      "contractNumber": "string",
      "contractLineNumber": "string",
      "startDate": "2022-03-10T11:04:32.927Z",
      "endDate": "2022-03-10T11:04:32.927Z",
      "gtin": "string",
      "imageName": "string",
      "imageURL": "string",
      "catalogStandardFieldDetails": {
        "materialSafetyRequired": "string",
        "serviceCategory": "string",
        "incoTermCode": "string",
        "point": "string",
        "mrpFlag": "string",
        "contractedQuantity": 0,
        "flexiblePrice": "string"
      },
      "customAttributeDetailsList": [
        {}
      ],
      "additionalFieldDetailsList": [
        {}
      ],
      "errorDescription": "string",
      "pricePerQty": 0
    }
  ],
  "priceModifiersList": [
    {
      "action": "string",
      "lineNumber": 0,
      "buyerItemNumber": "string",
      "supplierItemNumber": "string",
      "shortName": "string",
      "currencyCode": "string",
      "division": "string",
      "serialNumber": 0,
      "type": "string",
      "plant": "string",
      "startDate": "2022-03-10T11:04:32.927Z",
      "endDate": "2022-03-10T11:04:32.927Z",
      "effectivePrice": 0,
      "percent": 0,
      "uom": "string",
      "quantity": 0,
      "errorDescription": "string",
      "pricePerQty": 0
    }
  ],
  "sharingDetailsList": [
    {
      "action": "string",
      "entityType": "string",
      "sharingEntityCode": "string",
      "errorDescription": "string"
    }
  ],
  "itemImagesList": [
    {
      "action": "string",
      "lineNumber": 0,
      "serialNumber": 0,
      "imageName": "string",
      "imageURL": "string",
      "errorDescription": "string"
    }
  ],
  "notesAndAttachmentsList": [
    {
      "action": "string",
      "lineNumber": 0,
      "serialNumber": 0,
      "type": "string",
      "classification": "string",
      "fileNameOrNotes": "string",
      "descriptionOrURL": "string",
      "accessibleToSupplier": "string",
      "includeOn": "string",
      "errorDescription": "string"
    }
  ],
  "translationsList": [
    {
      "action": "string",
      "lineNumber": 0,
      "buyerItemNumber": "string",
      "supplierItemNumber": "string",
      "currencyCode": "string",
      "division": "string",
      "uom": "string",
      "language": "string",
      "shortName": "string",
      "itemDescription": "string",
      "keywords": "string",
      "itemSpecification": "string",
      "manufacturer": "string",
      "errorDescription": "string"
    }
  ],
  "isAutoPublish": true,
  "isImageExtract": true,
  "requestStatus": true,
  "catalogErrorDescription": [
    {
      "section": "string",
      "catalogErrorDetails": [
        {
          "lineNumber": "string",
          "serialNumber": "string",
          "errorMessage": "string"
        }
      ]
    }
  ],
  "readOnlyFields": [
    {
      "section": "string",
      "fieldNames": [
        "string"
      ],
      "customAttributes": [
        "string"
      ],
      "additionalFields": [
        "string"
      ]
    }
  ]
}

 

Response
{
    "statusCode": 0,
    "url": string,
    "batchID": string,
    "interval": 0,
    "interval Type": string,
    "receivedCount": 1
}

 

Examples

Success Scenario - Request 

{
    "CatalogBasicDetails": {
        "CatalogName": "CAT-27102021-02",
        "Division": "AMB",
        "SupplierCode": "PC-2017.000388",
        "AdministratorName": "URT_EXXONMOBIL.ADMIN@GEP.COM",
        "AdministratorEmailId": "URT_EXXONMOBIL.ADMIN@GEP.COM",
        "ContractNumber": "Con-27102021-02",
        "StartDate": "2021-08-30T00:00:00",
        "EndDate": "2021-11-14T00:00:00",
        "ErrorDescription": null
    },
    "LinesDetailsList": [
        {
            "Action": "",
            "LineNumber": 1,
            "BuyerItemNumber": "",
            "SupplierItemNumber": "CAT-27102021-02-01",
            "CurrencyCode": "CAD",
            "Division": "AMB",
            "Type": "Material",
            "ShortName": "GAS MIXTURE 2 SULFUR DIOXIDE 1.8%_new",
            "ItemDescription": " Class CH28GMX: GAS MIXTURE MULTIPLE COMPONENT NUMBER_OF_COMPONENTS: 2, COMPONENT_1: SULFUR DIOXIDE 1.8%, COMPONENT_2: NITROGEN BALANCE, GRADE: PRIMARY, VOLUME-CYLINDER SIZE: 142 CUFT AT 2000 PSI SIZE AS, CONNECTION: CGA 660, IOL MSDS NUMBER: 20946_new",
            "UNSPSC": "44100350025040",
            "ClientPasCode": null,
            "IsActive": "Yes",
            "Keywords": null,
            "LeadTime": 0,
            "Price": 12,
            "UOM": "CY",
            "OrgEntities": null,
            "ItemSpecification": null,
            "SupportedUOM": null,
            "Manufacturer": null,
            "ManufacturerPartNumber": null,
            "ManufacturerModelNumber": null,
            "MinimumOrderQuantity": null,
            "MaximumOrderQuantity": null,
            "Banding": null,
            "IsTaxExempt": null,
            "ContractNumber": "Con-27102021-02",
            "StartDate": "2021-08-30T00:00:00",
            "EndDate": "2021-11-14T00:00:00",
            "GTIN": null,
            "ImageName": null,
            "ImageURL": null,
            "CatalogStandardFieldDetails": {
                "MaterialSafetyRequired": null,
                "ServiceCategory": null,
                "IncoTermCode": null,
                "Point": null,
                "MRPFlag": null,
                "ContractedQuantity": null,
                "FlexiblePrice": null
            },
            "CustomAttributeDetailsList": [],
            "ErrorDescription": null
        }
    ],
    "PriceModifiersList": [],
    "SharingDetailsList": [],
    "ItemImagesList": [
        {
            "ACTION": "",
            "LINENUMBER": 1,
            "SERIALNUMBER": 11,
            "ImageName": "",
            "ImageURL": "https://assets.fishersci.com/TFS-Assets/CMD/product-images/2012 Catalog - SPE110.jpg-650.jpg"
        }
    ],
    "NotesAndAttachmentsList": [],
    "IsAutoPublish": true,
    "IsImageExtract": true,
    "RequestStatus": false,
    "CatalogErrorDescription": null,
    "ReadOnlyFields": []
}

Success Scenario – Response

{
    "statusCode": 202,
    "url": "https://api-smartqcafd.gep.com/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId=916e96700032411b9b8b272254220631",
    "batchID": "916e96700032411b9b8b272254220631",
    "interval": 60,
    "interval Type": "Minutes",
    "receivedCount": 1
}

Error Scenario – Request

{
    "CatalogBasicDetails": {
        "CatalogName": "CAT-27102021-02",
        "Division": "AMB",
        "SupplierCode": "PC-2017.000388",
        "AdministratorName": "URT_EXXONMOBIL.ADMIN@GEP.COM",
        "AdministratorEmailId": "URT_EXXONMOBIL.ADMIN@GEP.COM",
        "ContractNumber": "Con-27102021-02",
        "StartDate": "2025-08-30T00:00:00",
        "EndDate": "2021-11-14T00:00:00",
        "ErrorDescription": null
    },
    "LinesDetailsList": [
        {
            "Action": "",
            "LineNumber": 1,
            "BuyerItemNumber": "",
            "SupplierItemNumber": "CAT-27102021-02-01",
            "CurrencyCode": "CAD",
            "Division": "AMB",
            "Type": "Material",
            "ShortName": "GAS MIXTURE 2 SULFUR DIOXIDE 1.8%_new",
            "ItemDescription": " Class CH28GMX: GAS MIXTURE MULTIPLE COMPONENT NUMBER_OF_COMPONENTS: 2, COMPONENT_1: SULFUR DIOXIDE 1.8%, COMPONENT_2: NITROGEN BALANCE, GRADE: PRIMARY, VOLUME-CYLINDER SIZE: 142 CUFT AT 2000 PSI SIZE AS, CONNECTION: CGA 660, IOL MSDS NUMBER: 20946_new",
            "UNSPSC": "44100350025040",
            "ClientPasCode": null,
            "IsActive": "Yes",
            "Keywords": null,
            "LeadTime": 0,
            "Price": 12,
            "UOM": "CY",
            "OrgEntities": null,
            "ItemSpecification": null,
            "SupportedUOM": null,
            "Manufacturer": null,
            "ManufacturerPartNumber": null,
            "ManufacturerModelNumber": null,
            "MinimumOrderQuantity": null,
            "MaximumOrderQuantity": null,
            "Banding": null,
            "IsTaxExempt": null,
            "ContractNumber": "Con-27102021-02",
            "StartDate": "2021-08-30T00:00:00",
            "EndDate": "2021-11-14T00:00:00",
            "GTIN": null,
            "ImageName": null,
            "ImageURL": null,
            "CatalogStandardFieldDetails": {
                "MaterialSafetyRequired": null,
                "ServiceCategory": null,
                "IncoTermCode": null,
                "Point": null,
                "MRPFlag": null,
                "ContractedQuantity": null,
                "FlexiblePrice": null
            },
            "CustomAttributeDetailsList": [],
            "ErrorDescription": null
        }
    ],
    "PriceModifiersList": [],
    "SharingDetailsList": [],
    "ItemImagesList": [
        {
            "ACTION": "",
            "LINENUMBER": 1,
            "SERIALNUMBER": 11,
            "ImageName": "",
            "ImageURL": "https://assets.fishersci.com/TFS-Assets/CMD/product-images/2012 Catalog - SPE110.jpg-650.jpg"
        }
    ],
    "NotesAndAttachmentsList": [],
    "IsAutoPublish": true,
    "IsImageExtract": true,
    "RequestStatus": false,
    "CatalogErrorDescription": null,
    "ReadOnlyFields": []

Error Scenario – Response

{
    "Status": "401",
    "ErrorDetails": [
        {
            "Key": "",
            "Description": "UnAuthorized Access to BulkInterfaces."
        }
    ],
    "SuccessDetails": []
}

 

Data Elements

Catalog

Property

Required?

Data type

Description

Validations/Exceptions

CatalogBasicDetails

Yes

CatalogBasicDetails Object

Provide the basic details of the catalog

 

LinesDetailsList

 

List of LinesDetails Object

Provide the details of uploaded line items

 

PriceModifiersList

 

List of PriceModifiers Object

Provide the details of the price modifier

 

SharingDetailsList

 

List of SharingDetails Object

Provide the details of sharing entity

 

ItemImagesList

 

List of ItemImage Object

Provide the details of the Item Image List

 

NotesAndAttachmentsList

 

List of NotesAndAttachments Object

Provide the details of Notes and attachment

 

TranslationsList

 

List of translations object

Provide the details of translations

 

IsAutoPublish

 

bool

Helps to specify whether the item will be auto-publish or not

 

IsImageExtract

 

bool

Is Image Extract

 

RequestStatus

 

bool

Request Status

 

CatalogErrorDescription

 

List of CatalogErrorDescription Object

Error description of catalog

 

ReadOnlyFields

 

List of ReadOnlyField

Read-only fields

 

 

CatalogBasicDetails

Property

Required?

Data type

Description

Validations/Exceptions

CatalogName

yes

string

Name of the catalog

The upload process failed because of an internal error. 

Contact your helpdesk or try again later.

 

Division

yes

String

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 belongs to the line.

If left blank, the item will be applicable for all the lines from the catalog header.

"| Division*: You must provide a value for the attribute.

Division: You cannot modify the value of the attribute."

 

SupplierCode

yes

string

Supplier code of the item.

The upload process failed because of an internal error. 

Contact your helpdesk or try again later."

 

AdministratorName

No

string

This indicates the user name

 

AdministratorEmailId

No

string

This indicates the email id of the Administrator.

 

ContractNumber

No

string

The number of the relevant contract. If populated, Item will be shown as contacted with the green triangle in the requestor view.

Max. 200 characters.

StartDate

yes

DateTime

For hosted catalog lines, should be within the range of Catalog Start Date and End Date (if present). Use the date format applicable to your country.

The start date can not be null.

EndDate

yes

DateTime

For hosted catalog lines, should be within the range of Catalog Start Date and End Date (if present). Use the date format applicable to your country.

The end date can not be null.

ErrorDescription

no

string

 

 

 

LinesDetailsList

Property

Required?

Data type

Description

Validations/Exceptions

Action

yes

String

Operation can be update/create/delete

By default, action will be selected

LineNumber

yes

integer

Reference to the line number from catalog lines.

Must match the line number from catalog lines. The limitation is the max. integer value: 2,147,483,647

BuyerItemNumber

no

String

Non-mandatory field, will be populated based on records in catalog lines.

Must match the Item Master reference.

SupplierItemNumber

yes

string

Identifier to make the line items unique. Recommend to use the numbers starting from 1.

Max. 50 characters. Combination

CurrencyCode

yes

string

Corresponding Currency of the line item

Select the values from the drop-down.

Division

yes

string

This value has an impact on access to items in the catalog. n case a catalog is used across Source Systems (Divisions), this column will decide which division belongs to the line.

If left blank, the item will be applicable for all the lines from the catalog header.

Only drop-down values are allowed. Must match the Division/Source System specified in the catalog header. Mandatory for items containing Buyer Item Number

Type

no

string

Item type selector.

Only dropdown values are allowed. If left blank, defaults to "Material"

ShortName

yes

string

The Short description of the line item.

Max. 40 characters.

ItemDescription

yes

string

The Long description of the line item

Max. 1000 characters.

UNSPSC

no

String

UNSPSC code

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 each other

ClientPasCode

yes

String

Client PasCode

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 each other

IsActive

yes

String

This indicates whether the item is active or not

Select the proper value from the dropdown.

Keywords

No

String

Keywords for search engine.

Max. 400 characters.

LeadTime

yes

Integer

The time the delivery takes in days

The limitation is the max. integer value: 2,147,483,647

Price

Yes

Decimal

                     Corresponding Price of the line item

The limitation is the max. integer value: 2,147,483,647

UOM

No

String

Unit of Measure

Only dropdown values are allowed. For Items with BINs, only UOMs specified for a line in the item master can be uploaded.

OrgEntities

no

List of string

This indicates plant codes

 

ItemSpecification

No

string

Helps to specify the item.

Max. 1000 characters.

SupportedUOM

Required IF Conversion factor and Price Per Supported UOM is populated.

List of String

Additional UOM can be used for an item. Once Supported UOM is added Columns T and U need to be populated.

Must match the UOM taxonomy. For Items with BINs, only UOMs specified for a line in the item master can be uploaded.

Manufacturer

no

String

Name of the corresponding Item's manufacturer

Max. 50 characters.

ManufacturerPartNumber

No

String

The item number provided by the manufacturer

Max. 256 characters.

ManufacturerModelNumber

No

string

Additional field to specify the model number.

Max. 500 characters.

MinimumOrderQuantity

No

Integer

Predefined minimum quantity of the order

The limitation is the max. integer value: 2,147,483,647

MaximumOrderQuantity

No

Integer

The predefined maximum quantity of the order

The limitation is the max. integer value: 2,147,483,647

Banding

No

integer

Intervals in which the quantity can be increased

The limitation is the max. integer value: 2,147,483,647

IsTaxExempt

no

String

Tax relevancy. If left blank will default to No.

Only dropdown values are allowed.

ContractNumber

no

String

Contract Number

 

StartDate

yes

DateTime

For hosted catalog lines, should be within the range of Catalog Start Date and End Date (if present). Use the date format applicable to your country.

Start Date can not be null.

EndDate

yes

Date Time

For hosted catalog lines, should be within the range of Catalog Start Date and End Date (if present). Use the date format applicable to your country.

The end date can not be null.

GTIN

No

String

GTIN number of an item

Max. 40 characters.

ImageName

NO

String

Name of the Image

 

ImageURL

No

String

Url of the image

 

CatalogStandardFieldDetails

 

StandardFirlDetails object

Catalog standard field details

 

CustomAttributeDetailsList

 

List of key-value pair

Custom Attribute Details

 

AdditionalFieldDetailsList

 

List of key-value pair

Additional Field Details

 

ErrorDescription

No

String

 

 

supportedUOM

Property

Required?

Data type

Description

Validations / Exceptions

supportedUOM

No

String

To specify the UOM of items

 

conversionFactorsForSupportedUOMWRTUOM

No

String

conversionFactorsForSupportedUOMWRTUOM

 

pricePerSupportedUOM

No

String

Price per supported Uom

 

pricePerQtyForSupportedUOM

No

String

Helps to pricePerQtyForSupportedUOM Point

 

 

CatalogStandardFieldDetails

Property

Required?

Data type

Description

Validations / Exceptions

MaterialSafetyRequired

No

String

To specify whether material safety is required or not

 

ServiceCategory

No

String

Helps to indicate the service category

 

IncoTermCode

No

String

Helps to indicate Inco Term Code

 

Point

No

String

Helps to indicate Point

 

MRPFlag

No

String

Helps to indicate MRPFlag

 

ContractedQuantity

No

Decimal

Helps to indicate ContractQuantity

 

FlexiblePrice

No

String

To specify whether an item is price flexible or not

 

PRNumber

no

string

PR NUmber

 

PRLineNumber

no

String

PRLine number

 

CASNumber

no

string

CAS Number

 

 

ItemImagesList

Property

Required?

Data type

Description

Validations / Exceptions

ACTION

yes

String

Operation can be update/create/delete

By default, action will be selected.

LINENUMBER

yes

Integer

Reference to the line number from catalog lines.

Must match the line number from catalog lines. The limitation is the max. integer value: 2,147,483,647

SERIALNUMBER

No

long

Serial number of an item

 

ImageName

No

String

Name of the Image

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

No

String

Url of the image

Validated after clicking - Extract Image URL. URL link should open the image directly

ErrorDescrition

No

string

 

 

 

PriceModifiersList

Property

Required?

Data type

Description

Validations / Exceptions

ACTION

yes

String

Operation can be update/create/delete

By default, action will be selected.

LINENUMBER

yes

Integer

Reference to the line number from catalog lines.

Must match the line number from catalog lines. The limitation is the max. integer value: 2,147,483,647

buyerItemNumber

no

String

Non-mandatory field, will be populated based on records in catalog lines.

Must match the Item Master reference.

supplierItemNumber

yes

string

Identifier to make the line items unique. Recommend to use the numbers starting from 1.

Max. 50 characters. Combination

shortName

yes

string

The Short description of the line item.

Max. 40 characters.

currencyCode

yes

String

Corresponding Currency of the line item

Select the proper value from the drop-down.

division

yes

string

This value has an impact on access to items in the catalog. n case a catalog is used across Source Systems (Divisions), this column will decide which division belongs to the line.

If left blank, the item will be applicable for all the lines from the catalog header.

Only dropdown values are allowed. Must match the Division/Source System specified in the catalog header. Mandatory for items containing Buyer Item Number

serialNumber

No

long

Serial number of the item

 

type

no

string

Item type selector.

Only dropdown values are allowed. If left blank defaults to "Material".

plant

no

string

 

Plant code of the catalog

Only valid Plant Codes can be uploaded. Only Plant Code / Codes specified in catalog sharing can be uploaded.

startDate

yes

DateTime

For hosted catalog lines, should be within the range of Catalog Start Date and End Date (if present). Use the date format applicable to your country.

The start date can not be null.

endDate

yes

DateTime

For hosted catalog lines, should be within the range of Catalog Start Date and End Date (if present). Use the date format applicable to your country.

The end date can not be null.

effectivePrice

no

integer

Price of the price condition. In case Surcharge / Discount is used - a surcharge will be calculated from the percent and price in catalog lines.

The limitation is the max. integer value: 2,147,483,647

percent

no

integer

Percentage of Discount / Surcharge from the price in sheet Catalog Lines.

The limitation is the max. integer value: 2,147,483,647

uom

no

string

If left blank will default to UOM from Catalog Lines.

Must match the UOM from catalog lines.

quantity

no

integer

Quantity for staggered pricing. In case 10 is added, the price will be for quantity 10 and higher. For quantity, less than 10 is a valid price from catalog lines.

Limitation is the max. integer value: 2,147,483,647

errorDescription

no

string

Error description

 

pricePerQty

no

integer

Price per quantity

 

sharingDetailsList

Property

Required?

Data type

Description

Validations / Exceptions

ACTION

no

String

Operation can be update/create/delete

By default, action will be selected.

entityType

no

string

Entity type

 

sharingEntityCode

No

string

Sharing entity code

 

errorDescription

No

String

Error description

 

 

notesAndAttachmentsList

Property

Required?

Data type

Description

Validations / Exceptions

ACTION

no

String

Operation can be update/create/delete

By default, action will be selected

lineNumber

yes

Integer

Reference to the line number from catalog lines.

Must match the line number from catalog lines. The limitation is the max. integer value: 2,147,483,647

serialNumber

yes

long

Identifier to make the line items unique. Recommend to use the numbers starting from 1.

The limitation is the max. integer value: 2,147,483,647

type

yes

String

Type of the relevant documents

Select drop-down values.

classification

yes

string

Classification of an item.

Select drop-down values.

fileNameOrNotes

no

string

1) for Notes: Note itself.

2) for Attachments: N/A

3) for URL: URL itself.

Max. 1000 characters.

descriptionOrURL

no

string

1) for Notes: Note with 100-0 character limitation. Will open a pop-up with the note.

2) for Attachments: Not used for attachments.

3) for URL: functioning URL which will open after the user clicks the link.

Max. 1000 characters.

accessibleToSupplier

no

string

Whether the supplier can access this document or not.

Select proper drop-down values.

includeOn

no

string

Where the document should be included.

Select proper drop-down values.

errorDescription

no

string

Error description

 

 

translationsList

Property

Required?

Data type

Description

Validations / Exceptions

ACTION

no

String

Operation can be update/create/delete

By default, action will be selected

LINENUMBER

yes

Integer

Reference to the line number from catalog lines.

Must match the line number from catalog lines.

The limitation is the max. integer value: 2,147,483,647

buyerItemNumber

No

String

Non-mandatory field, will be populated based on records in catalog lines.

Must match the Item Master reference.

supplierItemNumber

yes

string

Identifier to make the line items unique. Recommend to use the numbers starting from 1.

Max. 50 characters. Combination

currencyCode

yes

string

Corresponding Currency of the line item

Select the values from the drop-down.

Division

yes

String

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 belongs to the line.

If left blank, the item will be applicable for all the lines from the catalog header.

"| Division*: You must provide a value for the attribute.

Division: You cannot modify the value of the attribute."

 

uom

no

String

If left blank will be defaulted to UOM from Catalog Lines.

Must match the UOM from catalog lines.

Language

no

string

 

 

ShortName

yes

string

The Short description of the line item.

Max. 40 characters.

itemDescription

yes

string

The Long description of the line item

Max. 1000 characters.

keywords

no

string

Keywords for search engine.

Max. 400 characters.

itemSpecification

no

string

Helps to specify the item.

Max. 1000 characters.

manufacturer

no

String

Name of the corresponding Item's manufacturer

Max. 50 characters.

errorDescription

no

string

 

 

CatalogErrorDescription

Property

Required?

Data type

Description

Validations / Exceptions

section

No

String

Specify in which section error is coming

 

CatalogErrorDetails

no

List of strings

Error details

 

CatalogErrorDetails

Property

Required?

Data type

Description

Validations / Exceptions

LineNumber

No

String

Specify in which line error is coming

 

SerialNumber

no

strings

Serial number

 

ErrorMessege

no

string

Error messege

 

readOnlyFields

Property

Required?

Data type

Description

Validations / Exceptions

section

No

String

Specify in which section error is coming

 

fieldNames

no

List of strings

Fields name

 

customAttributes

No

List of strings

Key names

 

additionalFields

No

List of strings

The key name of Additional fields