3 ReST Services

This chapter describes ReST services available in Pricing.

Price Inquiry

Business Overview

This service provides the ability to query the selling price of item/locations for a given date.

Service Type

POST

REST URL

/priceInquiry

Roles Allowed

PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PRICING_MANAGER_JOB, PRICING_ANALYST_JOB, PROMOTION_MANAGER_JOB, PROMOTION_PLANNER_JOB

Request Headers

         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

URL Query Parameters

N/A

Request Body

{
"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)

Response Body

[
  {
    "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

Initial Retail

Business Overview

This service provides the ability to query the initial retail of an item/location.

Service Type

GET

REST URL

/initialRetail?item=<item>&location=<location>

Roles Allowed

PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PRICING_MANAGER_JOB, PRICING_ANALYST_JOB, PROMOTION_MANAGER_JOB, PROMOTION_PLANNER_JOB

Request Headers

          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

URL Query Parameters

Key	Type	Value
item	varchar	Item ID (transaction or reference)
location	numeric	Location ID (store or virtual warehouse)

Request Body

N/A

Response Body

[
  {
    "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

Price Change Induction

Business Overview

This service provides the ability to create, modify, and delete price changes via the induction process.

Service Type

POST

REST URL

/priceChange/induction

Roles Allowed

PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB

Request Headers

          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

URL Query Parameters

N/A

Request Body

[
  {
    "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"

Response Body

{
  "statusMsg": null,
  "failPcTable": [
    {
      "priceChange": null,
      "item": null,
      "diff": null,
      "locationType": null,
      "location": null,
      "effectiveDate": null,
      "errorMsg": null
    }, … (Possible list, comma separated for multiple)
  ]
}

Clearance Induction

Business Overview

This service provides the ability to create, modify, and delete clearance markdowns and clearance resets via the induction process.

Service Type

POST

REST URL

/clearance/induction

Roles Allowed

PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_MANAGER_JOB, PRICING_DATA_STEWARD_JOB

Request Headers

          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

URL Query Parameters

N/A

Request Body

[
  {
    "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

Response Body

{
  "statusMsg": null,
  "failClrTable": [
    {
      "clearance": null,
      "item": null,
      "diff": null,
      "locationType": null,
      "location": null,
      "effectiveDate": null,
      "errorMsg": null
    }, … (Possible list, comma separated for multiple)
  ]
}

Promotion Create

Business Overview

This service provides the ability to create promotions via the induction process.

Service Type

POST

REST URL

/promotion

Roles Allowed

PRICING_APPLICATION_ADMINISTRATOR_JOB, PRICING_DATA_STEWARD_JOB, PROMOTION_MANAGER_JOB, PROMO-TION_PLANNER_JOB

Request Headers

          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

URL Query Parameters

N/A

Request Body

[
  {
    "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

Response Body

{
  "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