SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

PromotionPlanStockByLocationListing

Promotion Module

Promotion API

Requires Authentication
Required permission:PromotionPlanStockByLocationListing-Enquiry.GET
The following routes are available for this service:
GET/Promotion/Listing/Stock/{AcLocationID}/{EditDateStock}/{PageNumber}/{RecordsPerPage}Get Stock Promotion Price by given Location, Last Changed Date of Stock Registered to promotion campaign
PromotionPlanStockByLocationListing Parameters:
NameParameterData TypeRequiredDescription
AcLocationIDpathstringNo
EditDateStockpathDateTimeNo
PageNumberpathintNo
RecordsPerPagepathintNo
PromotionPlanStockByLocationListingResponse Parameters:
NameParameterData TypeRequiredDescription
PromotionPlanStockByLocationListingformList<pfapi70040GetPromotionPlanStockByLocationListing>No
ResponseStatusformResponseStatusNo
pfapi70040GetPromotionPlanStockByLocationListing Parameters:
NameParameterData TypeRequiredDescription
AcPromotionPlanRefNoformstringNoPromtion Campaign Reference Number
AcPromotionPlanDescformstringNoPromtion Campaign Description
SchPromoStartDateformDateTimeNoPromotion Effective Date. Promotion starting from this date.
SchPromoEndDateformDateTimeNoPromotion End Date. No more promotion on this date.
PromotionPlanTypeformstringNoPromotion Plan Type: SCHEDULED/ADHOC
PromotionPriorityformintNoPromotion Priority: ADHOC = 1, SCHEDULED = 2
PromotionTimelineformstringNoPromotion Timeline: ONGOING; UPCOMING
EditDateStockformDateTimeNoIndicate the last changed date of stock which registered to promotion campaign.
AcPromotionPlanSchPromoMDescformstringNoScheduled/Adhoc Activity Description
AcPromotionPlanSchPromoMBatchRefNoformstringNoScheduled/Adhoc Batch Reference Number
AcPromotionPlanSchPromoMBatchDescformstringNoScheduled/Adhoc Batch Description
SchPromoIsAllDayEventformstringNo
AcStockIDformstringNo
AcStockUOMIDformstringNo
StockArticleNoformstringNo
AcStockColorIDformstringNo
AcStockColorDescformstringNo
AcStockSizeIDformstringNo
AcStockSizeDescformstringNo
StockPrice1formdecimalNo
StockPrice2formdecimalNo
StockPrice3formdecimalNo
StockPrice4formdecimalNo
StockPrice5formdecimalNo
POSPriceformdecimalNoSelling Price at POS
DiscountAmountformdecimalNoDiscount Amount for Non-Member
POSPromoPriceformdecimalNoPromotion Price for Non-Member
DiscountAmountForMemberformdecimalNoDiscount Amount for Member
PosPromoMemberPriceformdecimalNoPromotion Price for Member
AcPromotionPlanIDformstringNoPromotion Campaign Record ID
AcPromotionPlanSchPromoMIDformstringNoPromotion Campaign's Scheduled/Adhoc's Record ID
AcPromotionPlanSchPromoMBatchIDformstringNoPromotion Campaign's Schedule/Adhoc's Batch Record ID
AcPromotionPlanSchStockIDformstringNoPromotion Campaign's Schedule/Adhoc's Batch's Stocks Record ID

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Promotion/Listing/Stock/{AcLocationID}/{EditDateStock}/{PageNumber}/{RecordsPerPage} HTTP/1.1 
Host: snr2u.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PromotionPlanStockByLocationListing: 
	[
		{
			AcPromotionPlanRefNo: String,
			AcPromotionPlanDesc: String,
			SchPromoStartDate: 0001-01-01,
			SchPromoEndDate: 0001-01-01,
			PromotionPlanType: String,
			PromotionPriority: 0,
			PromotionTimeline: String,
			EditDateStock: 0001-01-01,
			AcPromotionPlanSchPromoMDesc: String,
			AcPromotionPlanSchPromoMBatchRefNo: String,
			AcPromotionPlanSchPromoMBatchDesc: String,
			SchPromoIsAllDayEvent: String,
			AcStockID: String,
			AcStockUOMID: String,
			StockArticleNo: String,
			AcStockColorID: String,
			AcStockColorDesc: String,
			AcStockSizeID: String,
			AcStockSizeDesc: String,
			StockPrice1: 0,
			StockPrice2: 0,
			StockPrice3: 0,
			StockPrice4: 0,
			StockPrice5: 0,
			POSPrice: 0,
			DiscountAmount: 0,
			POSPromoPrice: 0,
			DiscountAmountForMember: 0,
			PosPromoMemberPrice: 0,
			AcPromotionPlanID: String,
			AcPromotionPlanSchPromoMID: String,
			AcPromotionPlanSchPromoMBatchID: String,
			AcPromotionPlanSchStockID: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}