GET api/General/Offer/GetOfferByID?Id={Id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Id

string

Required

Body Parameters

None.

Response Information

Resource Description

utblOfferDetail
NameDescriptionTypeAdditional information
CouponID

string

None.

Title

string

Required

String length: inclusive between 0 and 50

Description

string

Required

String length: inclusive between 0 and 100

LongDesc

string

None.

OfferCode

string

Required

String length: inclusive between 0 and 20

OfferPercent

integer

None.

OfferMaxAmt

decimal number

Required

MinTransAmt

decimal number

Required

OfferType

string

Required

ValidFrom

date

Required

ValidUpto

date

Required

IsCustomerSpecific

boolean

None.

OfferedByPartner

boolean

None.

AutoApply

boolean

None.

PartnerID

string

None.

CouponType

string

Required

ApplicableFor

string

Required

DailyLimit

integer

None.

UserID

string

Required

TransDate

date

Required

BudgetAmount

decimal number

None.

BudgetUsedAmount

decimal number

None.

TimeSlots

Collection of OfferTimeSlots

None.

CustList

Collection of string

None.

Customers

Collection of CustomerInOffer

None.

Response Formats

application/json, text/json

Sample:
{
  "CouponID": "sample string 1",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "LongDesc": "sample string 4",
  "OfferCode": "sample string 5",
  "OfferPercent": 1,
  "OfferMaxAmt": 6.0,
  "MinTransAmt": 7.0,
  "OfferType": "sample string 8",
  "ValidFrom": "2025-12-07T10:00:58.0581475+05:30",
  "ValidUpto": "2025-12-07T10:00:58.0581475+05:30",
  "IsCustomerSpecific": true,
  "OfferedByPartner": true,
  "AutoApply": true,
  "PartnerID": "sample string 14",
  "CouponType": "sample string 15",
  "ApplicableFor": "sample string 16",
  "DailyLimit": 1,
  "UserID": "sample string 17",
  "TransDate": "2025-12-07T10:00:58.0581475+05:30",
  "BudgetAmount": 1.0,
  "BudgetUsedAmount": 1.0,
  "TimeSlots": [
    {
      "DayNo": 1,
      "DayName": "sample string 2",
      "OpeningTime": "sample string 3",
      "ClosingTime": "sample string 4",
      "IsSelected": true
    },
    {
      "DayNo": 1,
      "DayName": "sample string 2",
      "OpeningTime": "sample string 3",
      "ClosingTime": "sample string 4",
      "IsSelected": true
    }
  ],
  "CustList": [
    "sample string 1",
    "sample string 2"
  ],
  "Customers": [
    {
      "CustomerID": "sample string 1",
      "CustomerName": "sample string 2"
    },
    {
      "CustomerID": "sample string 1",
      "CustomerName": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<utblOfferDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/General.Operations.Models">
  <ApplicableFor>sample string 16</ApplicableFor>
  <AutoApply>true</AutoApply>
  <BudgetAmount>1</BudgetAmount>
  <BudgetUsedAmount>1</BudgetUsedAmount>
  <CouponID>sample string 1</CouponID>
  <CouponType>sample string 15</CouponType>
  <CustList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CustList>
  <Customers>
    <CustomerInOffer>
      <CustomerID>sample string 1</CustomerID>
      <CustomerName>sample string 2</CustomerName>
    </CustomerInOffer>
    <CustomerInOffer>
      <CustomerID>sample string 1</CustomerID>
      <CustomerName>sample string 2</CustomerName>
    </CustomerInOffer>
  </Customers>
  <DailyLimit>1</DailyLimit>
  <Description>sample string 3</Description>
  <IsCustomerSpecific>true</IsCustomerSpecific>
  <LongDesc>sample string 4</LongDesc>
  <MinTransAmt>7</MinTransAmt>
  <OfferCode>sample string 5</OfferCode>
  <OfferMaxAmt>6</OfferMaxAmt>
  <OfferPercent>1</OfferPercent>
  <OfferType>sample string 8</OfferType>
  <OfferedByPartner>true</OfferedByPartner>
  <PartnerID>sample string 14</PartnerID>
  <TimeSlots>
    <OfferTimeSlots>
      <ClosingTime>sample string 4</ClosingTime>
      <DayName>sample string 2</DayName>
      <DayNo>1</DayNo>
      <IsSelected>true</IsSelected>
      <OpeningTime>sample string 3</OpeningTime>
    </OfferTimeSlots>
    <OfferTimeSlots>
      <ClosingTime>sample string 4</ClosingTime>
      <DayName>sample string 2</DayName>
      <DayNo>1</DayNo>
      <IsSelected>true</IsSelected>
      <OpeningTime>sample string 3</OpeningTime>
    </OfferTimeSlots>
  </TimeSlots>
  <Title>sample string 2</Title>
  <TransDate>2025-12-07T10:00:58.0581475+05:30</TransDate>
  <UserID>sample string 17</UserID>
  <ValidFrom>2025-12-07T10:00:58.0581475+05:30</ValidFrom>
  <ValidUpto>2025-12-07T10:00:58.0581475+05:30</ValidUpto>
</utblOfferDetail>