REST API Reference for Launch Cloud Service

Get all pricelists

get

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

Returns a list of pricelists 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.
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.

Response

Supported Media Types

application/json

200 Response

The list of pricelists was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object PricelistOracle

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PricelistOracle"
    }
}

Nested 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

@baseType: string

The base type of the pricelist.
@schemaLocation: string

The URI of the schema that defines the pricelist.
@type(required): string

The class type of the pricelist.
applicationName: string

The name of the application associated with the pricelist.
balanceElement: object BalanceElementRef

Title: BalanceElementRef

The balance element ref in price.
businessUnitId: number

The ID of the business unit associated with the pricelist.
businessUnitName: string

The name of the business unit associated with the pricelist.
created: string (date-time)

The date and time of the creation.
createdBy: string

The name of the person who created item.
currency: string

The currency (ISO4217 norm uses 3 letters to define the currency).
description: string

The description of the pricelist.
externalId: string

The ID of the external associated with the pricelist.
href: string

The hyperlink reference to the pricelist.
id: string

Maximum Length: 30

The ID of the pricelist.
lastUpdate: string (date-time)

The date and time when the pricelist was last updated.
lastUpdatedBy: string

The name of the person who updated item.
lifecycleStatus: string

The status of the pricelist.
name: string

The name of the pricelist.
pricelistType: string

Allowed Values: [ "RESIDENTIAL", "BUSINESS" ]

The type or classification of the pricelist. Valid values are RESIDENTIAL, and BUSINESS.
productOffering: array productOffering

A list of product offerings associated with the pricelist.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
promotion: array promotion

A list of promotions associated with the pricelist.
relatedParty: array relatedParty

A list of related parties associated with the pricelist.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The promotion version.
versionState: number

The version state of the price list.

{
    "title":"PricelistOracle",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the pricelist."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the pricelist."
        },
        "name":{
            "type":"string",
            "description":"The name of the pricelist."
        },
        "description":{
            "type":"string",
            "description":"The description of the pricelist."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the pricelist was last updated."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the pricelist."
        },
        "pricelistType":{
            "type":"string",
            "description":"The type or classification of the pricelist. Valid values are RESIDENTIAL, and BUSINESS.",
            "enum":[
                "RESIDENTIAL",
                "BUSINESS"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the pricelist is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the pricelist."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the pricelist."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the pricelist."
        },
        "currency":{
            "type":"string",
            "description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The pricelist."
        },
        "version":{
            "type":"string",
            "description":"The promotion version."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A list of related parties associated with the pricelist."
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            },
            "description":"A list of product offerings associated with the pricelist."
        },
        "promotion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PromotionRef"
            },
            "description":"A list of promotions associated with the pricelist."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created item."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated item."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef",
            "description":"The pricelist."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the pricelist."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the pricelist."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the price list."
        },
        "businessUnitId":{
            "type":"number",
            "description":"The ID of the business unit associated with the pricelist."
        },
        "businessUnitName":{
            "type":"string",
            "description":"The name of the business unit associated with the pricelist."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

The 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.

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"The balance element ref in price.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the balance element reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the balance element reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the balance element."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance element reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the balance element reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the balance element reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the balance element reference."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred balance element reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : productOffering

Type: array

A list of product offerings associated with the pricelist.

Show Source

Array of: object ProductOfferingRef

Title: ProductOfferingRef

Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }

The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingRef"
    },
    "description":"A list of product offerings associated with the pricelist."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The 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.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : promotion

Type: array

A list of promotions associated with the pricelist.

Show Source

Array of: object PromotionRef

Title: PromotionRef

The promotion reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PromotionRef"
    },
    "description":"A list of promotions associated with the pricelist."
}

Nested Schema : relatedParty

Type: array

A list of related parties associated with the pricelist.

Show Source

Array of: object RelatedParty

Title: RelatedParty

The relatedParty reference. A related party defines party or party role linked to a specific entity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
    },
    "description":"A list of related parties associated with the pricelist."
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The 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.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : ProductOfferingRef

Type: object

Title: ProductOfferingRef

Discriminator: @type

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the product offering reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the product offering reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the product offering reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the product offering reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the product offering reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the product offering reference."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred product offering reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the product offering."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef",
            "BundledProductOffering":"#/components/schemas/BundledProductOffering",
            "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
            "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
        }
    }
}

The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Show Source

@baseType: string

The base type of the product offering reference.
@referredType(required): string

The type of the referred product offering reference.
@schemaLocation: string

The URI of the schema that defines the product offering reference.
@type(required): string

The class type of the product offering reference.
href: string

The hyperlink reference to the product offering reference.
id(required): string

The ID of the product offering reference.
name: string

The name of the product offering reference.
version: string

The version of the product offering.
versionState: number

The version state of the reference.

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the product offering reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the product offering reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the product offering reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the product offering reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the product offering reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the product offering reference."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred product offering reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the product offering."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef",
            "BundledProductOffering":"#/components/schemas/BundledProductOffering",
            "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
            "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
        }
    }
}

Nested Schema : PromotionRef

Type: object

Title: PromotionRef

The promotion reference.

Show Source

@baseType: string

The base type of the promotion reference.
@referredType(required): string

The type of the referred promotion reference.
@schemaLocation: string

The URI of the schema that defines the promotion reference.
@type(required): string

The class type of the promotion reference.
href: string

The hyperlink reference to the promotion reference.
id(required): string

The ID of the promotion reference.
name: string

The name of the promotion reference.

{
    "title":"PromotionRef",
    "type":"object",
    "description":"The promotion reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the promotion reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the promotion reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the promotion reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the promotion reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the promotion reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the promotion reference."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred promotion reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

The relatedParty reference. A related party defines party or party role linked to a specific entity.

Show Source

@baseType: string

The base type of the related party reference or party role reference.
@schemaLocation: string

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type(required): string

The class type of the related party reference or party role reference.
partyOrPartyRole(required): partyOrPartyRole

A list of party or party roles associated with the related party reference or party role reference.
role: string

The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.

{
    "title":"RelatedParty",
    "description":"The relatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the related party reference or party role reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the related party reference or party role reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "partyOrPartyRole":{
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/PartyRef"
                    },
                    {
                        "$ref":"#/components/schemas/PartyRoleRef"
                    }
                ]
            },
            "description":"A list of party or party roles associated with the related party reference or party role reference."
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

A list of party or party roles associated with the related party reference or party role reference.

Show Source

Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    },
    "description":"A list of party or party roles associated with the related party reference or party role 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: object

Title: Error

The 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.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

The 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.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The 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.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

The 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.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

The 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.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to get all pricelists 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 \ -H 'Content-Type: application/json'

Example of Response Body

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

[
{
    "lastUpdate": "2025-02-17T12:34:59.052Z",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T12:34:59.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "id": "DBE_NA_PL1",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/DBE_NA_PL1",
    "name": "DBE NA Pricelist1",
    "description": "DBE NA Pricelist",
    "@type": "PricelistOracle",
    "version": "1.0",
    "validFor": {
        "startDateTime": "2024-07-22T00:00:00.000Z"
    },
    "project": {
        "id": "DBE_RI_ProdModel_PreSeed_PSP",
        "name": "DBE RI Product Model Preseed",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "lifecycleStatus": "In design",
    "currency": "USD",
    "pricelistType": "BUSINESS"
},
{
    "lastUpdate": "2025-02-17T12:34:59.052Z",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T12:34:59.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "id": "DBE_CENT_PL1",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/DBE_CENT_PL1",
    "name": "DBE Central Pricelist1",
    "description": "DBE Central Pricelist",
    "@type": "PricelistOracle",
    "version": "1.0",
    "validFor": {
        "startDateTime": "2024-07-22T00:00:00.000Z"
    },
    "project": {
        "id": "DBE_RI_ProdModel_PreSeed_PSP",
        "name": "DBE RI Product Model Preseed",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "lifecycleStatus": "In design",
    "currency": "USD",
    "pricelistType": "BUSINESS"
}
]