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

Get a pricelist

get

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

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : PricelistOracle
Type: object
Title: PricelistOracle
A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
Balance element ref in price
Show Source
Nested Schema : productOffering
Type: array
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : promotion
Type: array
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : ProductOfferingRef
Type: object
Title: ProductOfferingRef
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Nested Schema : PromotionRef
Type: object
Title: PromotionRef
Promotion reference.
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
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 get a price list 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/pricelist/PriceList2020 \ -H 'Content-Type: application/json'

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "@type": "PricelistOracle",
    "@baseType": "PricelistOracle",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/PriceList2020",
    "lastUpdate": "2021-04-01T09:18:39.000Z",
    "lastUpdatedBy": "booth",
    "createdBy": "booth",
    "businessUnitId": 204,
    "businessUnitName": "Vision Operations",
    "validFor": {
        "startDateTime": "2020-05-02T16:42:23.000Z",
        "endDateTime": "2021-07-14T00:00:00.000Z"
    },
    "relatedParty": [
        {
            "id": "12343",
            "name": "Gustave Flaubert laptop",
            "href": "https://{FusionAppsHost}/tmf-api/partyManagement/v4/partyRole/1234",
            "role": "Owner"
        }
    ],
    "created": "2021-04-01T09:18:39.000Z",
    "lifecycleStatus": "In design",
    "project": {
        "id": "MyProject3000",
        "name": "MyProject3000"
    },
    "description": "TestPrice890 description",
    "currency": "YEN",
    "version": "3.0",
    "name": "PriceList2002",
    "id": "PriceList2020"
}
Back to Top