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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PromotionPlanStockByLocationListingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <PromotionPlanStockByLocationListing xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:pfapi70040GetPromotionPlanStockByLocationListing>
      <d2p1:AcPromotionPlanDesc>String</d2p1:AcPromotionPlanDesc>
      <d2p1:AcPromotionPlanID>String</d2p1:AcPromotionPlanID>
      <d2p1:AcPromotionPlanRefNo>String</d2p1:AcPromotionPlanRefNo>
      <d2p1:AcPromotionPlanSchPromoMBatchDesc>String</d2p1:AcPromotionPlanSchPromoMBatchDesc>
      <d2p1:AcPromotionPlanSchPromoMBatchID>String</d2p1:AcPromotionPlanSchPromoMBatchID>
      <d2p1:AcPromotionPlanSchPromoMBatchRefNo>String</d2p1:AcPromotionPlanSchPromoMBatchRefNo>
      <d2p1:AcPromotionPlanSchPromoMDesc>String</d2p1:AcPromotionPlanSchPromoMDesc>
      <d2p1:AcPromotionPlanSchPromoMID>String</d2p1:AcPromotionPlanSchPromoMID>
      <d2p1:AcPromotionPlanSchStockID>String</d2p1:AcPromotionPlanSchStockID>
      <d2p1:AcStockColorDesc>String</d2p1:AcStockColorDesc>
      <d2p1:AcStockColorID>String</d2p1:AcStockColorID>
      <d2p1:AcStockID>String</d2p1:AcStockID>
      <d2p1:AcStockSizeDesc>String</d2p1:AcStockSizeDesc>
      <d2p1:AcStockSizeID>String</d2p1:AcStockSizeID>
      <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
      <d2p1:DiscountAmount>0</d2p1:DiscountAmount>
      <d2p1:DiscountAmountForMember>0</d2p1:DiscountAmountForMember>
      <d2p1:EditDateStock>0001-01-01T00:00:00</d2p1:EditDateStock>
      <d2p1:POSPrice>0</d2p1:POSPrice>
      <d2p1:POSPromoPrice>0</d2p1:POSPromoPrice>
      <d2p1:PosPromoMemberPrice>0</d2p1:PosPromoMemberPrice>
      <d2p1:PromotionPlanType>String</d2p1:PromotionPlanType>
      <d2p1:PromotionPriority>0</d2p1:PromotionPriority>
      <d2p1:PromotionTimeline>String</d2p1:PromotionTimeline>
      <d2p1:SchPromoEndDate>0001-01-01T00:00:00</d2p1:SchPromoEndDate>
      <d2p1:SchPromoIsAllDayEvent>String</d2p1:SchPromoIsAllDayEvent>
      <d2p1:SchPromoStartDate>0001-01-01T00:00:00</d2p1:SchPromoStartDate>
      <d2p1:StockArticleNo>String</d2p1:StockArticleNo>
      <d2p1:StockPrice1>0</d2p1:StockPrice1>
      <d2p1:StockPrice2>0</d2p1:StockPrice2>
      <d2p1:StockPrice3>0</d2p1:StockPrice3>
      <d2p1:StockPrice4>0</d2p1:StockPrice4>
      <d2p1:StockPrice5>0</d2p1:StockPrice5>
    </d2p1:pfapi70040GetPromotionPlanStockByLocationListing>
  </PromotionPlanStockByLocationListing>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PromotionPlanStockByLocationListingResponse>