REST API for Oracle Commerce Cloud 22A

getPriceListGroup

get

/ccagent/v1/priceListGroups/{id}

Get Price List Group. Get a single PriceListGroup item

Request

Supported Media Types

application/json

Path Parameters

id: string

The ID of the requested PriceListGroup.

Header Parameters

X-CCAsset-Language: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getPriceListGroup_response

Type: object

Show Source

active(optional): boolean

indicates if the PriceListGroup is active
ancestorPriceListGroups(optional): array ancestorPriceListGroups

Array of ancestor price list group ids (if any) for this price list group.
basePriceListGroup(optional): object basePriceListGroup

The base price list group of this price list group.
currency(optional): object currency

The currency data.
deleted(optional): boolean

indicates if the PriceListGroup is deleted
displayName(optional): string

display name of the PriceListGroup
endDate(optional): string

End date of the the associated list price list
id(optional): string

The ID of the PriceListGroup item
includeAllProducts(optional): boolean

If true, and active flag is also set to true then list price is mandatory for all products.
isPointsBased(optional): boolean

If true, indicates the PriceListGroup was created with a point based currency
isTaxIncluded(optional): boolean

Indicates whether prices are inclusive of tax
listPriceList(optional): object listPriceList

The price list for list prices
locale(optional): string

locale of the the associated list price list
repositoryId(optional): string

The ID of the PriceListGroup item
salePriceList(optional): object salePriceList

The price list for sale prices
shippingSurchargePriceList(optional): object shippingSurchargePriceList

The price list for shipping surcharge prices
startDate(optional): string

Start date of the the associated list price list
taxCalculationType(optional): string

Indicates how tax calls are made based on the PriceListGroup setting. For a monetary PriceListGroup, the possible values are calculateTax and doNotCalculateTax. For a point based PriceListGroup, the possible values are doNotCalculateTax, calculateTaxWithCurrencyConversion and calculateTaxWithoutCurrencyConversion.

{
    "properties":{
        "isTaxIncluded":{
            "description":"Indicates whether prices are inclusive of tax",
            "type":"boolean"
        },
        "endDate":{
            "description":"End date of the the associated list price list",
            "type":"string"
        },
        "displayName":{
            "description":"display name of the PriceListGroup",
            "type":"string"
        },
        "listPriceList":{
            "description":"The price list for list prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID",
                    "type":"string"
                }
            }
        },
        "active":{
            "description":"indicates if the PriceListGroup is active",
            "type":"boolean"
        },
        "isPointsBased":{
            "description":"If true, indicates the PriceListGroup was created with a point based currency",
            "type":"boolean"
        },
        "basePriceListGroup":{
            "description":"The base price list group of this price list group.",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"Name of the base price list group.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository ID of the base price list group.",
                    "type":"string"
                }
            }
        },
        "locale":{
            "description":"locale of the the associated list price list",
            "type":"string"
        },
        "shippingSurchargePriceList":{
            "description":"The price list for shipping surcharge prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID",
                    "type":"string"
                }
            }
        },
        "deleted":{
            "description":"indicates if the PriceListGroup is deleted",
            "type":"boolean"
        },
        "taxCalculationType":{
            "description":"Indicates how tax calls are made based on the PriceListGroup setting. For a monetary PriceListGroup, the possible values are calculateTax and doNotCalculateTax.\n\r\n\rFor a point based PriceListGroup, the possible values are doNotCalculateTax, calculateTaxWithCurrencyConversion and calculateTaxWithoutCurrencyConversion.",
            "type":"string"
        },
        "ancestorPriceListGroups":{
            "description":"Array of ancestor price list group ids (if any) for this price list group.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "repositoryId":{
            "description":"The ID of the PriceListGroup item",
            "type":"string"
        },
        "currency":{
            "description":"The currency data.",
            "type":"object",
            "properties":{
                "symbol":{
                    "description":"The symbol of the currency",
                    "type":"string"
                },
                "displayName":{
                    "description":"The display Name of the currency",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The repository Id of the currency",
                    "type":"string"
                },
                "fractionalDigits":{
                    "description":"The currency Code of the currency",
                    "type":"string"
                },
                "currencyCode":{
                    "description":"The currency Code of the currency",
                    "type":"string"
                },
                "numericCode":{
                    "description":"The numeric Code of the currency",
                    "type":"string"
                }
            }
        },
        "salePriceList":{
            "description":"The price list for sale prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID",
                    "type":"string"
                }
            }
        },
        "id":{
            "description":"The ID of the PriceListGroup item",
            "type":"string"
        },
        "includeAllProducts":{
            "description":"If true, and active flag is also set to true then list price is mandatory for all products.",
            "type":"boolean"
        },
        "startDate":{
            "description":"Start date of the the associated list price list",
            "type":"string"
        }
    }
}

Nested Schema : ancestorPriceListGroups

Type: array

Array of ancestor price list group ids (if any) for this price list group.

Show Source

Array of: string

{
    "description":"Array of ancestor price list group ids (if any) for this price list group.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : basePriceListGroup

Type: object

The base price list group of this price list group.

Show Source

displayName(optional): string

Name of the base price list group.
id(optional): string

Repository ID of the base price list group.

{
    "description":"The base price list group of this price list group.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Name of the base price list group.",
            "type":"string"
        },
        "id":{
            "description":"Repository ID of the base price list group.",
            "type":"string"
        }
    }
}

Nested Schema : currency

Type: object

The currency data.

Show Source

currencyCode(optional): string

The currency Code of the currency
displayName(optional): string

The display Name of the currency
fractionalDigits(optional): string

The currency Code of the currency
numericCode(optional): string

The numeric Code of the currency
repositoryId(optional): string

The repository Id of the currency
symbol(optional): string

The symbol of the currency

{
    "description":"The currency data.",
    "type":"object",
    "properties":{
        "symbol":{
            "description":"The symbol of the currency",
            "type":"string"
        },
        "displayName":{
            "description":"The display Name of the currency",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository Id of the currency",
            "type":"string"
        },
        "fractionalDigits":{
            "description":"The currency Code of the currency",
            "type":"string"
        },
        "currencyCode":{
            "description":"The currency Code of the currency",
            "type":"string"
        },
        "numericCode":{
            "description":"The numeric Code of the currency",
            "type":"string"
        }
    }
}

Nested Schema : listPriceList

Type: object

The price list for list prices

Show Source

repositoryId(optional): string

Repository ID

{
    "description":"The price list for list prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID",
            "type":"string"
        }
    }
}

Nested Schema : salePriceList

Type: object

The price list for sale prices

Show Source

repositoryId(optional): string

Repository ID

{
    "description":"The price list for sale prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID",
            "type":"string"
        }
    }
}

Nested Schema : shippingSurchargePriceList

Type: object

The price list for shipping surcharge prices

Show Source

repositoryId(optional): string

Repository ID

{
    "description":"The price list for shipping surcharge prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "isTaxIncluded":false,
    "endDate":"2016-03-11T18:30:00.000Z",
    "displayName":"UsDollar",
    "listPriceList":{
        "repositoryId":"listPrices"
    },
    "active":false,
    "isPointsBased":false,
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"shippingSurchargePrices"
    },
    "taxCalculationType":"calculateTax",
    "repositoryId":"UsDollar",
    "salePriceList":{
        "repositoryId":"salePrices"
    },
    "currency":{
        "symbol":"$",
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "id":"UsDollar",
    "includeAllProducts":true,
    "startDate":"2016-03-10T18:30:00.000Z"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |20187|No PriceListGroup found for the id : invalidId|

Root Schema : errorModel

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
errors(optional): array errors

An optional list of errors if multiple errors were encountered
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code
type(optional): string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}