Page tree
Skip to end of metadata
Go to start of metadata

Description

A new outbound Catalog Add/Edit message is generated and sent to a third-party system for each of the events listed below:

  • Insert new catalog item in EDGE
  • Update an existing catalog item in EDGE
  • Update catalog item dynamic field
  • Update catalog item/project assignment
  • Update catalog item/SKU assignment
  • Update catalog item/category assignment
  • Update catalog item/files assignment
  • Update catalog item/rules assignment
  • Update catalog item/prerequisites assignment
  • Update catalog item/auto includes assignment
  • Update catalog item/cross sell assignment
  • Update catalog item/price list assignment

Request

URLURL from associated message destination pipe
ParametersNameTypeRequiredDescriptionIndex
requestIdStringYUnique message identifier
sourceSystemIdStringYSystem initiating message (MessageDestination.providerCode)
destinationSystemIdStringY

EDGE Merchant identifier (MessageDestination.xRefMerchantId)


messageNameStringYFixed value "CatalogAddEdit" will be sent
statusCodeStringYStatus Code. Valid values: new, active, deleted, inactive
itemTypeNameStringNItem type as defined in EDGE
uomNameStringNUnit of measure
catalogTypeCodeString NCatalog type identifier
Valid values = standard, giftCard
(If no value or an invalid value is provided, defaults to “standard”)

catalogCodeString NCatalog item identifierY
catalogItemStringYEDGE catalog itemY
catalogNameStringYName of catalog itemY

catalogNotes

StringNCatalog notes
retailPriceNumberYRetail price of item
shortDescriptionStringNBrief description of item
longDescriptionStringNDetailed description of item
orderQuantityNumberNQuantity of item to be ordered
custodianUsernameStringNEDGE custodian user name
defaultDeliveryMethodCodeStringNEDGE default delivery method. Valid values [ship, email, download, fax, print]
minOrderQtyNumberNMinimum count of item ordered at one time
maxOrderQtyNumberNMaximum count of item ordered at one time
shippingAmountNumberNValue to charge for shipping
handlingAmountNumberNValue to charge for handling
salesAccountStringNEDGE sales account
sortOrderStringNControls display sequence when displaying list of multiple catalog items
isElectronicBooleanNtrue = electronic item, default = false
isDownloadableBooleanNtrue = customer can download item, default = false
isTaxableBooleanNtrue = calculate and charge tax for this item, default = true
isAllowAutoshipBooleanNtrue = allow auto ship, default = true
isChargeShippingBooleanNtrue = charge for shipping, default = true
isTaxResellersBooleanNtrue = item is tax exempt, default = true
isBudgetItemBooleanNtrue = item uses EDGE budgets, default = false
isSearchableBooleanNtrue = item is searchable, default = true
startDateStringNDate item is available, default = current date (format: yyyy-MM-dd)
endDateStringNDate item is no longer available (format: yyyy-MM-dd)
catalogTaxClassCodeStringNEDGE tax class
dutyTaxAmountNumberNLine item duty tax amount
skusArrayNSKU items associated with catalog item
filesArrayNImage files associated with a catalog
• fileNameStringYName of file
• isDefaultBooleanNWhen this attribute is used on a specific filename element,
OpenTools associates the specified file as the default file for the EDGE catalog item

projectCodesArrayNMerchant projects associated with this catalog item
categoryCodesArrayNCategories this catalog assigned to
preRequisitesArrayNPrerequisites
deliveryMethodCodesArrayNEDGE delivery methods. Valid values [ship, email, download, fax, print]
priceListsArrayNPrice lists associated with this catalog item
• startRangeNumberNStart quantity range
• endRangeNumberNEnd quantity range
• changeValueNumberNChange amount value
• changeCodeStringNChange Code (valid values: FlatChange, FlatPrice, PercentChange)
• priceListCodeStringNPrice lists – Code
• localeCodeStringNLocale associated with this price list
localesArrayNLocales associated with this catalog item
• localeCodeStringYLocale Code (e.g. en-US)
• catalogItemStringYEDGE catalog item
• catalogNameStringYName of catalog item
• catalogNotesStringYCatalog notes
• shortDescriptionStringYBrief description of item
• longDescriptionStringYDetailed description of item
• retailPriceNumberYRetail price of item
• minRetailPriceNumberNMinimum retail price of item
• shippingAmountNumberNValue to charge for shipping
• handlingAmountNumberNValue to charge for handling
dynamicFieldsArrayNDynamic fields
• dynamicFieldCodeStringYCode to identify the field within EDGE
• dynamicFieldLabelStringNDisplayed label for the field
• dynamicFieldValueStringYValue of the dynamic field defined for the specific custom attribute
Example
JSON
{
   "statusCode": "active",
   "catalogTypeCode": "standard",
   "catalogCode": "Avengers0",
   "catalogItem": "Avengers0",
   "catalogName": "Avengers0",
   "catalogNotes": "test note by Max",
   "retailPrice": 38,
   "shortDescription": "Short description for Avengers0 furniture",
   "longDescription": "Long description Avengers0 furniture",
   "custodianUsername": "defaultAdmin",
   "defaultDeliveryMethodCode": "email",
   "salesAccount": "",
   "sortOrder": "",
   "isElectronic": false,
   "isDownloadable": false,
   "isTaxable": true,
   "isAllowAutoship": true,
   "isChargeShipping": true,
   "isTaxResellers": true,
   "isBudgetItem": false,
   "isSearchable": true,
   "startDate": "2016-01-23",
   "catalogTaxClassCode": "Shipping01",
   "skus": [
      "New_SKU_Item4",
      "PaymentSku_25",
      "UsageSKU",
      "Abyss108",
      "DBTO",
      "blacknight1,068",
      "Blacknight_BTS_KIT_304",
      "Abyss101Abyss101",
      "Blacknight_BTO_KIT_304",
      "BTOAugustCom3",
      "123",
      "BTS_Usage"
   ],
   "files": [],
   "projectCodes": [
      "branchna"
   ],
   "categoryCodes": [
      "STD_BTO"
   ],
   "preRequisites": [],
   "deliveryMethodCodes": [
      "ship"
   ],
   "priceLists": [
      {
         "startRange": 1,
         "changeValue": -10,
         "changeCode": "PercentChange",
         "priceListCode": "Test_Pricelist_01",
         "localeCode": "en-US"
      }
   ],
   "locales": [],
   "dynamicFields": [
      {
         "dynamicFieldCode": "New_DYN_001",
         "dynamicFieldLabel": "New_DYN_001",
         "dynamicFieldValue": "sensible,no"
      },
      {
         "dynamicFieldCode": "New_DYN_004",
         "dynamicFieldLabel": "New_DYN_004",
         "dynamicFieldValue": "laughter,laughter,laughter,laughter,laughter"
      }
   ],
   "requestId": "101738",
   "sourceSystemId": "OMSJaggedPeakMerchant",
   "destinationSystemId": "WMSTestProvider",
   "messageName": "CatalogAddEdit"
}
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CatalogAddEditRequest>
	<RequestId>101738</RequestId>
	<SourceSystemId>OMSJaggedPeakMerchant</SourceSystemId>
	<DestinationSystemId>WMSTestProvider</DestinationSystemId>
	<MessageName>CatalogAddEdit</MessageName>
	<StatusCode>active</StatusCode>
	<CatalogTypeCode>standard</CatalogTypeCode>
	<CatalogCode>Avengers0</CatalogCode>
	<CatalogItem>Avengers0</CatalogItem>
	<CatalogName>Avengers0</CatalogName>
	<CatalogNotes>test note by Max</CatalogNotes>
	<RetailPrice>38.0000</RetailPrice>
	<ShortDescription>Short description for Avengers0 furniture</ShortDescription>
	<LongDescription>Long description Avengers0 furniture</LongDescription>
	<CustodianUsername>defaultAdmin</CustodianUsername>
	<DefaultDeliveryMethodCode>email</DefaultDeliveryMethodCode>
	<SalesAccount/>
	<SortOrder/>
	<IsElectronic>false</IsElectronic>
	<IsDownloadable>false</IsDownloadable>
	<IsTaxable>true</IsTaxable>
	<IsAllowAutoship>true</IsAllowAutoship>
	<IsChargeShipping>true</IsChargeShipping>
	<IsTaxResellers>true</IsTaxResellers>
	<IsBudgetItem>false</IsBudgetItem>
	<IsSearchable>true</IsSearchable>
	<StartDate>2016-01-23</StartDate>
	<CatalogTaxClassCode>Shipping01</CatalogTaxClassCode>
	<Skus>New_SKU_Item4</Skus>
	<Skus>PaymentSku_25</Skus>
	<Skus>UsageSKU</Skus>
	<Skus>Abyss108</Skus>
	<Skus>DBTO</Skus>
	<Skus>blacknight1,068</Skus>
	<Skus>Blacknight_BTS_KIT_304</Skus>
	<Skus>Abyss101Abyss101</Skus>
	<Skus>Blacknight_BTO_KIT_304</Skus>
	<Skus>BTOAugustCom3</Skus>
	<Skus>123</Skus>
	<Skus>BTS_Usage</Skus>
	<ProjectCodes>branchna</ProjectCodes>
	<CategoryCodes>STD_BTO</CategoryCodes>
	<DeliveryMethodCodes>ship</DeliveryMethodCodes>
	<PriceLists>
		<StartRange>1</StartRange>
		<ChangeValue>-10.0000</ChangeValue>
		<ChangeCode>PercentChange</ChangeCode>
		<PriceListCode>Test_Pricelist_01</PriceListCode>
		<LocaleCode>en-US</LocaleCode>
	</PriceLists>
	<DynamicFields>
		<DynamicFieldCode>New_DYN_001</DynamicFieldCode>
		<DynamicFieldLabel>New_DYN_001</DynamicFieldLabel>
		<DynamicFieldValue>sensible,no</DynamicFieldValue>
	</DynamicFields>
	<DynamicFields>
		<DynamicFieldCode>New_DYN_004</DynamicFieldCode>
		<DynamicFieldLabel>New_DYN_004</DynamicFieldLabel>
		<DynamicFieldValue>laughter,laughter,laughter,laughter,laughter</DynamicFieldValue>
	</DynamicFields>
</CatalogAddEditRequest>

Response

ParametersNameTypeDescription
resultCodeStringOK or FAIL
resultMessageStringError description if an request failed
Example
Success
{  
   "resultCode":"OK",
   "resultMessage":""
}
Failure
{  
   "resultCode":"FAIL",
   "resultMessage":"Error message here."
}



  • No labels