The Class ProductOfferingDto.
| name | data type | constraints | description |
|---|---|---|---|
| disabled | boolean | Is entity disabled. Value is ignored in Update action - use enable/disable API instead. | |
| id | number | The id. | |
| auditableField | array of AuditableFieldDto | ||
| code | string | required | The code |
| description | string | The description | |
| updatedCode | string | The updated code. | |
| validFrom | number | The valid from. | |
| validTo | number | The valid to. | |
| newValidFrom | number | The new valid from. | |
| newValidTo | number | The new valid to. | |
| name | string | The name. | |
| offerTemplateCategory | array of OfferTemplateCategoryDto | The offer template categories. | |
| channel | array of ChannelDto | The channels. | |
| digitalResource | array of DigitalResourceDto | The attachments. | |
| modelCode | string | The model code. | |
| lifeCycleStatus | LifeCycleStatusEnum | The life cycle status. | |
| customFields | CustomFieldsDto | The custom fields. | |
| imagePath | string | This field is populated on find and list. Use to pull the image from a servlet later on. | |
| imageBase64 | string | The image base 64. | |
| languageDescriptions | array of LanguageDescriptionDto | The language descriptions. | |
| longDescription | string | The long description. | |
| longDescriptionsTranslated | array of LanguageDescriptionDto | The long descriptions translated. | |
| globalRatingScriptInstance | string | The global rating script instance. | |
| seller | array of string | The sellers. | |
| customerCategory | array of CustomerCategoryDto |
Example
{
"disabled" : true,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"validFrom" : 12345,
"validTo" : 12345,
"newValidFrom" : 12345,
"newValidTo" : 12345,
"name" : "...",
"offerTemplateCategory" : [ {
"disabled" : true,
"name" : "...",
"id" : 12345,
"offerTemplateCategoryCode" : "...",
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"href" : "...",
"code" : "...",
"version" : 12345,
"lastModified" : 12345,
"description" : "...",
"parentId" : 12345,
"updatedCode" : "...",
"imagePath" : "...",
"imageBase64" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"languageLabels" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ]
}, {
"disabled" : true,
"name" : "...",
"id" : 12345,
"offerTemplateCategoryCode" : "...",
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"href" : "...",
"code" : "...",
"version" : 12345,
"lastModified" : 12345,
"description" : "...",
"parentId" : 12345,
"updatedCode" : "...",
"imagePath" : "...",
"imageBase64" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"languageLabels" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ]
} ],
"channel" : [ {
"disabled" : true,
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
}, {
"disabled" : true,
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
} ],
"digitalResource" : [ {
"uri" : "...",
"mimeType" : "...",
"disabled" : true,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
}, {
"uri" : "...",
"mimeType" : "...",
"disabled" : true,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
} ],
"modelCode" : "...",
"lifeCycleStatus" : "IN_TEST",
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "DATE",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "TEXT_AREA",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "DOUBLE",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "LIST",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"imagePath" : "...",
"imageBase64" : "...",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"longDescription" : "...",
"longDescriptionsTranslated" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"globalRatingScriptInstance" : "...",
"seller" : [ "...", "..." ],
"customerCategory" : [ {
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"exoneratedFromTaxes" : true,
"exonerationTaxEl" : "...",
"description" : "...",
"exonerationReason" : "...",
"updatedCode" : "...",
"accountingCode" : "...",
"taxCategoryCode" : "...",
"taxCategoryEl" : "...",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ]
}, {
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"exoneratedFromTaxes" : true,
"exonerationTaxEl" : "...",
"description" : "...",
"exonerationReason" : "...",
"updatedCode" : "...",
"accountingCode" : "...",
"taxCategoryCode" : "...",
"taxCategoryEl" : "...",
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ]
} ]
}