Skip to content

Schema Field Comparison Report

This report compares properties across similar schemas to identify missing fields.

Schemas Compared

  1. schema/Api/OfferBroker/CreateOfferRequest.json
  2. schema/Api/OfferBroker/GetOfferResponse.json
  3. schema/Api/OfferBroker/UpdateOfferRequest.json

Summary

Schema Total Properties Missing Fields
CreateOfferRequest 61 17
GetOfferResponse 76 2
UpdateOfferRequest 68 10

Property Comparison Matrix

Property CreateOfferRequest GetOfferResponse UpdateOfferRequest
accessGroups ✓ ✓ ✓
additionalPropsRequiredOnOrder ✓ ✓ ✓
additionalPropsRequiredOnOrder[].hint ✓ ✓ ✓
additionalPropsRequiredOnOrder[].label ✓ ✓ ✓
additionalPropsRequiredOnOrder[].name ✓ ✓ ✓
additionalPropsRequiredOnOrder[].type ✓ ✓ ✓
additionalPropsRequiredOnOrder[].value ✓ ✓ ✓
availableEndDate ✓ ✓ ✓
availableStartDate ✓ ✓ ✓
categories ✗ ✓ ✓
categories[].categoryKey ✗ ✓ ✓
categories[].name ✗ ✓ ✓
categoryIds ✓ ✓ ✓
comments ✓ ✓ ✓
defaultPrice ✓ ✓ ✓
deliveryScheduleCron ✓ ✓ ✓
description ✓ ✓ ✓
doSuppressShippingAndHandling ✓ ✓ ✓
fixedOrderQuantities ✓ ✓ ✓
fullImageUrl ✓ ✓ ✓
id ✗ ✓ ✗
integrationBrokerLastUpdatedDateTimeUtc ✗ ✓ ✓
isActive ✓ ✓ ✓
isAvailableViaCoopFunds ✓ ✓ ✓
isDeleted ✗ ✓ ✓
isInventoried ✓ ✓ ✓
isTaxable ✓ ✓ ✓
lastUpdatedDateTimeUTC ✗ ✓ ✗
lastUpdatedDateTimeUtc ✓ ✗ ✓
number ✓ ✓ ✓
offerId ✗ ✗ ✓
offerType ✓ ✓ ✓
omniChannel ✓ ✓ ✓
omniChannel.offers ✓ ✓ ✓
omniChannel.offers[].deliveryChannel ✓ ✓ ✓
omniChannel.offers[].offerId ✓ ✓ ✓
omsIdentifier ✗ ✓ ✓
omsOfferId ✓ ✓ ✓
omsRootSystemName ✗ ✓ ✓
onlyShipMethodsAvailable ✓ ✓ ✓
orderMaximum ✓ ✓ ✓
orderMinimum ✓ ✓ ✓
pdfUrl ✓ ✓ ✓
priceClasses ✓ ✓ ✓
priceClasses[].name ✓ ✓ ✓
priceClasses[].price ✓ ✓ ✓
priceClasses[].priceTiers ✓ ✓ ✓
priceClasses[].priceTiers[].maximumQuantity ✓ ✓ ✓
priceClasses[].priceTiers[].minimumQuantity ✓ ✓ ✓
priceClasses[].priceTiers[].pageCounts ✓ ✓ ✓
priceClasses[].priceTiers[].pageCounts[].maximumPages ✓ ✓ ✓
priceClasses[].priceTiers[].pageCounts[].minimumPages ✓ ✓ ✓
priceClasses[].priceTiers[].pageCounts[].price ✓ ✓ ✓
priceClasses[].priceTiers[].price ✓ ✓ ✓
productClusters ✓ ✓ ✓
productClusters[].id ✓ ✓ ✓
productClusters[].products ✓ ✓ ✓
productClusters[].products[].associatedFileName ✓ ✓ ✗
productClusters[].products[].buildType ✗ ✓ ✗
productClusters[].products[].omsProductId ✗ ✓ ✗
productClusters[].products[].pageCount ✓ ✓ ✓
productClusters[].products[].productColor ✗ ✓ ✗
productClusters[].products[].productDescription ✗ ✓ ✗
productClusters[].products[].productId ✓ ✓ ✓
productClusters[].products[].productNumber ✗ ✓ ✗
productClusters[].products[].productQuantityInOffer ✓ ✓ ✓
productClusters[].products[].productSize ✗ ✓ ✗
productClusters[].products[].surcharge ✓ ✓ ✗
requiresApproval ✓ ✓ ✓
schemaVersion ✗ ✓ ✓
secureEmailBody ✓ ✓ ✓
secureEmailSubject ✓ ✓ ✓
surcharge ✓ ✓ ✓
thumbnailUrl ✓ ✓ ✓
unitOfMeasure ✓ ✓ ✓
weightInPounds ✓ ✓ ✓
xmPieTemplateId ✓ ✓ ✓
xmPieUStoreId ✓ ✓ ✓

Missing Fields by Schema

CreateOfferRequest

Missing 17 field(s):

  • categories
  • categories[].categoryKey
  • categories[].name
  • id
  • integrationBrokerLastUpdatedDateTimeUtc
  • isDeleted
  • lastUpdatedDateTimeUTC
  • offerId
  • omsIdentifier
  • omsRootSystemName
  • productClusters[].products[].buildType
  • productClusters[].products[].omsProductId
  • productClusters[].products[].productColor
  • productClusters[].products[].productDescription
  • productClusters[].products[].productNumber
  • productClusters[].products[].productSize
  • schemaVersion

GetOfferResponse

Missing 2 field(s):

  • lastUpdatedDateTimeUtc
  • offerId

UpdateOfferRequest

Missing 10 field(s):

  • id
  • lastUpdatedDateTimeUTC
  • productClusters[].products[].associatedFileName
  • productClusters[].products[].buildType
  • productClusters[].products[].omsProductId
  • productClusters[].products[].productColor
  • productClusters[].products[].productDescription
  • productClusters[].products[].productNumber
  • productClusters[].products[].productSize
  • productClusters[].products[].surcharge