Get all PriceTags
get
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag
Returns a list of price tags that match the search criteria.
Request
Query Parameters
-
description: string
The description of the resource.
-
eligibleForProject: string
The project ID.
-
fields: string
The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
-
id: string
The unique ID of the resource item.
-
lastUpdate: string
Filters resources by their last update date and time.
-
lifecycleStatus: string
The current lifecycle status of the resource.
-
limit: integer
The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
-
name: string
The name of the resource.
-
offset: string
The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
-
priceTagRules.balanceElementCode: string
The balance element code for filtering price tags.
-
priceTagRules.productType: string
The product type for filtering price tags.
-
priceTagRules.serviceSpecification.id: string
The ID of the price tag rules service specification for filtering resource results.
-
priceTagRules.unitOfMeasure: string
The unit of measure for filtering price tags.
-
project.id: string
The ID of the project for filtering resource results.
-
project.version: string
The project version for filtering entities.
-
validFor.endDateTime: string
The valid for end date time for filtering entities.
-
validFor.startDateTime: string
The valid for start date time for filtering entities.
-
whereUsed: string
Whether to enrich objects with usedBy information.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The list of price tags was returned successfully.
Root Schema : schema
Type:
Show Source
array-
Array of:
object PriceTagOracle
Title:
PriceTagOracleThe price tag resource.
Nested 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 get all price tags by submitting a get request on the REST resource using cURL.
cURL Command
curl -u username:password -X GET
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag
-H 'Content-Type: application/json' | json_pp
Example of Response Body
The following shows an example of the response body in JSON format.
[
{
"id": "PT_0091",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PT_0091",
"name": "Price Tag1",
"lastUpdate": "2025-02-17T13:09:27.124Z",
"lifecycleStatus": "In design",
"version": "1.0",
"@type": "PriceTagOracle",
"description" : "Price Tag 1",
"validFor": {
"startDateTime": "2024-08-09T00:00:00.000Z",
"endDateTime": "2028-08-09T00:00:00.000Z"
}
"project": {
"id": "I0601",
"name": "I0601",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/I0601",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"priceTagRules": [
{
"id": "pt-rule-1",
"unitOfMeasure": "ALL",
"productType": "ALL",
"valueType": "LIST",
"balanceElementCode": "ALL",
"value": "10;20"
}
],
"lastUpdatedBy": "booth",
"created": "2025-02-17T13:09:27.000Z",
"createdBy": "booth",
"versionState": 0
},
{
"id": "PT_0090",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PT_0090",
"name": "Price Tag90",
"lastUpdate": "2025-02-17T13:09:27.124Z",
"lifecycleStatus": "In design",
"version": "1.0",
"@type": "PriceTagOracle",
"description" : "Price Tag 90",
"validFor": {
"startDateTime": "2024-08-09T00:00:00.000Z",
"endDateTime": "2028-08-09T00:00:00.000Z"
}
"project": {
"id": "I0601",
"name": "I0601",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/I0601",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"priceTagRules": [
{
"id": "pt-rule-1",
"unitOfMeasure": "ALL",
"productType": "ALL",
"valueType": "LIST",
"balanceElementCode": "ALL",
"value": "10;20"
}
],
"lastUpdatedBy": "booth",
"created": "2025-02-17T13:09:27.000Z",
"createdBy": "booth",
"versionState": 0
}
]