GET api/Promotion/GetPromotionForUser?oid={oid}

Request Information

URI Parameters

Name	Description	Type	Additional information
oid		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ApiPromotionData

Name	Type	Additional information
Code	string	None.
PromotionOid	globally unique identifier	None.
Name	string	None.
Description	string	None.
GiftCode	string	None.
GiftType	SalesPromotionOrderValueGiftType	None.
PromotionTypeName	string	None.
ValidFrom	date	None.
ValidTo	date	None.
DeliveringType	POSDeliveringType	None.
RepresentationImageUrl	string	None.
DetailTemplateImageUrl	string	None.
TermsOfUse	string	None.
DetailDescription	string	None.
Duration	unsigned integer	None.
ApplyingFranchises	Collection of ApiSalePlaceModel	None.
KCoffeeBannerImageUrl	string	None.
KCoffeeDetailImageUrl	string	None.
KCoffeeRepresentationImageUrl	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Code": "sample string 1",
    "PromotionOid": "8f3d9893-514b-46dc-99dc-50e328843253",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "GiftCode": "sample string 5",
    "GiftType": 0,
    "PromotionTypeName": "sample string 6",
    "ValidFrom": "2026-01-21T18:49:52.3631646+07:00",
    "ValidTo": "2026-01-21T18:49:52.3631646+07:00",
    "DeliveringType": 0,
    "RepresentationImageUrl": "sample string 9",
    "DetailTemplateImageUrl": "sample string 10",
    "TermsOfUse": "sample string 11",
    "DetailDescription": "sample string 12",
    "Duration": 13,
    "ApplyingFranchises": [
      {
        "Code": "sample string 1",
        "RefOid": "sample string 2",
        "Name": "sample string 3",
        "Address": "sample string 4",
        "Phone": "sample string 5",
        "ActivityRangeInKm": 6.0,
        "IsDefaultTenant": true
      },
      {
        "Code": "sample string 1",
        "RefOid": "sample string 2",
        "Name": "sample string 3",
        "Address": "sample string 4",
        "Phone": "sample string 5",
        "ActivityRangeInKm": 6.0,
        "IsDefaultTenant": true
      }
    ],
    "KCoffeeBannerImageUrl": "sample string 14",
    "KCoffeeDetailImageUrl": "sample string 15",
    "KCoffeeRepresentationImageUrl": "sample string 16"
  },
  {
    "Code": "sample string 1",
    "PromotionOid": "8f3d9893-514b-46dc-99dc-50e328843253",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "GiftCode": "sample string 5",
    "GiftType": 0,
    "PromotionTypeName": "sample string 6",
    "ValidFrom": "2026-01-21T18:49:52.3631646+07:00",
    "ValidTo": "2026-01-21T18:49:52.3631646+07:00",
    "DeliveringType": 0,
    "RepresentationImageUrl": "sample string 9",
    "DetailTemplateImageUrl": "sample string 10",
    "TermsOfUse": "sample string 11",
    "DetailDescription": "sample string 12",
    "Duration": 13,
    "ApplyingFranchises": [
      {
        "Code": "sample string 1",
        "RefOid": "sample string 2",
        "Name": "sample string 3",
        "Address": "sample string 4",
        "Phone": "sample string 5",
        "ActivityRangeInKm": 6.0,
        "IsDefaultTenant": true
      },
      {
        "Code": "sample string 1",
        "RefOid": "sample string 2",
        "Name": "sample string 3",
        "Address": "sample string 4",
        "Phone": "sample string 5",
        "ActivityRangeInKm": 6.0,
        "IsDefaultTenant": true
      }
    ],
    "KCoffeeBannerImageUrl": "sample string 14",
    "KCoffeeDetailImageUrl": "sample string 15",
    "KCoffeeRepresentationImageUrl": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiPromotionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NASDMS.KCoffeeMobile.Api.Models.Promotion">
  <ApiPromotionData>
    <ApplyingFranchises xmlns:d3p1="http://schemas.datacontract.org/2004/07/NASDMS.KCoffeeMobile.Api.Models.SalePlaceModels">
      <d3p1:ApiSalePlaceModel>
        <d3p1:ActivityRangeInKm>6</d3p1:ActivityRangeInKm>
        <d3p1:Address>sample string 4</d3p1:Address>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:IsDefaultTenant>true</d3p1:IsDefaultTenant>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Phone>sample string 5</d3p1:Phone>
        <d3p1:RefOid>sample string 2</d3p1:RefOid>
      </d3p1:ApiSalePlaceModel>
      <d3p1:ApiSalePlaceModel>
        <d3p1:ActivityRangeInKm>6</d3p1:ActivityRangeInKm>
        <d3p1:Address>sample string 4</d3p1:Address>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:IsDefaultTenant>true</d3p1:IsDefaultTenant>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Phone>sample string 5</d3p1:Phone>
        <d3p1:RefOid>sample string 2</d3p1:RefOid>
      </d3p1:ApiSalePlaceModel>
    </ApplyingFranchises>
    <Code>sample string 1</Code>
    <DeliveringType>NA</DeliveringType>
    <Description>sample string 4</Description>
    <DetailDescription>sample string 12</DetailDescription>
    <DetailTemplateImageUrl>sample string 10</DetailTemplateImageUrl>
    <Duration>13</Duration>
    <GiftCode>sample string 5</GiftCode>
    <GiftType>DiscountFromOrderAmount</GiftType>
    <KCoffeeBannerImageUrl>sample string 14</KCoffeeBannerImageUrl>
    <KCoffeeDetailImageUrl>sample string 15</KCoffeeDetailImageUrl>
    <KCoffeeRepresentationImageUrl>sample string 16</KCoffeeRepresentationImageUrl>
    <Name>sample string 3</Name>
    <PromotionOid>8f3d9893-514b-46dc-99dc-50e328843253</PromotionOid>
    <PromotionTypeName>sample string 6</PromotionTypeName>
    <RepresentationImageUrl>sample string 9</RepresentationImageUrl>
    <TermsOfUse>sample string 11</TermsOfUse>
    <ValidFrom>2026-01-21T18:49:52.3631646+07:00</ValidFrom>
    <ValidTo>2026-01-21T18:49:52.3631646+07:00</ValidTo>
  </ApiPromotionData>
  <ApiPromotionData>
    <ApplyingFranchises xmlns:d3p1="http://schemas.datacontract.org/2004/07/NASDMS.KCoffeeMobile.Api.Models.SalePlaceModels">
      <d3p1:ApiSalePlaceModel>
        <d3p1:ActivityRangeInKm>6</d3p1:ActivityRangeInKm>
        <d3p1:Address>sample string 4</d3p1:Address>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:IsDefaultTenant>true</d3p1:IsDefaultTenant>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Phone>sample string 5</d3p1:Phone>
        <d3p1:RefOid>sample string 2</d3p1:RefOid>
      </d3p1:ApiSalePlaceModel>
      <d3p1:ApiSalePlaceModel>
        <d3p1:ActivityRangeInKm>6</d3p1:ActivityRangeInKm>
        <d3p1:Address>sample string 4</d3p1:Address>
        <d3p1:Code>sample string 1</d3p1:Code>
        <d3p1:IsDefaultTenant>true</d3p1:IsDefaultTenant>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Phone>sample string 5</d3p1:Phone>
        <d3p1:RefOid>sample string 2</d3p1:RefOid>
      </d3p1:ApiSalePlaceModel>
    </ApplyingFranchises>
    <Code>sample string 1</Code>
    <DeliveringType>NA</DeliveringType>
    <Description>sample string 4</Description>
    <DetailDescription>sample string 12</DetailDescription>
    <DetailTemplateImageUrl>sample string 10</DetailTemplateImageUrl>
    <Duration>13</Duration>
    <GiftCode>sample string 5</GiftCode>
    <GiftType>DiscountFromOrderAmount</GiftType>
    <KCoffeeBannerImageUrl>sample string 14</KCoffeeBannerImageUrl>
    <KCoffeeDetailImageUrl>sample string 15</KCoffeeDetailImageUrl>
    <KCoffeeRepresentationImageUrl>sample string 16</KCoffeeRepresentationImageUrl>
    <Name>sample string 3</Name>
    <PromotionOid>8f3d9893-514b-46dc-99dc-50e328843253</PromotionOid>
    <PromotionTypeName>sample string 6</PromotionTypeName>
    <RepresentationImageUrl>sample string 9</RepresentationImageUrl>
    <TermsOfUse>sample string 11</TermsOfUse>
    <ValidFrom>2026-01-21T18:49:52.3631646+07:00</ValidFrom>
    <ValidTo>2026-01-21T18:49:52.3631646+07:00</ValidTo>
  </ApiPromotionData>
</ArrayOfApiPromotionData>