| Oracle® Retail Pricing Operations Guide Release 21.0.000 F41827-03 |
|
 Previous |
 Next |
This chapter describes ReST services available in Pricing.
This service provides the ability to query the selling price of item/locations for a given date.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PRICING_MANAGER_JOB, PRICING_ANALYST_JOB, PROMOTION_MANAGER_JOB, PROMOTION_PLANNER_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
{
"itemLocations": [
{
"item": null,
"location": null
}, … (Possible list, comma separated for multiple)
],
"date": null,
"pageNumber": null,
"pageSize": null,
"sortOrder": null
}
| Entity | Key | Type | Value |
|---|---|---|---|
| price inquiry | itemLocations | entity list | Item locations for inquiry |
| price inquiry | date | varchar | Date in the format YYYY-MM-DD |
| price inquiry | pageNumber | numeric | Page number to return |
| price inquiry | pageSize | numeric | Total number of results per page |
| price inquiry | sortOrder | varchar | ASC (ascending) or DESC (descending) |
| item location | item | varchar | Item ID (parent, transaction, or reference) |
| item location | location | numeric | Location ID (store or virtual warehouse) |
[
{
"requestedItem": null,
"transactionItem": null,
"location": null,
"date": null,
"onClearance": null,
"sellingPrice": null,
"sellingUom": null,
"currency": null
}
]
| Entity | Key | Type | Value |
|---|---|---|---|
| price | requestedItem | varchar | Item ID (parent, transaction, or reference) |
| price | transactionItem | varchar | Transaction Item ID |
| price | location | numeric | Location ID (store or virtual warehouse) |
| price | date | varchar | Date in the format YYYY-MM-DD |
| price | onClearance | varchar | Y (yes) or N (no) |
| price | sellingPrice | numeric | Decimal selling price |
| price | sellingUom | varchar | Selling unit of measure |
| price | currency | varchar | Location's currency |
This service provides the ability to query the initial retail of an item/location.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PRICING_MANAGER_JOB, PRICING_ANALYST_JOB, PROMOTION_MANAGER_JOB, PROMOTION_PLANNER_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
| Key | Type | Value |
|---|---|---|
| item | varchar | Item ID (transaction or reference) |
| location | numeric | Location ID (store or virtual warehouse) |
[
{
"item": null,
"location": null,
"currentDate": null,
"onClearance": null,
"sellingPrice": null,
"sellingUom": null,
"currency": null
}
]
| Entity | Key | Type | Value |
|---|---|---|---|
| price | item | varchar | Item ID (transaction or reference) |
| price | location | numeric | Location ID (store or virtual warehouse) |
| price | currentDate | varchar | Date in the format YYYY-MM-DD |
| price | onClearance | varchar | Y (yes) or N (no) |
| price | sellingPrice | numeric | Decimal selling price |
| price | sellingUom | varchar | Selling unit of measure |
| price | currency | varchar | Location's currency |
This service provides the ability to create, modify, and delete price changes via the induction process.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
[
{
"action": null,
"newGroupBatch": null,
"priceChangeGroup": null,
"priceChangeGroupDesc": null,
"priceChange": null,
"item": null,
"diff": null,
"locationType": null,
"location": null,
"effectiveDate": null,
"updatedEffectiveDate": null,
"changeType": null,
"changeValue": null,
"sellingUom": null,
"multiUnitImpact": null,
"multiUnitRetail": null,
"multiUnits": null,
"multiUnitSellingUom": null,
"roundingRule": null,
"reason": null,
"status": null,
"ignoreConstraints": null
}, … (Possible list, comma separated for multiple)
]
| Key | Type | Value |
|---|---|---|
| action | varchar | "NEW", "MOD", or "DEL" |
| newGroupBatch | numeric | Transient numeric identifier to group related clearances together in the same clearance group upon creation. |
| priceChangeGroup | numeric | Price change group display ID |
| priceChangeGroupDesc | varchar | Price change group description |
| priceChange | numeric | Price change display ID |
| item | varchar | Item identifier (parent or transaction) |
| diff | varchar | Differentiator ID |
| locationType | numeric | 0: Store, 1: Zone, 2: Warehouse |
| location | numeric | Location ID (either store, warehouse, or zone) |
| effectiveDate | varchar | Effective date in the format YYYY-MM-DD |
| updatedEffectiveDate | varchar | Updated effective date in the format YYYY-MM-DD |
| changeType | numeric | 0: Change by Percent, 1: Change by Amount, 2: Fixed Price, 3: Reset POS Price |
| changeValue | numeric | Decimal change value |
| sellingUom | varchar | Selling unit of measure for Fixed Price change type |
| multiUnitImpact | varchar | AU: Add or Update, R: Remove, N: No Change |
| multiUnitRetail | numeric | Decimal multi unit fixed price change value |
| multiUnits | numeric | Multi unit quantity |
| multiUnitSellingUom | varchar | Selling unit of measure for multi unit price change |
| roundingRule | varchar | Rounding rule ID (technically name column RPM_ROUNDING_RULE.NAME) |
| reason | varchar | Reason code ID (CODE_DETAIL.CODE) |
| status | numeric | 1: Worksheet, 2: Submitted, 3: Rejected, 4: Approved, 5: Executed, 10: Processing |
| ignoreConstraints | varchar | "Y" or "N" |
This service provides the ability to submit a request to create, modify, and delete price changes through the induction process. Used in conjunction with the "Price Change Induction Poll" service.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
[
{
"action": null,
"newGroupBatch": null,
"priceChangeGroup": null,
"priceChangeGroupDesc": null,
"priceChange": null,
"item": null,
"diff": null,
"locationType": null,
"location": null,
"effectiveDate": null,
"updatedEffectiveDate": null,
"changeType": null,
"changeValue": null,
"sellingUom": null,
"multiUnitImpact": null,
"multiUnitRetail": null,
"multiUnits": null,
"multiUnitSellingUom": null,
"roundingRule": null,
"reason": null,
"status": null,
"ignoreConstraints": null
}, … (Possible list, comma separated for multiple)
]
| Key | Type | Value |
|---|---|---|
| action | varchar | "NEW", "MOD", or "DEL" |
| newGroupBatch | numeric | Transient numeric identifier to group related clearances together in the same clearance group upon creation. |
| priceChangeGroup | numeric | Price change group display ID |
| priceChangeGroupDesc | varchar | Price change group description |
| priceChange | numeric | Price change display ID |
| item | varchar | Item identifier (parent or transaction) |
| diff | varchar | Differentiator ID |
| locationType | numeric | 0: Store, 1: Zone, 2: Warehouse |
| location | numeric | Location ID (either store, warehouse, or zone) |
| effectiveDate | varchar | Effective date in the format YYYY-MM-DD |
| updatedEffectiveDate | varchar | Updated effective date in the format YYYY-MM-DD |
| changeType | numeric | 0: Change by Percent, 1: Change by Amount, 2: Fixed Price, 3: Reset POS Price |
| changeValue | numeric | Decimal change value |
| sellingUom | varchar | Selling unit of measure for Fixed Price change type |
| multiUnitImpact | varchar | AU: Add or Update, R: Remove, N: No Change |
| multiUnitRetail | numeric | Decimal multi unit fixed price change value |
| multiUnits | numeric | Multi unit quantity |
| multiUnitSellingUom | varchar | Selling unit of measure for multi unit price change |
| roundingRule | varchar | Rounding rule ID (technically name column RPM_ROUNDING_RULE.NAME) |
| reason | varchar | Reason code ID (CODE_DETAIL.CODE) |
| status | numeric | 1: Worksheet, 2: Submitted, 3: Rejected, 4: Approved, 5: Executed, 10: Processing |
| ignoreConstraints | varchar | "Y" or "N" |
This service provides the ability to poll the results of a request to create, modify, and delete price changes through the induction process. Used in conjunction with the "Price Change Induction Submit" service.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
{
"inductionProcessId": null
"pageNumber": null,
"pageSize": null,
"sortOrder": null
}
| Key | Type | Value |
|---|---|---|
| inductionProcessId | numeric | Induction process ID from a submitted async request |
| pageNumber | numeric | Page number to return |
| pageSize | numeric | Total number of results per page |
| sortOrder | varchar | ASC (ascending) or DESC (descending) |
202: Accepted - Induction process is still in progress
<No Body>
200: OK - Induction process has completed created and the paged results for the failed price changes are returned.
{ "statusMessage": null, "failedPriceChangeCount": null, "failedPriceChangePageCount": null, "failedPriceChangesPage": [ { "priceChange": null, "item": null, "diff": null, "locationType": null, "location": null, "effectiveDate": null, "errorMsg": null }, … (Possible list, comma separated for multiple) ]}
This service provides the ability to create, modify, and delete clearance markdowns and clearance resets via the induction process.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
[
{
"action": null,
"newGroupBatch": null,
"clearanceGroup": null,
"clearanceGroupDesc": null,
"clearance": null,
"markdown": null,
"item": null,
"diff": null,
"locationType": null,
"location": null,
"effectiveDate": null,
"updatedEffectiveDate": null,
"changeType": null,
"changeValue": null,
"roundingRule": null,
"reason": null,
"status": null
}, … (Possible list, comma separated for multiple)
]
| Key | Type | Value |
|---|---|---|
| action | varchar | "NEW", "MOD", or "DEL" |
| newGroupBatch | numeric | Transient numeric identifier to group related clearances together in the same clearance group upon creation. |
| clearanceGroup | numeric | Clearance group display ID |
| clearanceGroupDesc | varchar | Clearance group description |
| clearance | numeric | Clearance display ID |
| markdown | varchar | Markdown code ID (CODE_DETAIL.CODE) |
| item | varchar | Item identifier (parent or transaction) |
| diff | varchar | Differentiator ID |
| locationType | numeric | 0: Store, 1: Zone, 2: Warehouse |
| location | numeric | Location ID (either store, warehouse, or zone) |
| effectiveDate | varchar | Effective date in the format YYYY-MM-DD |
| updatedEffectiveDate | varchar | Updated effective date in the format YYYY-MM-DD |
| changeType | numeric | 0: Change by Percent, 1: Change by Amount, 2: Fixed Price, 3: Reset POS Price |
| changeValue | numeric | Decimal change value |
| roundingRule | varchar | Rounding rule ID (technically name column RPM_ROUNDING_RULE.NAME) |
| reason | varchar | Reason code ID (CODE_DETAIL.CODE) |
| status | numeric | 1: Worksheet, 2: Submitted, 3: Rejected, 4: Approved, 5: Executed, 10: Processing |
This service provides the ability to submit a request to create, modify, and delete clearances through the induction process. Used in conjunction with the "Clearance Induction Poll" service.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRIC-ING_DATA_STEWARD_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
[
{
"action": null,
"newGroupBatch": null,
"clearanceGroup": null,
"clearanceGroupDesc": null,
"clearance": null,
"markdown": null,
"item": null,
"diff": null,
"locationType": null,
"location": null,
"effectiveDate": null,
"updatedEffectiveDate": null,
"changeType": null,
"changeValue": null,
"roundingRule": null,
"reason": null,
"status": null
}, … (Possible list, comma separated for multiple)
]
| Key | Type | Value |
|---|---|---|
| action | varchar | "NEW", "MOD", or "DEL" |
| newGroupBatch | numeric | Transient numeric identifier to group related clearances together in the same clearance group upon creation. |
| clearanceGroup | numeric | Clearance group display ID |
| clearanceGroupDesc | varchar | Clearance group description |
| clearance | numeric | Clearance display ID |
| markdown | varchar | Markdown code ID (CODE_DETAIL.CODE) |
| item | varchar | Item identifier (parent or transaction) |
| diff | varchar | Differentiator ID |
| locationType | numeric | 0: Store, 1: Zone, 2: Warehouse |
| location | numeric | Location ID (either store, warehouse, or zone) |
| effectiveDate | varchar | Effective date in the format YYYY-MM-DD |
| updatedEffectiveDate | varchar | Updated effective date in the format YYYY-MM-DD |
| changeType | numeric | 0: Change by Percent, 1: Change by Amount, 2: Fixed Price, 3: Reset POS Price |
| changeValue | numeric | Decimal change value |
| roundingRule | varchar | Rounding rule ID (technically name column RPM_ROUNDING_RULE.NAME) |
| reason | varchar | Reason code ID (CODE_DETAIL.CODE) |
| status | numeric | 1: Worksheet, 2: Submitted, 3: Rejected, 4: Approved, 5: Executed, 10: Processing |
This service provides the ability to poll the results of a request to create, modify, and delete clearances through the induction process. Used in conjunction with the "Clearance Induction Submit" service.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
{
"inductionProcessId": null
"pageNumber": null,
"pageSize": null,
"sortOrder": null
}
| Key | Type | Value |
|---|---|---|
| inductionProcessId | numeric | Induction process ID from a submitted async request |
| pageNumber | numeric | Page number to return |
| pageSize | numeric | Total number of results per page |
| sortOrder | varchar | ASC (ascending) or DESC (descending) |
202: Accepted - Induction process is still in progress
<No Body>
200: OK - Induction process has completed created and the paged results for the failed clearance are returned.
{
"statusMessage": null,
"failedClearanceCount": null,
"failedClearancePageCount": null,
"failedClearancesPage": [
{
"clearance": null,
"item": null,
"diff": null,
"locationType": null,
"location": null,
"effectiveDate": null,
"errorMsg": null
}, … (Possible list, comma separated for multiple)
]
}
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PROMOTION_MANAGER_JOB, PROMOTION_PLANNER_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
[
{
"newPromotionBatch": null,
"promotionDescription": null,
"campaign": null,
"offers": [
{
"newOfferBatch": null,
"offerDescription": null,
"template": null,
"startDate": null,
"startTime": null,
"endDate": null,
"endTime": null,
"couponCode": null,
"couponCodeRequired": null,
"distributionRule": null,
"exclusiveDiscount": null,
"currency": null,
"comments": null,
"customerDescription": null,
"status": null,
"offerConditions": [
{
"buyXAndYConditionNumber": null,
"buySpendValue": null,
"buyQuantityUom": null,
"priceRestrictionOperator": null,
"priceRestrictionValue1": null,
"priceRestrictionValue2": null,
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null
}
]
}
],
"offerReward": {
"discountType": null,
"discountValue": null,
"applyTo": null,
"applyDiscountNumberOfTimes": null,
"priceRestrictionOperator": null,
"priceRestrictionValue1": null,
"priceRestrictionValue2": null,
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null
}
]
},
"offerLocations": [
{
"locationType": null,
"location": null,
"excluded": null
}
]
}
]
}, … (Possible list, comma separated for multiple)
]
| Entity | Key | Type | Value |
|---|---|---|---|
| promotion | newPromotionBatch | numeric | Transient numeric identifier to group related offers together in the same promotion upon creation. |
| promotion | promotionDescription | varchar | Promotion description |
| promotion | campaign | varchar | Promotion campaign name |
| promotion | offers | entity list | Offers for promotion |
| offer | newOfferBatch | numeric | Transient numeric identifier to group related offer details together upon creation. |
| offer | offerDescription | varchar | Offer description |
| offer | template | numeric | Offer template code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE IN ('TSOT', 'ISOT', 'TBOT', 'IBOT', 'IGOT') |
| offer | startDate | varchar | Start date in the format YYYY-MM-DD |
| offer | startTime | varchar | Start time in the format hh:mm a |
| offer | endDate | varchar | End date in the format YYYY-MM-DD |
| offer | endTime | varchar | End time in the format hh:mm a |
| offer | couponCode | varchar | Coupon code |
| offer | couponCodeRequired | numeric | 0: No, 1: Yes |
| offer | distributionRule | varchar | Offer distribution code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFDR') |
| offer | exclusiveDiscount | numeric | 0: No, 1: Yes |
| offer condition | currency | varchar | Offer currency code |
| offer | comments | varchar | Comments |
| offer | customerDescription | varchar | Customer description |
| offer | status | numeric | 1: Worksheet, 2: Submitted, 3: Rejected, 4: Approved, 6: Active, 9: Cancelled (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'PRST') |
| offer | offerConditions | entity list | Conditions for offer |
| offer | offerReward | entity | Reward for offer |
| offer | offerLocations | entity list | Locations for offer |
| offer condition | buyXAndYConditionNumber | numeric | Positive number when template is "Buy X and Y Get Discount" or "Buy X and Y Get Z for Discount" |
| offer condition | buySpendValue | numeric | Decimal buy/spend value |
| offer condition | buyQuantityUom | varchar | Buy quantity unit of measure |
| offer condition | priceRestrictionOperator | varchar | Price restriction operator code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OPRO') |
| offer condition | priceRestrictionValue1 | numeric | Decimal price restriction value |
| offer condition | priceRestrictionValue2 | numeric | Decimal price restriction value (for second between value) |
| offer condition | items | entity list | Items for offer condition |
| offer condition merchandise | itemLevel | numeric | Merchandise level (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFII') |
| offer condition merchandise | department | numeric | Merchandise department |
| offer condition merchandise | clazz | numeric | Merchandise class |
| offer condition merchandise | subclass | numeric | Merchandise subclass |
| offer condition merchandise | supplierSite | numeric | Merchandise supplier site |
| offer condition merchandise | brand | varchar | Merchandise brand |
| offer condition merchandise | item | varchar | Item ID (parent or transaction) |
| offer condition merchandise | diff | varchar | Differentiator ID |
| offer condition merchandise | excluded | numeric | 0: No, 1: Yes |
| offer reward | discountType | numeric | 0: Percent Off, 1: Amount Off, 2: Fixed Price (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFCT') |
| offer reward | discountValue | numeric | Decimal discount value |
| offer reward | applyTo | numeric | 0: Regular, 1: Clearance, 2: Regular and Clearance (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'PRAT') |
| offer reward | applyDiscountNumberOfTimes | numeric | Number of times the discount can be applied to individual item |
| offer reward | priceRestrictionOperator | varchar | Price restriction operator code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OPRO') |
| offer reward | priceRestrictionValue1 | numeric | Decimal price restriction value |
| offer reward | priceRestrictionValue2 | numeric | Decimal price restriction value (for second between value) |
| offer reward | items | entity list | Items for offer reward |
| offer reward merchandise | itemLevel | numeric | Merchandise level (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFII') |
| offer reward merchandise | department | numeric | Merchandise department |
| offer reward merchandise | clazz | numeric | Merchandise class |
| offer reward merchandise | subclass | numeric | Merchandise subclass |
| offer reward merchandise | supplierSite | numeric | Merchandise supplier site |
| offer reward merchandise | brand | varchar | Merchandise brand |
| offer reward merchandise | item | varchar | Item ID (parent or transaction) |
| offer reward merchandise | diff | varchar | Differentiator ID |
| offer reward merchandise | excluded | numeric | 0: No, 1: Yes |
| offer location | locationType | numeric | 0: Store, 1: Zone (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFLI') |
| offer location | location | numeric | Location ID (store or zone display ID) |
| offer location | excluded | numeric | 0: No, 1: Yes |
{
"statusMsg": null,
"successes": [
{
"newPromotionBatch": null,
"promotion": null,
"offers": [
{
"newOfferBatch": null,
"offer": null,
}
]
}
],
"errors": [
{
"newPromotionBatch": null,
"offers": [
{
"newOfferBatch": null,
"conditions": [
{
"buyXAndYConditionNumber": null,
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null,
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"reward": {
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null,
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
},
"locations": [
{
"locationType": null,
"location": null,
"excluded": null,
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
]
}
| Entity | Key | Type | Value |
|---|---|---|---|
| status | statusMsg | varchar | Status of the promotions create request |
| status | successes | entity list | Promotion successes |
| status | errors | entity list | Promotion errors |
| promotion success | newPromotionBatch | numeric | Transient numeric identifier to map back to the request promotion entity |
| promotion success | promotion | numeric | Created promotion display ID |
| promotion success | offers | entity list | Offer successes for promotion |
| offer success | newOfferBatch | numeric | Transient numeric identifier to map back to the request offer entity |
| offer success | offer | numeric | Created offer display ID |
| promotion error | newPromotionBatch | numeric | Transient numeric identifier to map back to the request promotion entity |
| promotion error | offers | entity list | Offer errors for promotion |
| promotion error | errors | entity list | Error details for promotion |
| offer error | newOfferBatch | numeric | Transient numeric identifier to map back to the request offer entity |
| offer error | conditions | entity list | Condition errors for offer |
| offer error | reward | entity | Reward error for offer |
| offer error | locations | entity list | Location errors for offer |
| offer error | errors | entity list | Error details for offer |
| offer condition error | buyXAndYConditionNumber | numeric | Numeric identifier to map back to the request condition entity |
| offer condition error | items | entity list | Item errors for offer condition |
| offer condition error | errors | entity list | Error details for offer condition |
| offer condition merchandise error | itemLevel | numeric | Merchandise level to map back to the request condition merchandise entity |
| offer condition merchandise error | department | numeric | Merchandise department to map back to the request condition merchandise en-tity |
| offer condition merchandise error | clazz | numeric | Merchandise class to map back to the request condition merchandise entity |
| offer condition merchandise error | subclass | numeric | Merchandise subclass to map back to the request condition merchandise entity |
| offer condition merchandise error | supplierSite | numeric | Merchandise supplier site to map back to the request condition merchandise entity |
| offer condition merchandise error | brand | varchar | Merchandise brand to map back to the request condition merchandise entity |
| offer condition merchandise error | item | varchar | Item ID (parent or transaction) to map back to the request condition merchandise entity |
| offer condition merchandise error | diff | varchar | Differentiator ID to map back to the re-quest condition merchandise entity |
| offer condition merchandise error | excluded | numeric | Excluded value to map back to the re-quest condition merchandise entity |
| offer condition merchandise error | errors | entity list | Error details for offer condition merchandise |
| offer reward error | items | entity list | Item errors for offer reward |
| offer reward error | errors | entity list | Error details for offer reward |
| offer reward error | itemLevel | numeric | Merchandise level to map back to the request reward merchandise entity |
| offer reward error | department | numeric | Merchandise department to map back to the request reward merchandise entity |
| offer reward error | clazz | numeric | Merchandise class to map back to the request reward merchandise entity |
| offer reward error | subclass | numeric | Merchandise subclass to map back to the request reward merchandise entity |
| offer reward error | supplierSite | numeric | Merchandise supplier site to map back to the request reward merchandise entity |
| offer reward error | brand | varchar | Merchandise brand to map back to the request reward merchandise entity |
| offer reward error | item | varchar | Item ID (parent or transaction) to map back to the request reward merchandise entity |
| offer reward error | diff | varchar | Differentiator ID to map back to the re-quest reward merchandise entity |
| offer reward error | excluded | numeric | Excluded value to map back to the request reward merchandise entity |
| offer reward error | errors | entity list | Error details for offer reward merchandise |
| offer location error | locationType | numeric | Location type value to map back to the request location entity |
| offer location error | location | numeric | Location ID to map back to the request location entity |
| offer location error | excluded | numeric | Excluded value to map back to the request location entity |
| offer location error | errors | entity list | Error details for offer location |
| error | type | varchar | E: Error, W: Warning |
| error | field | varchar | Entity attribute, field, or column in error |
| error | message | varchar | Error message |
This service provides the ability to submit a request to create, modify, and delete promotion offers through the induction process. Used in conjunction with the "Promotion Induction Poll" service.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PROMOTION_MANAGER_JOB, PROMOTION_PLANNER_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
[
{
"newPromotionBatch": null,
"promotionDescription": null,
"campaign": null,
"offers": [
{
"newOfferBatch": null,
"offerDescription": null,
"template": null,
"startDate": null,
"startTime": null,
"endDate": null,
"endTime": null,
"couponCode": null,
"couponCodeRequired": null,
"distributionRule": null,
"exclusiveDiscount": null,
"currency": null,
"comments": null,
"customerDescription": null,
"status": null,
"offerConditions": [
{
"buyXAndYConditionNumber": null,
"buySpendValue": null,
"buyQuantityUom": null,
"priceRestrictionOperator": null,
"priceRestrictionValue1": null,
"priceRestrictionValue2": null,
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null
}
]
}
],
"offerReward": {
"discountType": null,
"discountValue": null,
"applyTo": null,
"applyDiscountNumberOfTimes": null,
"priceRestrictionOperator": null,
"priceRestrictionValue1": null,
"priceRestrictionValue2": null,
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null
}
]
},
"offerLocations": [
{
"locationType": null,
"location": null,
"excluded": null
}
]
}
]
}, … (Possible list, comma separated for multiple)
]
| Key | Type | Value | |
|---|---|---|---|
| promotion | newPromotionBatch | numeric | Transient numeric identifier to group related offers together in the same promotion upon creation. |
| promotion | promotionDescription | varchar | Promotion description |
| promotion | campaign | varchar | Promotion campaign name |
| promotion | offers | entity list | Offers for promotion |
| offer | newOfferBatch | numeric | Transient numeric identifier to group related offer details together upon creation. |
| offer | offerDescription | varchar | Offer description |
| offer | template | numeric | Offer template code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE IN ('TSOT', 'ISOT', 'TBOT', 'IBOT', 'IGOT') |
| offer | startDate | varchar | Start date in the format YYYY-MM-DD |
| offer | startTime | varchar | Start time in the format hh:mm a |
| offer | endDate | varchar | End date in the format YYYY-MM-DD |
| offer | endTime | varchar | End time in the format hh:mm a |
| offer | couponCode | varchar | Coupon code |
| offer | couponCodeRequired | numeric | 0: No, 1: Yes |
| offer | distributionRule | varchar | Offer distribution code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFDR') |
| offer | exclusiveDiscount | numeric | 0: No, 1: Yes |
| offer condition | currency | varchar | Offer currency code |
| offer | comments | varchar | Comments |
| offer | customerDescription | varchar | Customer description |
| offer | status | numeric | 1: Worksheet, 2: Submitted, 3: Rejected, 4: Approved, 6: Active, 9: Cancelled (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'PRST') |
| offer | offerConditions | entity list | Conditions for offer |
| offer | offerReward | entity | Reward for offer |
| offer | offerLocations | entity list | Locations for offer |
| offer condition | buyXAndYConditionNumber | numeric | Positive number when template is "Buy X and Y Get Discount" or "Buy X and Y Get Z for Discount" |
| offer condition | buySpendValue | numeric | Decimal buy/spend value |
| offer condition | buyQuantityUom | varchar | Buy quantity unit of measure |
| offer condition | priceRestrictionOperator | varchar | Price restriction operator code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OPRO') |
| offer condition | priceRestrictionValue1 | numeric | Decimal price restriction value |
| offer condition | priceRestrictionValue2 | numeric | Decimal price restriction value (for second between value) |
| offer condition | items | entity list | Items for offer condition |
| offer condition merchandise | itemLevel | numeric | Merchandise level (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFII') |
| offer condition merchandise | department | numeric | Merchandise department |
| offer condition merchandise | clazz | numeric | Merchandise class |
| offer condition merchandise | subclass | numeric | Merchandise subclass |
| offer condition merchandise | supplierSite | numeric | Merchandise supplier site |
| offer condition merchandise | brand | varchar | Merchandise brand |
| offer condition merchandise | item | varchar | Item ID (parent or transaction) |
| offer condition merchandise | diff | varchar | Differentiator ID |
| offer condition merchandise | excluded | numeric | 0: No, 1: Yes |
| offer reward | discountType | numeric | 0: Percent Off, 1: Amount Off, 2: Fixed Price (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFCT') |
| offer reward | discountValue | numeric | Decimal discount value |
| offer reward | applyTo | numeric | 0: Regular, 1: Clearance, 2: Regular and Clearance (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'PRAT') |
| offer reward | applyDiscountNumberOfTimes | numeric | Number of times the discount can be applied to individual item |
| offer reward | priceRestrictionOperator | varchar | Price restriction operator code (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OPRO') |
| offer reward | priceRestrictionValue1 | numeric | Decimal price restriction value |
| offer reward | priceRestrictionValue2 | numeric | Decimal price restriction value (for second between value) |
| offer reward | items | entity list | Items for offer reward |
| offer reward merchandise | itemLevel | numeric | Merchandise level (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFII') |
| offer reward merchandise | department | numeric | Merchandise department |
| offer reward merchandise | clazz | numeric | Merchandise class |
| offer reward merchandise | subclass | numeric | Merchandise subclass |
| offer reward merchandise | supplierSite | numeric | Merchandise supplier site |
| offer reward merchandise | brand | varchar | Merchandise brand |
| offer reward merchandise | item | varchar | Item ID (parent or transaction) |
| offer reward merchandise | diff | varchar | Differentiator ID |
| offer reward merchandise | excluded | numeric | 0: No, 1: Yes |
| offer location | locationType | numeric | 0: Store, 1: Zone (SELECT CODE FROM CODE_DETAIL WHERE CODE_TYPE = 'OFLI') |
| offer location | location | numeric | Location ID (store or zone display ID) |
| offer location | excluded | numeric | 0: No, 1: Yes |
This service provides the ability to poll the results of a request to create, modify, and delete Promotion Offers through the induction process. Used in conjunction with the "Promotion Induction Submit" service.
PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PROMOTION_MANAGER_JOB, PRMOTION_PLANNER_JOB, rgbu:merch:system
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
Content-Type: <application/json or application/xml>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
Content-Type: application/json
{
"inductionProcessId": null
"pageNumber": null,
"pageSize": null,
"sortOrder": null
}
| Key | Type | Value |
|---|---|---|
| inductionProcessId | numeric | Induction process ID from a submitted async request |
| pageNumber | numeric | Page number to return |
| pageSize | numeric | Total number of results per page |
| sortOrder | varchar | ASC (ascending) or DESC (descending) |
202: Accepted - Induction process is still in progress
<No Body>
200: OK - Induction process has completed created and the paged results for the failed promotion offers are re-turned.
{
"statusMsg": null,
"successes": [
{
"newPromotionBatch": null,
"promotion": null,
"offers": [
{
"newOfferBatch": null,
"offer": null,
}
]
}
],
"errors": [
{
"newPromotionBatch": null,
"offers": [
{
"newOfferBatch": null,
"conditions": [
{
"buyXAndYConditionNumber": null,
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null,
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"reward": {
"items": [
{
"itemLevel": null,
"department": null,
"clazz": null,
"subclass": null,
"supplierSite": null,
"brand": null,
"item": null,
"diff": null,
"excluded": null,
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
},
"locations": [
{
"locationType": null,
"location": null,
"excluded": null,
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
],
"errors": [
{
"type": null,
"field": null,
"message": null
}
]
}
]
}
| Entity | Key | Type | Value |
|---|---|---|---|
| status | statusMsg | varchar | Status of the promotions create request |
| status | successes | entity list | Promotion successes |
| status | errors | entity list | Promotion errors |
| promotion success | newPromotionBatch | numeric | Transient numeric identifier to map back to the request promotion entity |
| promotion success | promotion | numeric | Created promotion display ID |
| promotion success | offers | entity list | Offer successes for promotion |
| offer success | newOfferBatch | numeric | Transient numeric identifier to map back to the request offer entity |
| offer success | offer | numeric | Created offer display ID |
| promotion error | newPromotionBatch | numeric | Transient numeric identifier to map back to the request promotion entity |
| promotion error | offers | entity list | Offer errors for promotion |
| promotion error | errors | entity list | Error details for promotion |
| offer error | newOfferBatch | numeric | Transient numeric identifier to map back to the request offer entity |
| offer error | conditions | entity list | Condition errors for offer |
| offer error | reward | entity | Reward error for offer |
| offer error | locations | entity list | Location errors for offer |
| offer error | errors | entity list | Error details for offer |
| offer condition error | buyXAndYConditionNumber | numeric | Numeric identifier to map back to the request condition entity |
| offer condition error | items | entity list | Item errors for offer condition |
| offer condition error | errors | entity list | Error details for offer condition |
| offer condition merchandise error | itemLevel | numeric | Merchandise level to map back to the request condition merchandise entity |
| offer condition merchandise error | department | numeric | Merchandise department to map back to the request condition merchandise entity |
| offer condition merchandise error | clazz | numeric | Merchandise class to map back to the request condition merchandise entity |
| offer condition merchandise error | subclass | numeric | Merchandise subclass to map back to the request condition merchandise entity |
| offer condition merchandise error | supplierSite | numeric | Merchandise supplier site to map back to the request condition merchandise entity |
| offer condition merchandise error | brand | varchar | Merchandise brand to map back to the request condition merchandise entity |
| offer condition merchandise error | item | varchar | Item ID (parent or transaction) to map back to the request condition merchandise entity |
| offer condition merchandise error | diff | varchar | Differentiator ID to map back to the re-quest condition merchandise entity |
| offer condition merchandise error | excluded | numeric | Excluded value to map back to the re-quest condition merchandise entity |
| offer condition merchandise error | errors | entity list | Error details for offer condition merchandise |
| offer reward error | items | entity list | Item errors for offer reward |
| offer reward error | errors | entity list | Error details for offer reward |
| offer reward error | itemLevel | numeric | Merchandise level to map back to the request reward merchandise entity |
| offer reward error | department | numeric | Merchandise department to map back to the request reward merchandise entity |
| offer reward error | clazz | numeric | Merchandise class to map back to the request reward merchandise entity |
| offer reward error | subclass | numeric | Merchandise subclass to map back to the request reward merchandise entity |
| offer reward error | supplierSite | numeric | Merchandise supplier site to map back to the request reward merchandise entity |
| offer reward error | brand | varchar | Merchandise brand to map back to the request reward merchandise entity |
| offer reward error | item | varchar | Item ID (parent or transaction) to map back to the request reward merchandise entity |
| offer reward error | diff | varchar | Differentiator ID to map back to the re-quest reward merchandise entity |
| offer reward error | excluded | numeric | Excluded value to map back to the request reward merchandise entity |
| offer reward error | errors | entity list | Error details for offer reward merchandise |
| offer location error | locationType | numeric | Location type value to map back to the request location entity |
| offer location error | location | numeric | Location ID to map back to the request location entity |
| offer location error | excluded | numeric | Excluded value to map back to the request location entity |
| offer location error | errors | entity list | Error details for offer location |
| error | type | varchar | E: Error, W: Warning |
| error | field | varchar | Entity attribute, field, or column in error |
| error | message | varchar | Error message |
This service provides the ability to get retail information for a given time period. Used to get initial retail, Regular Price Changes and Clearances. Targeted for OMS/Xstore usage. This endpoint includes business functionality around clearances being reset by regular price changes. The response from this endpoint does not include all the fields that are included in v2/item/price.
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
| Key | Type | Value |
|---|---|---|
| since | Timestamp | UTC ISO-8601 Date and Time |
| before | Timestamp | UTC ISO-8601 Date and Time |
| nodelevel | String | COMPANY
STORE |
| nodeid | Integer | 0 .. n |
| pricetype | String | INITIAL
REGULAR CLEARANCE |
| limit | Integer | 0 .. n |
| offsetkey | String | generated |
[
{
"action": null,
"loctype": null,
"location": null,
"item": null,
"pricetype": null,
"effective": null,
"source": null,
"eventid": null,
"resetind": null,
"clearanceind": null
}
]
| Key | Type | Value |
|---|---|---|
| action | String | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| loctype | String | Location type |
| location | Integer | Location identifier for item price |
| item | String | Item identifier |
| pricetype | String | INITIAL, REGULAR or CLEARANCE |
| price | Number | item price |
| effective | Date | Date when change becomes effective |
| source | String | If direct, the price was initiated directly. Implied means the price change was implied by another price change |
| eventid | Integer | Pricing Service event id for the price activity |
| resetind | Integer | Flag to indicate to reset the item to previous price |
| clearanceind | Integer | Flag to indicate the item is on clearance |
This service provides the ability to get retail information for a given time period. Used to get initial retail, Regular Price Changes and Clearances. Targeted for non-Oracle Retail applications. This endpoint does not include business functionality around clearances being reset by regular price changes. The response from this endpoint includes extra fields that are not included in v1/item/price and does not include the "source" and "clearanceind" fields that are a part of v1/item/price.
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
For example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
| Key | Type | Value |
|---|---|---|
| since | Timestamp | UTC ISO-8601 Date and Time |
| before | Timestamp | UTC ISO-8601 Date and Time |
| nodelevel | String | COMPANY
STORE |
| nodeid | Integer | 0 .. n |
| pricetype | String | INITIAL
REGULAR CLEARANCE |
| limit | Integer | 0 .. n |
| offsetkey | String | generated |
[
{
"action": null,
"loctype": null,
"location": null,
"item": null,
"pricetype": null,
"price": null,
"unitofmeasure": null,
"currency": null,
"retailchangeind": null,
"multiunitimpact": null,
"multiunits": null,
"multiunitretail": null,
"multiunitsellinguom": null,
"multiunitcurrency": null,
"effective": null,
"eventid": null,
"resetind": null
}
]
| Key | Type | Value |
|---|---|---|
| action | String | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. |
| loctype | String | Location type |
| location | Integer | Location identifier for item price |
| item | String | Item identifier |
| pricetype | String | INITIAL, REGULAR or CLEARANCE |
| price | Number | item price |
| unitofmeasure | String | The retail Unit Of Measure |
| currency | String | The currency for the location. |
| retailchangeind | Integer | Indicates whether the retail changed with this price change. |
| multiunitimpact | String | Indicates if the Price Change has impact to Multi Unit retail. Valid values are AU - Multi Unit information is added or updated; R - Multi Unit information is removed; N - Multi unit information is not changed. |
| multiunits | Number | Number of multi units |
| multiunitretail | Number | The Multi Unit Retail value |
| multiunitsellinguom | String | The Multi Unit Retail Selling UOM |
| multiunitcurrency | String | The Multi Unit Retail Currency |
| effective | Date | Date when change becomes effective |
| eventid | Integer | Pricing Service event id for the price activity |
| resetind | Integer | Flag to indicate to reset the item to previous price |
This service provides the ability to get promotion information for a given time period. Targeted for OMS/Xstore usage. The response from this endpoint does not include all the fields that are included in v2/item/promo.
Accept: <application/json or application/xml> Accept-Language: <locale> Accept-Version: <application_version>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
| Key | Type | Value |
|---|---|---|
| since | Timestamp | UTC ISO-8601 Date and Time |
| before | Timestamp | UTC ISO-8601 Date and Time |
| nodelevel | String | COMPANY
STORE |
| nodeid | Integer | 0 .. n |
| limit | Integer | 0 .. n |
| offsetkey | String | generated |
[
{
"promoid": null,
"offerid": null,
"desc": null,
"custdesc": null,
"levelcode": null,
"typecode": null,
"templateid": null,
"couponcode": null,
"couponcodereq": null,
"startdatetime": null,
"enddatetime": null,
"canceldatetime": null,
"rewards": [
{
"rewardid": null,
"changetype": null,
"changeamount": null,
"changepercent": null,
"qtytodisc": null,
"qtytodiscuom": null,
"applyind": null,
"pricerestrictcode": null,
"pricestrictvalue1": null,
"pricestrictvalue2": null,
"rewardsmerch": [
{
"rewardmerchid": null,
"merchlevel": null,
"dept": null,
"class1": null,
"uniqueclass": null,
"subclass": null,
"unisubclass": null,
"item": null,
"diffid": null,
"excludeind": null,
"canceldatetime": null
}
]
}
],
"conditions": [
{
"conditionid": null,
"buyspendtype": null,
"buyspendvalue": null,
"buyuom": null,
"pricerestrictcode": null,
"pricerestrictvalue1": null,
"pricerestrictvalue2": null,
"conditionsmerch": [
{
"condmerchid": null,
"merchlevel": null,
"dept": null,
"class": null,
"uniqueclass": null,
"subclass": null,
"uniquesubclass": null,
"item": null,
"diffid": null,
"excludeind": null,
"canceldatetime": null
}
]
}
],
"locations": [
{
"location": null,
"canceldatetime": null,
"action": null
}
]
}
]
| Entity | Key | Type | Value |
|---|---|---|---|
| action | String | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. | |
| promoid | Integer | Promotion identifier. | |
| offerid | Integer | Offer Identifier. | |
| desc | String | Description of the offer. | |
| custdesc | String | Customer facing description | |
| levelcode | Integer | The level of the offer. Valid values are: 0 - Item, 1 - Transaction. | |
| typecode | Integer | The type of the offer. Valid values are: 0 Item Simple, 1 Transaction Simple, 2 - Transaction Buy Get, 3 - Item Buy Get, 4 - Item Gift With Purchase | |
| templateid | Integer | The template of the offer. Valid values are: 0 - Get Discount, 1 - Buy X, Get Discount, 2 - Spend X, Get Discount, 3 - Get Y for Discount, 4 - Buy | |
| startdatetime | Date | Starting date time for the offer | |
| enddatetime | Date | Ending date time for the offer | |
| rewards | Rewards associated with the offer | ||
| rewards | rewardsid | Integer | Reward ID |
| rewards | changetype | Integer | Type of change for the reward. Valid values: change by amount (1), change by percent (0), fixed price (2) |
| rewards | changeamount | Number | The change by amount or fixed price amount. |
| rewards | changepercent | Number | Percentage value when change type is change by percent. |
| rewards | qtytodisc | Number | The qty to discount. |
| rewards | qtytodiscuom | String | UOM of the discount quantity. |
| rewards | appyind | Integer | The apply to indicator of the reward. Valid values: Regular only - 0; Clearance only - 1; Regular and Clearance - 2 |
| rewards | pricerestrictcode | Integer | Price restriction code. Valid Values are B - Between; G - Greater Than; L - Less Than |
| rewards | pricestrictvalue1 | Number | The first value of the price restriction. |
| rewards | pricerestrictvalue2 | Number | The second value of the price restriction. The second value is only used for between restrictions |
| rewards | rwardsmerch | Collection of merchandise eligible for reward | |
| rewards.rewardsmerch | rewardmerchid | Integer | The unique id for the offer reward merch record. |
| rewards.rewardsmerch | mrchlevel | Integer | The merchandise level of the row. Valid values are: 1 - Department; 2 - Class; 3 - Subclass; 4 - Parent Item; 5 - Parent/Diff Item; 6 - Transaction Item; 8 - All Departments |
| rewards.rewardsmerch | dept | Integer | Department ID |
| rewards.rewardsmerch | class | Integer | The non-unique class ID value |
| rewards.rewardsmerch | uniqueclass | Integer | The unique class ID value |
| rewards.rewardsmerch | subclass | Integer | The non-unique subclass ID value |
| rewards.rewardsmerch | unisubclass | Integer | The unique subclass ID value |
| rewards.rewardsmerch | item | String | Item ID |
| rewards.rewardsmerch | diffid | String | Differentiator ID |
| rewards.rewardsmerch | excludeind | Integer | The exclude indicator of the row |
| rewards.rewardsmerch | canceldatetime | Date | Date time when merchandise reward was cancelled |
| conditions | Collection of conditions for promotion | ||
| conditions | conditionid | Integer | Condition ID |
| conditions | buyspendtype | Integer | The buy spend type of the condition. Valid values are: 0 - Quantity, 1 - Amount |
| conditions | buyspendvalue | Number | The buy spend value of the condition |
| conditions | buyuom | String | The buy UOM of the condition |
| conditions | pricerestrictcode | Integer | Price restriction code. Valid Values are B - Between; G - Greater Than; L - Less Than |
| conditions | pricerestrictvalue1 | Number | The first value of the price restriction |
| conditions | pricerestrictvalue2 | Number | The second value of the price restriction. The second value is only used for between restrictions |
| conditions | conditionsmerch | Collection of merchandise for condition | |
| conditions.conditionsmerch | condmerchid | Integer | The unique id for the offer condition merch record |
| conditions.conditionsmerch | merchlevel | Integer | The merchandise level. Valid values are: 1 - Department; 2 - Class; 3 - Subclass; 4 - Parent Item; 5 - Parent/Diff |
| conditions.conditionsmerch | dept | Integer | Department ID |
| conditions.conditionsmerch | class | Integer | The non-unique class ID value |
| conditions.conditionsmerch | uniqueclass | Integer | The unique class ID value |
| conditions.conditionsmerch | subclass | Integer | The non-unique subclass ID value |
| conditions.conditionsmerch | uniquesubclass | Integer | The unique subclass ID value |
| conditions.conditionsmerch | item | String | Item ID |
| conditions.conditionsmerch | diffid | String | Differentiator ID |
| conditions.conditionsmerch | excludeind | Integer | The exclude indicator |
| conditions.conditionsmerch | canceldatetime | Date | Date time condition merchandise was cancelled |
| locations | Collection of locations for the promotion | ||
| locations | action | String | Action for the promotion in this location - INSERT, UPDATE, DELETE, UPDATE |
| locations | location | Integer | Location for promotion |
This service provides the ability to get promotion information for a given time period. Targeted for OMS/Xstore usage. The response from this endpoint includes extra fields that are included in v1/item/promo.
Accept: <application/json or application/xml>
Accept-Language: <locale>
Accept-Version: <application_version>
For Example:
Accept: application/json
Accept-Language: en-US
Accept-Version: 19.0
| Key | Type | Value |
|---|---|---|
| since | Timestamp | UTC ISO-8601 Date and Time |
| before | Timestamp | UTC ISO-8601 Date and Time |
| nodelevel | String | COMPANY
STORE |
| nodeid | Integer | 0 .. n |
| limit | Integer | 0 .. n |
| offsetkey | String | generated |
[
{
"promoid": null,
"offerid": null,
"desc": null,
"custdesc": null,
"levelcode": null,
"typecode": null,
"templateid": null,
"couponcode": null,
"couponcodereq": null,
"startdatetime": null,
"enddatetime": null,
"comments": null,
"distributionrulecode": null,
"exclusivediscountind": null,
"canceldatetime": null,
"rewards": [
{
"rewardid": null,
"changetype": null,
"changeamount": null,
"changepercent": null,
"qtytodisc": null,
"applyind": null,
"pricerestrictcode": null,
"pricestrictvalue1": null,
"pricestrictvalue2": null,
"rewardsmerch": [
{
"rewardmerchid": null,
"merchlevel": null,
"dept": null,
"class1": null,
"uniqueclass": null,
"subclass": null,
"unisubclass": null,
"item": null,
"diffid": null,
"suppliersite": null,
"brandname": null,
"excludeind": null,
"canceldatetime": null
}
]
}
],
"conditions": [
{
"conditionid": null,
"buyspendtype": null,
"buyspendvalue": null,
"buyuom": null,
"pricerestrictcode": null,
"pricerestrictvalue1": null,
"pricerestrictvalue2": null,
"conditionsmerch": [
{
"condmerchid": null,
"merchlevel": null,
"dept": null,
"class": null,
"uniqueclass": null,
"subclass": null,
"uniquesubclass": null,
"item": null,
"diffid": null,
"suppliersite": null,
"brandname": null,
"excludeind": null,
"canceldatetime": null
}
]
}
],
"locations": [
{
"location": null,
"canceldatetime": null,
"action": null
}
]
}
]
| Key | Type | Value | |
|---|---|---|---|
| action | String | Recommended action based on how data has changed since a point in time. Possible values are: NO_CHANGE, DELETE, UPSERT, INSERT, UPDATE and NA. | |
| promoid | Integer | Promotion identifier. | |
| offerid | Integer | Offer Identifier. | |
| desc | String | Description of the offer. | |
| custdesc | String | Customer facing description | |
| levelcode | Integer | The level of the offer. Valid values are: 0 - Item, 1 - Transaction. | |
| typecode | Integer | The type of the offer. Valid values are: 0 Item Simple, 1 Transaction Simple, 2 - Transaction Buy Get, 3 - Item Buy Get, 4 - Item Gift With Purchase | |
| templateid | Integer | The template of the offer. Valid values are: 0 - Get Discount, 1 - Buy X, Get Discount, 2 - Spend X, Get Discount, 3 - Get Y for Discount, 4 - Buy | |
| startdatetime | Date | Starting date time for the offer | |
| enddatetime | Date | Ending date time for the offer | |
| rewards | Rewards associated with the offer | ||
| rewards | rewardsid | Integer | Reward ID |
| rewards | changetype | Integer | Type of change for the reward. Valid values: change by amount (1), change by percent (0), fixed price (2) |
| rewards | changeamount | Number | The change by amount or fixed price amount. |
| rewards | changepercent | Number | Percentage value when change type is change by percent. |
| rewards | qtytodisc | Number | The qty to discount. |
| rewards | qtytodiscuom | String | UOM of the discount quantity. |
| rewards | appyind | Integer | The apply to indicator of the reward. Valid values: Regular only - 0; Clearance only - 1; Regular and Clearance - 2 |
| rewards | pricerestrictcode | Integer | Price restriction code. Valid Values are B - Between; G - Greater Than; L - Less Than |
| rewards | pricestrictvalue1 | Number | The first value of the price restriction. |
| rewards | pricerestrictvalue2 | Number | The second value of the price restriction. The second value is only used for between restrictions |
| rewards | rwardsmerch | Collection of merchandise eligible for reward | |
| rewards.rewardsmerch | rewardmerchid | Integer | The unique id for the offer reward merch record. |
| rewards.rewardsmerch | mrchlevel | Integer | The merchandise level of the row. Valid values are: 1 - Department; 2 - Class; 3 - Subclass; 4 - Parent Item; 5 - Parent/Diff Item; 6 - Transaction Item; 8 - All Departments |
| rewards.rewardsmerch | dept | Integer | Department ID |
| rewards.rewardsmerch | class | Integer | The non-unique class ID value |
| rewards.rewardsmerch | uniqueclass | Integer | The unique class ID value |
| rewards.rewardsmerch | subclass | Integer | The non-unique subclass ID value |
| rewards.rewardsmerch | unisubclass | Integer | The unique subclass ID value |
| rewards.rewardsmerch | item | String | Item ID |
| rewards.rewardsmerch | diffid | String | Differentiator ID |
| rewards.rewardsmerch | excludeind | Integer | The exclude indicator of the row |
| rewards.rewardsmerch | canceldatetime | Date | Date time when merchandise reward was cancelled |
| conditions | Collection of conditions for promotion | ||
| conditions | conditionid | Integer | Condition ID |
| conditions | buyspendtype | Integer | The buy spend type of the condition. Valid values are: 0 - Quantity, 1 - Amount |
| conditions | buyspendvalue | Number | The buy spend value of the condition |
| conditions | buyuom | String | The buy UOM of the condition |
| conditions | pricerestrictcode | Integer | Price restriction code. Valid Values are B - Between; G - Greater Than; L - Less Than |
| conditions | pricerestrictvalue1 | Number | The first value of the price restriction |
| conditions | pricerestrictvalue2 | Number | The second value of the price restriction. The second value is only used for between restrictions |
| conditions | conditionsmerch | Collection of merchandise for condition | |
| conditions.conditionsmerch | condmerchid | Integer | The unique id for the offer condition merch record |
| conditions.conditionsmerch | merchlevel | Integer | The merchandise level. Valid values are: 1 - Department; 2 - Class; 3 - Subclass; 4 - Parent Item; 5 - Parent/Diff |
| conditions.conditionsmerch | dept | Integer | Department ID |
| conditions.conditionsmerch | class | Integer | The non-unique class ID value |
| conditions.conditionsmerch | uniqueclass | Integer | The unique class ID value |
| conditions.conditionsmerch | subclass | Integer | The non-unique subclass ID value |
| conditions.conditionsmerch | uniquesubclass | Integer | The unique subclass ID value |
| conditions.conditionsmerch | item | String | Item ID |
| conditions.conditionsmerch | diffid | String | Differentiator ID |
| conditions.conditionsmerch | excludeind | Integer | The exclude indicator |
| conditions.conditionsmerch | canceldatetime | Date | Date time condition merchandise was cancelled |
| locations | Collection of locations for the promotion | ||
| locations | action | String | Action for the promotion in this location - INSERT, UPDATE, DELETE, UPDATE |
| locations | location | Integer | Location for promotion |
