POST api/saveSubscriptionFree

Request Information

URI Parameters

None.

Body Parameters

transactionSubscriptionRequest
NameDescriptionTypeAdditional information
transactionID

string

None.

transactionRefID

string

None.

memberID

string

None.

staffNo

string

None.

terminalNo

string

None.

branchNo

string

None.

branchName

string

None.

serviceType

string

None.

channel

string

None.

paymentType

string

None.

paymentTypeOthers

string

None.

status

string

None.

isBasePriceVatIncluded

boolean

None.

vatPercent

decimal number

None.

vatSatangs

integer

None.

useExternalPromotion

boolean

None.

deliveryFeeSatangs

integer

None.

extDiscounts

Collection of extDiscounts

None.

extCashVouchers

Collection of extCashVouchers

None.

serviceChargePercent

decimal number

None.

serviceChargeSatangs

integer

None.

type

string

None.

lineItems

Collection of lineItems

None.

coupons

Collection of coupons

None.

promotions

Collection of promotions

None.

deliveryFeeAppliedCrmDiscounts

Collection of deliveryFeeAppliedCrmDiscounts

None.

crmDiscounts

Collection of crmDiscounts

None.

crmCashVouchers

Collection of crmCashVouchers

None.

basePriceTotalSatangs

integer

None.

extDiscountTotalSatangs

integer

None.

crmDiscountTotalSatangs

integer

None.

discountTotalSatangs

integer

None.

depositDiscountTotalSatangs

integer

None.

subTotalSatangs

integer

None.

totalSatangs

integer

None.

extCashVoucherTotalSatangs

integer

None.

crmCashVoucherTotalSatangs

integer

None.

cashVoucherTotalSatangs

integer

None.

totalDueSatangs

integer

None.

pointsEarned

integer

None.

pointExpirations

Collection of pointExpirations

None.

pointsRedeemed

integer

None.

committedAt

string

None.

voidedAt

string

None.

voidedByStaffNo

string

None.

voidedByTerminalNo

string

None.

voidReason

string

None.

Request Formats

application/json, text/json

Sample:
{
  "transactionID": "sample string 1",
  "transactionRefID": "sample string 2",
  "memberID": "sample string 3",
  "staffNo": "sample string 4",
  "terminalNo": "sample string 5",
  "branchNo": "sample string 6",
  "branchName": "sample string 7",
  "serviceType": "sample string 8",
  "channel": "sample string 9",
  "paymentType": "sample string 10",
  "paymentTypeOthers": "sample string 11",
  "status": "sample string 12",
  "isBasePriceVatIncluded": true,
  "vatPercent": 1.0,
  "vatSatangs": 1,
  "useExternalPromotion": true,
  "deliveryFeeSatangs": 1,
  "extDiscounts": [
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "nameTh": "sample string 6",
      "nameEn": "sample string 7",
      "totalSatangs": 1,
      "type": "sample string 8",
      "fixedPercentage": 1.0,
      "fixedAmountSatangs": 1,
      "scope": "sample string 9"
    },
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "nameTh": "sample string 6",
      "nameEn": "sample string 7",
      "totalSatangs": 1,
      "type": "sample string 8",
      "fixedPercentage": 1.0,
      "fixedAmountSatangs": 1,
      "scope": "sample string 9"
    }
  ],
  "extCashVouchers": [
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "totalSatangs": 1
    },
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "totalSatangs": 1
    }
  ],
  "serviceChargePercent": 1.0,
  "serviceChargeSatangs": 1,
  "type": "sample string 15",
  "lineItems": [
    {
      "seq": 1,
      "sku": "sample string 1",
      "productName": "sample string 2",
      "productCategoryId": "sample string 3",
      "productCategoryName": "sample string 4",
      "baseUnitPriceSatangs": 1,
      "quantity": 1,
      "childLineItems": [
        {
          "sku": "sample string 1",
          "productName": "sample string 2",
          "productCategoryId": "sample string 3",
          "productCategoryName": "sample string 4",
          "baseUnitPriceSatangs": 1,
          "quantity": 1
        },
        {
          "sku": "sample string 1",
          "productName": "sample string 2",
          "productCategoryId": "sample string 3",
          "productCategoryName": "sample string 4",
          "baseUnitPriceSatangs": 1,
          "quantity": 1
        }
      ],
      "quantityForCrmDiscount": 1,
      "appliedCrmDiscounts": [
        {
          "quantity": 1,
          "totalSatangs": 1
        },
        {
          "quantity": 1,
          "totalSatangs": 1
        }
      ],
      "appliedExtDiscountTotalSatangs": 1,
      "appliedCrmDiscountTotalSatangs": 1,
      "discountTotalSatangs": 1,
      "subTotalSatangs": 1,
      "extPromotionID": "sample string 5",
      "priceTotalSatangs": 1
    },
    {
      "seq": 1,
      "sku": "sample string 1",
      "productName": "sample string 2",
      "productCategoryId": "sample string 3",
      "productCategoryName": "sample string 4",
      "baseUnitPriceSatangs": 1,
      "quantity": 1,
      "childLineItems": [
        {
          "sku": "sample string 1",
          "productName": "sample string 2",
          "productCategoryId": "sample string 3",
          "productCategoryName": "sample string 4",
          "baseUnitPriceSatangs": 1,
          "quantity": 1
        },
        {
          "sku": "sample string 1",
          "productName": "sample string 2",
          "productCategoryId": "sample string 3",
          "productCategoryName": "sample string 4",
          "baseUnitPriceSatangs": 1,
          "quantity": 1
        }
      ],
      "quantityForCrmDiscount": 1,
      "appliedCrmDiscounts": [
        {
          "quantity": 1,
          "totalSatangs": 1
        },
        {
          "quantity": 1,
          "totalSatangs": 1
        }
      ],
      "appliedExtDiscountTotalSatangs": 1,
      "appliedCrmDiscountTotalSatangs": 1,
      "discountTotalSatangs": 1,
      "subTotalSatangs": 1,
      "extPromotionID": "sample string 5",
      "priceTotalSatangs": 1
    }
  ],
  "coupons": [
    {
      "couponID": "sample string 1",
      "isValid": true,
      "invalidReason": "sample string 3"
    },
    {
      "couponID": "sample string 1",
      "isValid": true,
      "invalidReason": "sample string 3"
    }
  ],
  "promotions": [
    {
      "promotionID": "sample string 1",
      "quantity": "sample string 2",
      "isValid": "sample string 3",
      "invalidReason": "sample string 4"
    },
    {
      "promotionID": "sample string 1",
      "quantity": "sample string 2",
      "isValid": "sample string 3",
      "invalidReason": "sample string 4"
    }
  ],
  "deliveryFeeAppliedCrmDiscounts": [
    {
      "quantity": 1,
      "totalSatangs": 1
    },
    {
      "quantity": 1,
      "totalSatangs": 1
    }
  ],
  "crmDiscounts": [
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "nameTh": "sample string 6",
      "nameEn": "sample string 7",
      "totalSatangs": 1,
      "type": "sample string 8",
      "fixedPercentage": 1.0,
      "fixedAmountSatangs": 1,
      "scope": "sample string 9"
    },
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "nameTh": "sample string 6",
      "nameEn": "sample string 7",
      "totalSatangs": 1,
      "type": "sample string 8",
      "fixedPercentage": 1.0,
      "fixedAmountSatangs": 1,
      "scope": "sample string 9"
    }
  ],
  "crmCashVouchers": [
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "totalSatangs": 1
    },
    {
      "source": "sample string 1",
      "promotionID": "sample string 2",
      "couponID": "sample string 3",
      "extPromotionID": "sample string 4",
      "extCouponID": "sample string 5",
      "totalSatangs": 1
    }
  ],
  "basePriceTotalSatangs": 1,
  "extDiscountTotalSatangs": 1,
  "crmDiscountTotalSatangs": 1,
  "discountTotalSatangs": 1,
  "depositDiscountTotalSatangs": 1,
  "subTotalSatangs": 1,
  "totalSatangs": 1,
  "extCashVoucherTotalSatangs": 1,
  "crmCashVoucherTotalSatangs": 1,
  "cashVoucherTotalSatangs": 1,
  "totalDueSatangs": 1,
  "pointsEarned": 1,
  "pointExpirations": [
    {
      "points": "sample string 1",
      "expirationDate": "sample string 2"
    },
    {
      "points": "sample string 1",
      "expirationDate": "sample string 2"
    }
  ],
  "pointsRedeemed": 1,
  "committedAt": "sample string 16",
  "voidedAt": "sample string 17",
  "voidedByStaffNo": "sample string 18",
  "voidedByTerminalNo": "sample string 19",
  "voidReason": "sample string 20"
}

application/xml, text/xml

Sample:
<transactionSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VentilatorAPI.HTTP.Request">
  <basePriceTotalSatangs>1</basePriceTotalSatangs>
  <branchName>sample string 7</branchName>
  <branchNo>sample string 6</branchNo>
  <cashVoucherTotalSatangs>1</cashVoucherTotalSatangs>
  <channel>sample string 9</channel>
  <committedAt>sample string 16</committedAt>
  <coupons>
    <coupons>
      <couponID>sample string 1</couponID>
      <invalidReason>sample string 3</invalidReason>
      <isValid>true</isValid>
    </coupons>
    <coupons>
      <couponID>sample string 1</couponID>
      <invalidReason>sample string 3</invalidReason>
      <isValid>true</isValid>
    </coupons>
  </coupons>
  <crmCashVoucherTotalSatangs>1</crmCashVoucherTotalSatangs>
  <crmCashVouchers>
    <crmCashVouchers>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <promotionID>sample string 2</promotionID>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
    </crmCashVouchers>
    <crmCashVouchers>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <promotionID>sample string 2</promotionID>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
    </crmCashVouchers>
  </crmCashVouchers>
  <crmDiscountTotalSatangs>1</crmDiscountTotalSatangs>
  <crmDiscounts>
    <crmDiscounts>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <fixedAmountSatangs>1</fixedAmountSatangs>
      <fixedPercentage>1</fixedPercentage>
      <nameEn>sample string 7</nameEn>
      <nameTh>sample string 6</nameTh>
      <promotionID>sample string 2</promotionID>
      <scope>sample string 9</scope>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
      <type>sample string 8</type>
    </crmDiscounts>
    <crmDiscounts>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <fixedAmountSatangs>1</fixedAmountSatangs>
      <fixedPercentage>1</fixedPercentage>
      <nameEn>sample string 7</nameEn>
      <nameTh>sample string 6</nameTh>
      <promotionID>sample string 2</promotionID>
      <scope>sample string 9</scope>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
      <type>sample string 8</type>
    </crmDiscounts>
  </crmDiscounts>
  <deliveryFeeAppliedCrmDiscounts>
    <deliveryFeeAppliedCrmDiscounts>
      <quantity>1</quantity>
      <totalSatangs>1</totalSatangs>
    </deliveryFeeAppliedCrmDiscounts>
    <deliveryFeeAppliedCrmDiscounts>
      <quantity>1</quantity>
      <totalSatangs>1</totalSatangs>
    </deliveryFeeAppliedCrmDiscounts>
  </deliveryFeeAppliedCrmDiscounts>
  <deliveryFeeSatangs>1</deliveryFeeSatangs>
  <depositDiscountTotalSatangs>1</depositDiscountTotalSatangs>
  <discountTotalSatangs>1</discountTotalSatangs>
  <extCashVoucherTotalSatangs>1</extCashVoucherTotalSatangs>
  <extCashVouchers>
    <extCashVouchers>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <promotionID>sample string 2</promotionID>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
    </extCashVouchers>
    <extCashVouchers>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <promotionID>sample string 2</promotionID>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
    </extCashVouchers>
  </extCashVouchers>
  <extDiscountTotalSatangs>1</extDiscountTotalSatangs>
  <extDiscounts>
    <extDiscounts>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <fixedAmountSatangs>1</fixedAmountSatangs>
      <fixedPercentage>1</fixedPercentage>
      <nameEn>sample string 7</nameEn>
      <nameTh>sample string 6</nameTh>
      <promotionID>sample string 2</promotionID>
      <scope>sample string 9</scope>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
      <type>sample string 8</type>
    </extDiscounts>
    <extDiscounts>
      <couponID>sample string 3</couponID>
      <extCouponID>sample string 5</extCouponID>
      <extPromotionID>sample string 4</extPromotionID>
      <fixedAmountSatangs>1</fixedAmountSatangs>
      <fixedPercentage>1</fixedPercentage>
      <nameEn>sample string 7</nameEn>
      <nameTh>sample string 6</nameTh>
      <promotionID>sample string 2</promotionID>
      <scope>sample string 9</scope>
      <source>sample string 1</source>
      <totalSatangs>1</totalSatangs>
      <type>sample string 8</type>
    </extDiscounts>
  </extDiscounts>
  <isBasePriceVatIncluded>true</isBasePriceVatIncluded>
  <lineItems>
    <lineItems>
      <appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
      <appliedCrmDiscounts>
        <appliedCrmDiscounts>
          <quantity>1</quantity>
          <totalSatangs>1</totalSatangs>
        </appliedCrmDiscounts>
        <appliedCrmDiscounts>
          <quantity>1</quantity>
          <totalSatangs>1</totalSatangs>
        </appliedCrmDiscounts>
      </appliedCrmDiscounts>
      <appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
      <baseUnitPriceSatangs>1</baseUnitPriceSatangs>
      <childLineItems>
        <childLineItems>
          <baseUnitPriceSatangs>1</baseUnitPriceSatangs>
          <productCategoryId>sample string 3</productCategoryId>
          <productCategoryName>sample string 4</productCategoryName>
          <productName>sample string 2</productName>
          <quantity>1</quantity>
          <sku>sample string 1</sku>
        </childLineItems>
        <childLineItems>
          <baseUnitPriceSatangs>1</baseUnitPriceSatangs>
          <productCategoryId>sample string 3</productCategoryId>
          <productCategoryName>sample string 4</productCategoryName>
          <productName>sample string 2</productName>
          <quantity>1</quantity>
          <sku>sample string 1</sku>
        </childLineItems>
      </childLineItems>
      <discountTotalSatangs>1</discountTotalSatangs>
      <extPromotionID>sample string 5</extPromotionID>
      <priceTotalSatangs>1</priceTotalSatangs>
      <productCategoryId>sample string 3</productCategoryId>
      <productCategoryName>sample string 4</productCategoryName>
      <productName>sample string 2</productName>
      <quantity>1</quantity>
      <quantityForCrmDiscount>1</quantityForCrmDiscount>
      <seq>1</seq>
      <sku>sample string 1</sku>
      <subTotalSatangs>1</subTotalSatangs>
    </lineItems>
    <lineItems>
      <appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
      <appliedCrmDiscounts>
        <appliedCrmDiscounts>
          <quantity>1</quantity>
          <totalSatangs>1</totalSatangs>
        </appliedCrmDiscounts>
        <appliedCrmDiscounts>
          <quantity>1</quantity>
          <totalSatangs>1</totalSatangs>
        </appliedCrmDiscounts>
      </appliedCrmDiscounts>
      <appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
      <baseUnitPriceSatangs>1</baseUnitPriceSatangs>
      <childLineItems>
        <childLineItems>
          <baseUnitPriceSatangs>1</baseUnitPriceSatangs>
          <productCategoryId>sample string 3</productCategoryId>
          <productCategoryName>sample string 4</productCategoryName>
          <productName>sample string 2</productName>
          <quantity>1</quantity>
          <sku>sample string 1</sku>
        </childLineItems>
        <childLineItems>
          <baseUnitPriceSatangs>1</baseUnitPriceSatangs>
          <productCategoryId>sample string 3</productCategoryId>
          <productCategoryName>sample string 4</productCategoryName>
          <productName>sample string 2</productName>
          <quantity>1</quantity>
          <sku>sample string 1</sku>
        </childLineItems>
      </childLineItems>
      <discountTotalSatangs>1</discountTotalSatangs>
      <extPromotionID>sample string 5</extPromotionID>
      <priceTotalSatangs>1</priceTotalSatangs>
      <productCategoryId>sample string 3</productCategoryId>
      <productCategoryName>sample string 4</productCategoryName>
      <productName>sample string 2</productName>
      <quantity>1</quantity>
      <quantityForCrmDiscount>1</quantityForCrmDiscount>
      <seq>1</seq>
      <sku>sample string 1</sku>
      <subTotalSatangs>1</subTotalSatangs>
    </lineItems>
  </lineItems>
  <memberID>sample string 3</memberID>
  <paymentType>sample string 10</paymentType>
  <paymentTypeOthers>sample string 11</paymentTypeOthers>
  <pointExpirations>
    <pointExpirations>
      <expirationDate>sample string 2</expirationDate>
      <points>sample string 1</points>
    </pointExpirations>
    <pointExpirations>
      <expirationDate>sample string 2</expirationDate>
      <points>sample string 1</points>
    </pointExpirations>
  </pointExpirations>
  <pointsEarned>1</pointsEarned>
  <pointsRedeemed>1</pointsRedeemed>
  <promotions>
    <promotions>
      <invalidReason>sample string 4</invalidReason>
      <isValid>sample string 3</isValid>
      <promotionID>sample string 1</promotionID>
      <quantity>sample string 2</quantity>
    </promotions>
    <promotions>
      <invalidReason>sample string 4</invalidReason>
      <isValid>sample string 3</isValid>
      <promotionID>sample string 1</promotionID>
      <quantity>sample string 2</quantity>
    </promotions>
  </promotions>
  <serviceChargePercent>1</serviceChargePercent>
  <serviceChargeSatangs>1</serviceChargeSatangs>
  <serviceType>sample string 8</serviceType>
  <staffNo>sample string 4</staffNo>
  <status>sample string 12</status>
  <subTotalSatangs>1</subTotalSatangs>
  <terminalNo>sample string 5</terminalNo>
  <totalDueSatangs>1</totalDueSatangs>
  <totalSatangs>1</totalSatangs>
  <transactionID>sample string 1</transactionID>
  <transactionRefID>sample string 2</transactionRefID>
  <type>sample string 15</type>
  <useExternalPromotion>true</useExternalPromotion>
  <vatPercent>1</vatPercent>
  <vatSatangs>1</vatSatangs>
  <voidReason>sample string 20</voidReason>
  <voidedAt>sample string 17</voidedAt>
  <voidedByStaffNo>sample string 18</voidedByStaffNo>
  <voidedByTerminalNo>sample string 19</voidedByTerminalNo>
</transactionSubscriptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.