GET api/Order/GetCouponByCode?strCouponCode={strCouponCode}&orderId={orderId}&isGetMembership={isGetMembership}&companyCode={companyCode}&branchID={branchID}

Request Information

URI Parameters

Name	Type	Additional information
strCouponCode	string	Required
orderId	globally unique identifier	Required
isGetMembership	boolean	Required
companyCode	string	Required
branchID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

GraphAPIResultOfCouponInfo

Name	Type	Additional information
Data	CouponInfo	None.
Success	boolean	None.
ErrorMessage	string	None.
ErrorType	GraphAPIErrorType	None.
Total	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "CouponCodeId": 1,
    "CouponCode": "sample string 2",
    "CouponType": 1,
    "CouponStatus": 1,
    "CouponName": "sample string 3",
    "DiscountType": 4,
    "DiscountPercent": 5.0,
    "DiscountAmount": 6.0,
    "ApplyFromDate": "2025-06-25T22:11:17.9419417+07:00",
    "ApplyToDate": "2025-06-25T22:11:17.9419417+07:00",
    "ApplyCondition": "sample string 7",
    "IsUnlimitedApply": true,
    "ApplyFor": "sample string 9",
    "CouponCodeTimeout": 1,
    "MemberShipInfoObj": {
      "MembershipId": 1,
      "MembershipCode": "sample string 1",
      "FullName": "sample string 2",
      "PhoneNumber": "sample string 3",
      "NormalizedPhoneNumber": "sample string 4",
      "Address": "sample string 5",
      "BirthDate": "2025-06-25T22:11:17.9419417+07:00",
      "MembershipCardId": 1,
      "MembershipCardName": "sample string 6",
      "HasAddPointPolicy": true,
      "AvailablePoint": 8,
      "PreferentialType": 1,
      "PreferentialPoint": 1,
      "PreferentialAmount": 1.0,
      "PreferentialRate": 1.0,
      "Email": "sample string 9",
      "CUKCUKMemberLevelID": "c9ddc90b-2fda-4ad6-8df3-64a4819ab89a",
      "MemberCardNo": "sample string 10",
      "AddPointType": 0,
      "ApplyFrom": "2025-06-25T22:11:17.9419417+07:00",
      "SpecialApplyFrom": "2025-06-25T22:11:17.9419417+07:00",
      "SpecialApplyTo": "2025-06-25T22:11:17.9419417+07:00",
      "SpecialApplyDay": "sample string 11",
      "SpecialTimeFrom": 1,
      "SpecialTimeTo": 1
    },
    "ApplyDay": "sample string 10",
    "DayExclude": "sample string 11",
    "FromTime": 1,
    "ToTime": 1,
    "IsLimitCoupon": true,
    "IsRestaurantEnterCoupon": true,
    "NumberLimitCoupon": 1,
    "NumberUseInDay": 1,
    "DiscountMax": 12.0,
    "ApplyForRecipient": true,
    "HideCodeForCashier": true,
    "PromotionGiftName": "sample string 15",
    "PromotionCukCukId": "1cff00af-9708-4428-8606-b87e0745d990",
    "MinInvoiceValue": 16.0,
    "OrderApply": 17,
    "ApplyType": 18,
    "ScopeApply": 19,
    "AllowApplyToBranch": true,
    "OriginalId": "3fdb08b5-a52f-4ab9-83fe-cb8ac58a726b"
  },
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ErrorType": 0,
  "Total": 3
}

text/html

Sample:

{
  "Data": {
    "CouponCodeId": 1,
    "CouponCode": "sample string 2",
    "CouponType": 1,
    "CouponStatus": 1,
    "CouponName": "sample string 3",
    "DiscountType": 4,
    "DiscountPercent": 5.0,
    "DiscountAmount": 6.0,
    "ApplyFromDate": "2025-06-25T22:11:17.9417982+07:00",
    "ApplyToDate": "2025-06-25T22:11:17.9417982+07:00",
    "ApplyCondition": "sample string 7",
    "IsUnlimitedApply": true,
    "ApplyFor": "sample string 9",
    "CouponCodeTimeout": 1,
    "MemberShipInfoObj": {
      "MembershipId": 1,
      "MembershipCode": "sample string 1",
      "FullName": "sample string 2",
      "PhoneNumber": "sample string 3",
      "NormalizedPhoneNumber": "sample string 4",
      "Address": "sample string 5",
      "BirthDate": "2025-06-25T22:11:17.9417982+07:00",
      "MembershipCardId": 1,
      "MembershipCardName": "sample string 6",
      "HasAddPointPolicy": true,
      "AvailablePoint": 8,
      "PreferentialType": 1,
      "PreferentialPoint": 1,
      "PreferentialAmount": 1.0,
      "PreferentialRate": 1.0,
      "Email": "sample string 9",
      "CUKCUKMemberLevelID": "c9ddc90b-2fda-4ad6-8df3-64a4819ab89a",
      "MemberCardNo": "sample string 10",
      "AddPointType": 0,
      "ApplyFrom": "2025-06-25T22:11:17.9417982+07:00",
      "SpecialApplyFrom": "2025-06-25T22:11:17.9417982+07:00",
      "SpecialApplyTo": "2025-06-25T22:11:17.9417982+07:00",
      "SpecialApplyDay": "sample string 11",
      "SpecialTimeFrom": 1,
      "SpecialTimeTo": 1
    },
    "ApplyDay": "sample string 10",
    "DayExclude": "sample string 11",
    "FromTime": 1,
    "ToTime": 1,
    "IsLimitCoupon": true,
    "IsRestaurantEnterCoupon": true,
    "NumberLimitCoupon": 1,
    "NumberUseInDay": 1,
    "DiscountMax": 12.0,
    "ApplyForRecipient": true,
    "HideCodeForCashier": true,
    "PromotionGiftName": "sample string 15",
    "PromotionCukCukId": "1cff00af-9708-4428-8606-b87e0745d990",
    "MinInvoiceValue": 16.0,
    "OrderApply": 17,
    "ApplyType": 18,
    "ScopeApply": 19,
    "AllowApplyToBranch": true,
    "OriginalId": "3fdb08b5-a52f-4ab9-83fe-cb8ac58a726b"
  },
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ErrorType": 0,
  "Total": 3
}

application/xml, text/xml

Sample:

<GraphAPIResultOfCouponInfo34ouyJuR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MISA.QLNH.BE.BO">
  <ActionType>Login</ActionType>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/MISA.QLNH.BOBase">
    <d2p1:AllowApplyToBranch>true</d2p1:AllowApplyToBranch>
    <d2p1:ApplyCondition>sample string 7</d2p1:ApplyCondition>
    <d2p1:ApplyDay>sample string 10</d2p1:ApplyDay>
    <d2p1:ApplyFor>sample string 9</d2p1:ApplyFor>
    <d2p1:ApplyForRecipient>true</d2p1:ApplyForRecipient>
    <d2p1:ApplyFromDate>2025-06-25T22:11:17.9417982+07:00</d2p1:ApplyFromDate>
    <d2p1:ApplyToDate>2025-06-25T22:11:17.9417982+07:00</d2p1:ApplyToDate>
    <d2p1:ApplyType>18</d2p1:ApplyType>
    <d2p1:CouponCode>sample string 2</d2p1:CouponCode>
    <d2p1:CouponCodeId>1</d2p1:CouponCodeId>
    <d2p1:CouponCodeTimeout>1</d2p1:CouponCodeTimeout>
    <d2p1:CouponName>sample string 3</d2p1:CouponName>
    <d2p1:CouponStatus>Used</d2p1:CouponStatus>
    <d2p1:CouponType>SAInvoiceDiscount</d2p1:CouponType>
    <d2p1:DayExclude>sample string 11</d2p1:DayExclude>
    <d2p1:DiscountAmount>6</d2p1:DiscountAmount>
    <d2p1:DiscountMax>12</d2p1:DiscountMax>
    <d2p1:DiscountPercent>5</d2p1:DiscountPercent>
    <d2p1:DiscountType>4</d2p1:DiscountType>
    <d2p1:FromTime>1</d2p1:FromTime>
    <d2p1:HideCodeForCashier>true</d2p1:HideCodeForCashier>
    <d2p1:IsLimitCoupon>true</d2p1:IsLimitCoupon>
    <d2p1:IsRestaurantEnterCoupon>true</d2p1:IsRestaurantEnterCoupon>
    <d2p1:IsUnlimitedApply>true</d2p1:IsUnlimitedApply>
    <d2p1:MemberShipInfoObj>
      <d2p1:AddPointType>None</d2p1:AddPointType>
      <d2p1:Address>sample string 5</d2p1:Address>
      <d2p1:ApplyFrom>2025-06-25T22:11:17.9417982+07:00</d2p1:ApplyFrom>
      <d2p1:AvailablePoint>8</d2p1:AvailablePoint>
      <d2p1:BirthDate>2025-06-25T22:11:17.9417982+07:00</d2p1:BirthDate>
      <d2p1:CUKCUKMemberLevelID>c9ddc90b-2fda-4ad6-8df3-64a4819ab89a</d2p1:CUKCUKMemberLevelID>
      <d2p1:Email>sample string 9</d2p1:Email>
      <d2p1:FullName>sample string 2</d2p1:FullName>
      <d2p1:HasAddPointPolicy>true</d2p1:HasAddPointPolicy>
      <d2p1:MemberCardNo>sample string 10</d2p1:MemberCardNo>
      <d2p1:MembershipCardId>1</d2p1:MembershipCardId>
      <d2p1:MembershipCardName>sample string 6</d2p1:MembershipCardName>
      <d2p1:MembershipCode>sample string 1</d2p1:MembershipCode>
      <d2p1:MembershipId>1</d2p1:MembershipId>
      <d2p1:NormalizedPhoneNumber>sample string 4</d2p1:NormalizedPhoneNumber>
      <d2p1:PhoneNumber>sample string 3</d2p1:PhoneNumber>
      <d2p1:PreferentialAmount>1</d2p1:PreferentialAmount>
      <d2p1:PreferentialPoint>1</d2p1:PreferentialPoint>
      <d2p1:PreferentialRate>1</d2p1:PreferentialRate>
      <d2p1:PreferentialType>1</d2p1:PreferentialType>
      <d2p1:SpecialApplyDay>sample string 11</d2p1:SpecialApplyDay>
      <d2p1:SpecialApplyFrom>2025-06-25T22:11:17.9417982+07:00</d2p1:SpecialApplyFrom>
      <d2p1:SpecialApplyTo>2025-06-25T22:11:17.9417982+07:00</d2p1:SpecialApplyTo>
      <d2p1:SpecialTimeFrom>1</d2p1:SpecialTimeFrom>
      <d2p1:SpecialTimeTo>1</d2p1:SpecialTimeTo>
    </d2p1:MemberShipInfoObj>
    <d2p1:MinInvoiceValue>16</d2p1:MinInvoiceValue>
    <d2p1:NumberLimitCoupon>1</d2p1:NumberLimitCoupon>
    <d2p1:NumberUseInDay>1</d2p1:NumberUseInDay>
    <d2p1:OrderApply>17</d2p1:OrderApply>
    <d2p1:OriginalId>3fdb08b5-a52f-4ab9-83fe-cb8ac58a726b</d2p1:OriginalId>
    <d2p1:PromotionCukCukId>1cff00af-9708-4428-8606-b87e0745d990</d2p1:PromotionCukCukId>
    <d2p1:PromotionGiftName>sample string 15</d2p1:PromotionGiftName>
    <d2p1:ScopeApply>19</d2p1:ScopeApply>
    <d2p1:ToTime>1</d2p1:ToTime>
  </Data>
  <ErrorMessage>sample string 2</ErrorMessage>
  <ErrorType>None</ErrorType>
  <Success>true</Success>
  <Total>3</Total>
</GraphAPIResultOfCouponInfo34ouyJuR>