Get the discount collection
/api/v1/discounts/collection
{basePath}/discounts/collection?orgShortName=tfoinc&locRef=fdmnh144&rvcRef=42
The discount collection is a list of discounts that can be used when interacting with the checks endpoint. The API returns a collection of discounts that can be used at the specified revenue center.Request
- application/json
-
locRef(required): string
The location identifier.
-
orgShortName(required): string
The organization identifier.
-
rvcRef(required): integer
The revenue center identifier.
-
If-Modified-Since: string
Standard http caching header (http caching link).
-
If-None-Match: string
Standard http caching header (http caching link).
Response
- application/json
200 Response
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
-
Last-Modified: string
A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2
object-
items:
array items
-
OrgLocRvcProperties:
object OrgLocRvcProperties
A collection of properties for orgShortName, locRef and rvcRef
array-
Array of:
object DiscountItem
Definition of a discount that can be applied to a transaction.
object-
locRef(required):
string
Location identifierExample:
store66 -
orgShortName(required):
string
Organization identifierExample:
mymeal -
rvcRef(required):
integer
Revenue Center identifierExample:
2
object-
consumerDescription:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages.
-
consumerName:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages.
-
discountId(required):
integer
Discount identifierExample:
13 -
extensions:
object ExtensionData
Additional Properties Allowed: additionalPropertiesContainer for extension data
-
images:
array images
Array of images.
-
name:
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages.
-
restiction:
object restriction
A collection of discount restrictions for order types and order channels
-
type(required):
string
Allowed Values:
[ "amount", "percentage" ]Discount typeExample:amount -
value:
number
The amount or percentage of the discount. If value is not present or is zero, then the value must be provided when the discount is added to a check.Example:
5
object{
"en-GB":"Special Delivery",
"de-DE":"Sonderlieferung",
"es-ES":"Entrega especial",
"sk-SK":"Špeciálna zásielka"
}objectarray-
Array of:
object ImageLink
Represents a link to an image
object-
orderChannelRefs:
number
A collection of order channel references.
-
orderTypeRefs:
number
A collection of order type references.
objectobject-
altText:
string
Alt text for the imageExample:
Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top. -
comments:
string
Comments for the image
-
index:
string
Unique identifier for the image
-
isCloudImage:
boolean
-
size:
string
Image size
-
url(required):
string
URL for the image.Example:
https://oracleObjectStore.com/images/coffee822815.jpg
304 Response
400 Response
object-
details:
string
A human-readable explanation specific to this occurrence of the problem.Example:
The OrgShortName value is required. -
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.Example:
required_value_missing -
title:
string
A short, human-readable summary of the problem type.Example:
Required value not specified. -
type:
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
error:validation
{
"type":"error:validation",
"title":"Required value not specified.",
"details":"The OrgShortName value is required.",
"instance":"required_value_missing"
}401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.
Examples
Example Request Body
Not applicable for this endpoint.
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"orgShortName": "mymeal",
"locRef": "store66",
"rvcRef": 2,
"items": [
{
"discountId": 13,
"name": {
"en-US": "Coffee",
"de-DE": "Kaffee",
"ar-AR": "قهوة"
},
"type": "amount",
"value": 5,
"consumerName": {
"en-US": "Coffee",
"de-DE": "Kaffee",
"ar-AR": "قهوة"
},
"consumerDescription": {
"en-US": "Coffee",
"de-DE": "Kaffee",
"ar-AR": "قهوة"
},
"images": [
{
"index": "string",
"url": "https://oracleObjectStore.com/images/coffee822815.jpg",
"altText": "Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top.",
"description": "string",
"isCloudImage": true,
"size": "string"
}
],
"extensions": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"restriction": {
"orderTypeRefs": [
0
],
"orderChannelRefs": [
0
]
}
}
]
}