1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Price Tags

Update a price tag

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : PriceTagOracle
Type: object
Title: PriceTagOracle
Show Source
Nested Schema : priceTagRules
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : PriceTagRuleOracle
Type: object
Title: PriceTagRuleOracle
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
Balance element ref in price
Show Source
Nested Schema : serviceSpecification
Type: array
Show Source
Nested Schema : ServiceSpecificationReferenceOracle
Title: ServiceSpecificationReferenceOracle
Match All
Show Source
Nested Schema : ServiceSpecificationRefOracle
Title: ServiceSpecificationRefOracle
Match All
Show Source
  • ServiceSpecificationRef
    Title: ServiceSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }
    Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : ServiceSpecificationRef
Type: object
Title: ServiceSpecificationRef
Discriminator: @type

Discriminator Values

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : ServiceSpecificationReferenceOracle-allOf[1]
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : PriceTagOracle
Type: object
Title: PriceTagOracle
Show Source
Nested Schema : priceTagRules
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : PriceTagRuleOracle
Type: object
Title: PriceTagRuleOracle
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
Balance element ref in price
Show Source
Nested Schema : serviceSpecification
Type: array
Show Source
Nested Schema : ServiceSpecificationReferenceOracle
Title: ServiceSpecificationReferenceOracle
Match All
Show Source
Nested Schema : ServiceSpecificationRefOracle
Title: ServiceSpecificationRefOracle
Match All
Show Source
  • ServiceSpecificationRef
    Title: ServiceSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }
    Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : ServiceSpecificationRef
Type: object
Title: ServiceSpecificationRef
Discriminator: @type

Discriminator Values

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : ServiceSpecificationReferenceOracle-allOf[1]
Type: object
Show Source

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.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to update a price tag by submitting a patch request on the REST resource using cURL.

cURL Command

curl -u username:password -X PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/{id} -H 'Content-Type: application/json' -D @update_pricetag.json | json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "id": "PriceTagConfigZoneTest",
    "name": "PriceTagConfigZoneTest",
    "description": "PriceTagConfigZone test description",
    "lastUpdate": "2024-09-24T22:27:11.049Z",
    "lifecycleStatus": "In design",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z"
    },
    "version": "1.0",
    "@type": "PriceTagOracle",
    "priceTagRules": [
        {
            "id": "PriceTagConfigids1",
            "unitOfMeasure": "ALL",
            "productType": "ALL",
            "valueType": "LIST",
            "balanceElementCode": "ALL",
            "value": "10;20"
        }
    ],
    "lastUpdatedBy": "booth",
    "created": "2024-07-26T22:18:07.000Z",
    "createdBy": "booth",
    "versionState": 0
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "id": "PriceTagConfigZoneTest",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PriceTagConfigZoneTest",
    "name": "PriceTagConfigZoneTest",
    "description": "PriceTagConfigZone test description",
    "lastUpdate": "2024-09-26T07:25:39.006Z",
    "lifecycleStatus": "In design",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z"
    },
    "version": "1.0",
    "@type": "PriceTagOracle",
    "priceTagRules": [
        {
            "id": "PriceTagConfigids1",
            "unitOfMeasure": "ALL",
            "productType": "ALL",
            "valueType": "LIST",
            "balanceElementCode": "ALL",
            "value": "10;20"
        }
    ],
    "lastUpdatedBy": "booth",
    "created": "2024-09-26T07:23:52.000Z",
    "createdBy": "booth"
}
Back to Top