Create or update a price tag
put
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/{id}
Creates or updates the price tag with the specified ID.
Request
Path Parameters
-
id(required): string
The ID of the resource item.
Supported Media Types
- application/json
Root Schema : PriceTagOracle
Type:
objectTitle:
PriceTagOracleThe price tag resource.
Show Source
-
@baseType: string
The base type of the price tag.
-
@schemaLocation: string
The URI of the schema that defines the price tag.
-
@type(required): string
The class type of the price tag.
-
created: string
(date-time)
The date and time of the priceTag creation.
-
createdBy: string
The name of the person who created the priceTag.
-
description: string
The description of priceTag.
-
href: string
The hyperlink reference to the price tag.
-
id: string
Maximum Length:
30The ID of the price tag. -
lastUpdate: string
(date-time)
The date and time when the price tag was last updated.
-
lastUpdatedBy: string
The name of the person who updated the priceTag.
-
lifecycleStatus: string
The status of the price tag.
-
name(required): string
The name of the price tag.
-
priceTagRules: array
priceTagRules
A list of price tag rules associated with the price tag.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The price tag version.
-
versionState: number
The version state of the priceTag.
Nested Schema : priceTagRules
Type:
arrayA list of price tag rules associated with the price tag.
Show Source
-
Array of:
object PriceTagRuleOracle
Title:
PriceTagRuleOracleThe price tag rule resource.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe project reference resource.
Show Source
-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
Nested Schema : TimePeriod
Type:
objectTitle:
TimePeriodThe period for which the productOffering is valid.
Show Source
-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
Nested Schema : PriceTagRuleOracle
Type:
objectTitle:
PriceTagRuleOracleThe price tag rule resource.
Show Source
-
balanceElement: object
BalanceElementRef
Title:
BalanceElementRefThe balance element ref in price. -
balanceElementCode: string
Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency.
-
id(required): string
Maximum Length:
30The ID of the price tag rule. -
productType: string
Allowed Values:
[ "ALL", "ACCOUNT", "SERVICE" ]The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE. -
serviceSpecification: array
serviceSpecification
A list of service specifications associated with the price tag rule.
-
unitOfMeasure: string
The unit of measure for which the priceTag rule applies to.
-
value: string
Value corresponding to the selected valueType in semicolon selected format.
-
valueType: string
Allowed Values:
[ "ALL", "LIST", "RANGE" ]The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.
Nested Schema : BalanceElementRef
Type:
objectTitle:
BalanceElementRefThe balance element ref in price.
Show Source
-
@baseType: string
The base type of the balance element reference.
-
@referredType(required): string
The type of the referred balance element reference.
-
@schemaLocation: string
The URI of the schema that defines the balance element reference.
-
@type(required): string
The class type of the balance element reference.
-
href: string
The hyperlink reference to the balance element reference.
-
id(required): string
The ID of the balance element reference.
-
name: string
The name of the balance element reference.
-
version: string
The version of the balance element.
-
versionState: number
The version state of the reference.
Nested Schema : serviceSpecification
Type:
arrayA list of service specifications associated with the price tag rule.
Show Source
-
Array of:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
Nested Schema : ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracleMatch All
Show Source
-
object
ServiceSpecificationRef
Title:
ServiceSpecificationRefDiscriminator:{ "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification. -
object
ServiceSpecificationRefOracle-allOf[1]
Nested Schema : ServiceSpecificationRef
Type:
objectTitle:
ServiceSpecificationRefDiscriminator: @type
Discriminator Values
The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
-
@baseType: string
The base type of the service specification reference.
-
@referredType(required): string
The type of the referred service specification reference.
-
@schemaLocation: string
The URI of the schema that defines the service specification reference.
-
@type(required): string
The class type of the service specification reference.
-
href: string
The hyperlink reference to the service specification reference.
-
id(required): string
The ID of the service specification reference.
-
name: string
The name of the service specification reference.
-
targetServiceSchema: object
TargetServiceSchema
Title:
TargetServiceSchemaThe reference object to the schema and type of target product which is described by product specification. -
version: string
The service specification version.
-
versionState: number
The version state of the reference.
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
isApplicableToChildServices: boolean
Whether the service specification reference is applicable to child services.
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]The service specification role. Valid values are PRIMARY, and AUXILIARY. -
serviceCode: string
The service code associated with the service specification reference.
Response
Supported Media Types
- application/json
200 Response
The price tag was created or updated successfully.
Root Schema : PriceTagOracle
Type:
objectTitle:
PriceTagOracleThe price tag resource.
Show Source
-
@baseType: string
The base type of the price tag.
-
@schemaLocation: string
The URI of the schema that defines the price tag.
-
@type(required): string
The class type of the price tag.
-
created: string
(date-time)
The date and time of the priceTag creation.
-
createdBy: string
The name of the person who created the priceTag.
-
description: string
The description of priceTag.
-
href: string
The hyperlink reference to the price tag.
-
id: string
Maximum Length:
30The ID of the price tag. -
lastUpdate: string
(date-time)
The date and time when the price tag was last updated.
-
lastUpdatedBy: string
The name of the person who updated the priceTag.
-
lifecycleStatus: string
The status of the price tag.
-
name(required): string
The name of the price tag.
-
priceTagRules: array
priceTagRules
A list of price tag rules associated with the price tag.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The price tag version.
-
versionState: number
The version state of the priceTag.
Nested Schema : priceTagRules
Type:
arrayA list of price tag rules associated with the price tag.
Show Source
-
Array of:
object PriceTagRuleOracle
Title:
PriceTagRuleOracleThe price tag rule resource.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe project reference resource.
Show Source
-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
Nested Schema : TimePeriod
Type:
objectTitle:
TimePeriodThe period for which the productOffering is valid.
Show Source
-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
Nested Schema : PriceTagRuleOracle
Type:
objectTitle:
PriceTagRuleOracleThe price tag rule resource.
Show Source
-
balanceElement: object
BalanceElementRef
Title:
BalanceElementRefThe balance element ref in price. -
balanceElementCode: string
Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency.
-
id(required): string
Maximum Length:
30The ID of the price tag rule. -
productType: string
Allowed Values:
[ "ALL", "ACCOUNT", "SERVICE" ]The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE. -
serviceSpecification: array
serviceSpecification
A list of service specifications associated with the price tag rule.
-
unitOfMeasure: string
The unit of measure for which the priceTag rule applies to.
-
value: string
Value corresponding to the selected valueType in semicolon selected format.
-
valueType: string
Allowed Values:
[ "ALL", "LIST", "RANGE" ]The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.
Nested Schema : BalanceElementRef
Type:
objectTitle:
BalanceElementRefThe balance element ref in price.
Show Source
-
@baseType: string
The base type of the balance element reference.
-
@referredType(required): string
The type of the referred balance element reference.
-
@schemaLocation: string
The URI of the schema that defines the balance element reference.
-
@type(required): string
The class type of the balance element reference.
-
href: string
The hyperlink reference to the balance element reference.
-
id(required): string
The ID of the balance element reference.
-
name: string
The name of the balance element reference.
-
version: string
The version of the balance element.
-
versionState: number
The version state of the reference.
Nested Schema : serviceSpecification
Type:
arrayA list of service specifications associated with the price tag rule.
Show Source
-
Array of:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
Nested Schema : ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracleMatch All
Show Source
-
object
ServiceSpecificationRef
Title:
ServiceSpecificationRefDiscriminator:{ "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification. -
object
ServiceSpecificationRefOracle-allOf[1]
Nested Schema : ServiceSpecificationRef
Type:
objectTitle:
ServiceSpecificationRefDiscriminator: @type
Discriminator Values
The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
-
@baseType: string
The base type of the service specification reference.
-
@referredType(required): string
The type of the referred service specification reference.
-
@schemaLocation: string
The URI of the schema that defines the service specification reference.
-
@type(required): string
The class type of the service specification reference.
-
href: string
The hyperlink reference to the service specification reference.
-
id(required): string
The ID of the service specification reference.
-
name: string
The name of the service specification reference.
-
targetServiceSchema: object
TargetServiceSchema
Title:
TargetServiceSchemaThe reference object to the schema and type of target product which is described by product specification. -
version: string
The service specification version.
-
versionState: number
The version state of the reference.
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
isApplicableToChildServices: boolean
Whether the service specification reference is applicable to child services.
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]The service specification role. Valid values are PRIMARY, and AUXILIARY. -
serviceCode: string
The service code associated with the service specification reference.
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to create or update a price tag by submitting a PUT request on the REST resource using cURL.
cURL Command
curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/{id}Example of Request Body
The following shows the contents of the request body in JSON format.
{
"id": "PDC-PRICETAG",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PDC-PRICETAG",
"name": "PDC-PRICETAG",
"lifecycleStatus": "In design",
"version": "1.0",
"@type": "PriceTagOracle",
"project": {
"id": "P-3454289648-1759125844206",
"name": "PDC-INITIATIVE",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-3454289648-1759125844206",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"priceTagRules": [
{
"id": "PT-RULE-01",
"unitOfMeasure": "MINUTE",
"productType": "SERVICE",
"serviceSpecification": [
{
"id": "SS-1193122351-1759125892052",
"name": "PDC-SERVICE-SPEC",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-1193122351-1759125892052",
"version": "1.0",
"@referredType": "ServiceSpecificationOracle",
"@type": "ServiceSpecificationRef"
}
],
"valueType": "LIST",
"balanceElementCode": "USD",
"value": "10;20",
"balanceElement": {
"id": "USDCurrency",
"name": "USD Currency",
"@referredType": "BalanceElementOracle",
"@type": "BalanceElementRef",
"version": "1.0"
}
},
{
"id": "PT-RULE-02",
"unitOfMeasure": "ALL",
"productType": "ALL",
"valueType": "LIST",
"balanceElementCode": "ALL"
}
]
}Example of Response Body
The following shows the contents of the response body in JSON format.
{
"id": "PDC-PRICETAG",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PDC-PRICETAG",
"name": "PDC-PRICETAG",
"lastUpdate": "2025-10-24T08:01:10.009Z",
"lifecycleStatus": "In design",
"version": "1.0",
"@type": "PriceTagOracle",
"project": {
"id": "P-3454289648-1759125844206",
"name": "PDC-INITIATIVE",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-3454289648-1759125844206",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"priceTagRules": [
{
"id": "PT-RULE-01",
"unitOfMeasure": "MINUTE",
"productType": "SERVICE",
"serviceSpecification": [
{
"id": "SS-1193122351-1759125892052",
"name": "PDC-SERVICE-SPEC",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-1193122351-1759125892052",
"version": "1.0",
"@referredType": "ServiceSpecificationOracle",
"@type": "ServiceSpecificationRef"
}
],
"valueType": "LIST",
"balanceElementCode": "USD",
"value": "10;20"
},
{
"id": "PT-RULE-02",
"unitOfMeasure": "ALL",
"productType": "ALL",
"valueType": "LIST",
"balanceElementCode": "ALL"
}
],
"lastUpdatedBy": "booth",
"created": "2025-10-09T08:22:39.000Z",
"createdBy": "booth"
}