POST api/transaction/purchase/committed
Request Information
URI Parameters
None.
Body Parameters
transactionPurchaseRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| transactionDraftID | integer |
None. |
|
| transactionID | string |
None. |
|
| transactionRefID | string |
None. |
|
| orderDate | 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 | integer |
None. |
|
| vatSatangs | integer |
None. |
|
| useExternalPromotion | boolean |
None. |
|
| deliveryFeeSatangs | integer |
None. |
|
| extDiscounts | Collection of extDiscountsPurchase |
None. |
|
| extCashVouchers | Collection of extCashVouchersPurchase |
None. |
|
| serviceChargePercent | integer |
None. |
|
| serviceChargeSatangs | integer |
None. |
|
| type | string |
None. |
|
| lineItems | Collection of lineItemsPurchase |
None. |
|
| coupons | Collection of couponsPurchase |
None. |
|
| promotions | Collection of promotionsPurchase |
None. |
|
| deliveryFeeAppliedCrmDiscounts | Collection of deliveryFeeAppliedCrmDiscountsPurchase |
None. |
|
| crmDiscounts | Collection of crmDiscountsPurchase |
None. |
|
| crmCashVouchers | Collection of crmCashVouchersPurchase |
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. |
|
| remainingPoints | integer |
None. |
|
| committedAt | string |
None. |
|
| voidedAt | string |
None. |
|
| voidedByStaffNo | string |
None. |
|
| voidedByTerminalNo | string |
None. |
|
| voidReason | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"transactionDraftID": 1,
"transactionID": "sample string 1",
"transactionRefID": "sample string 2",
"orderDate": "sample string 3",
"memberID": "sample string 4",
"staffNo": "sample string 5",
"terminalNo": "sample string 6",
"branchNo": "sample string 7",
"branchName": "sample string 8",
"serviceType": "sample string 9",
"channel": "sample string 10",
"paymentType": "sample string 11",
"paymentTypeOthers": "sample string 12",
"status": "sample string 13",
"isBasePriceVatIncluded": true,
"vatPercent": 1,
"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,
"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,
"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,
"serviceChargeSatangs": 1,
"type": "sample string 16",
"lineItems": [
{
"seq": 1,
"sku": "sample string 1",
"productName": "sample string 2",
"productCategoryId": "sample string 3",
"productCategoryName": "sample string 4",
"baseUnitPriceSatangs": 1,
"quantity": 1,
"childLineItems": [
{
"seq": 1,
"sku": "sample string 1",
"productName": "sample string 2",
"productCategoryId": "sample string 3",
"productCategoryName": "sample string 4",
"baseUnitPriceSatangs": 1,
"quantity": 1
},
{
"seq": 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,
"appliedExtDiscountTotalSatangs": 1,
"appliedCrmDiscountTotalSatangs": 1,
"discountTotalSatangs": 1,
"subTotalSatangs": 1
},
{
"quantity": 1,
"totalSatangs": 1,
"appliedExtDiscountTotalSatangs": 1,
"appliedCrmDiscountTotalSatangs": 1,
"discountTotalSatangs": 1,
"subTotalSatangs": 1
}
],
"appliedExtDiscountTotalSatangs": 1,
"appliedCrmDiscountTotalSatangs": 1,
"subTotalSatangs": 1,
"extPromotionID": "sample string 5",
"discountTotalSatangs": 1,
"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": [
{
"seq": 1,
"sku": "sample string 1",
"productName": "sample string 2",
"productCategoryId": "sample string 3",
"productCategoryName": "sample string 4",
"baseUnitPriceSatangs": 1,
"quantity": 1
},
{
"seq": 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,
"appliedExtDiscountTotalSatangs": 1,
"appliedCrmDiscountTotalSatangs": 1,
"discountTotalSatangs": 1,
"subTotalSatangs": 1
},
{
"quantity": 1,
"totalSatangs": 1,
"appliedExtDiscountTotalSatangs": 1,
"appliedCrmDiscountTotalSatangs": 1,
"discountTotalSatangs": 1,
"subTotalSatangs": 1
}
],
"appliedExtDiscountTotalSatangs": 1,
"appliedCrmDiscountTotalSatangs": 1,
"subTotalSatangs": 1,
"extPromotionID": "sample string 5",
"discountTotalSatangs": 1,
"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": true,
"invalidReason": "sample string 3",
"extPromotionID": "sample string 4",
"exDiscountPromoSatangs": 1
},
{
"promotionID": "sample string 1",
"quantity": "sample string 2",
"isValid": true,
"invalidReason": "sample string 3",
"extPromotionID": "sample string 4",
"exDiscountPromoSatangs": 1
}
],
"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,
"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,
"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,
"remainingPoints": 1,
"committedAt": "sample string 17",
"voidedAt": "sample string 18",
"voidedByStaffNo": "sample string 19",
"voidedByTerminalNo": "sample string 20",
"voidReason": "sample string 21"
}
application/xml, text/xml
Sample:
<transactionPurchaseRequest 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 8</branchName>
<branchNo>sample string 7</branchNo>
<cashVoucherTotalSatangs>1</cashVoucherTotalSatangs>
<channel>sample string 10</channel>
<committedAt>sample string 17</committedAt>
<coupons>
<couponsPurchase>
<couponID>sample string 1</couponID>
<invalidReason>sample string 3</invalidReason>
<isValid>true</isValid>
</couponsPurchase>
<couponsPurchase>
<couponID>sample string 1</couponID>
<invalidReason>sample string 3</invalidReason>
<isValid>true</isValid>
</couponsPurchase>
</coupons>
<crmCashVoucherTotalSatangs>1</crmCashVoucherTotalSatangs>
<crmCashVouchers>
<crmCashVouchersPurchase>
<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>
</crmCashVouchersPurchase>
<crmCashVouchersPurchase>
<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>
</crmCashVouchersPurchase>
</crmCashVouchers>
<crmDiscountTotalSatangs>1</crmDiscountTotalSatangs>
<crmDiscounts>
<crmDiscountsPurchase>
<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>
</crmDiscountsPurchase>
<crmDiscountsPurchase>
<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>
</crmDiscountsPurchase>
</crmDiscounts>
<deliveryFeeAppliedCrmDiscounts>
<deliveryFeeAppliedCrmDiscountsPurchase>
<quantity>1</quantity>
<totalSatangs>1</totalSatangs>
</deliveryFeeAppliedCrmDiscountsPurchase>
<deliveryFeeAppliedCrmDiscountsPurchase>
<quantity>1</quantity>
<totalSatangs>1</totalSatangs>
</deliveryFeeAppliedCrmDiscountsPurchase>
</deliveryFeeAppliedCrmDiscounts>
<deliveryFeeSatangs>1</deliveryFeeSatangs>
<depositDiscountTotalSatangs>1</depositDiscountTotalSatangs>
<discountTotalSatangs>1</discountTotalSatangs>
<extCashVoucherTotalSatangs>1</extCashVoucherTotalSatangs>
<extCashVouchers>
<extCashVouchersPurchase>
<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>
</extCashVouchersPurchase>
<extCashVouchersPurchase>
<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>
</extCashVouchersPurchase>
</extCashVouchers>
<extDiscountTotalSatangs>1</extDiscountTotalSatangs>
<extDiscounts>
<extDiscountsPurchase>
<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>
</extDiscountsPurchase>
<extDiscountsPurchase>
<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>
</extDiscountsPurchase>
</extDiscounts>
<isBasePriceVatIncluded>true</isBasePriceVatIncluded>
<lineItems>
<lineItemsPurchase>
<appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
<appliedCrmDiscounts>
<appliedCrmDiscountsPurchase>
<appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
<appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
<discountTotalSatangs>1</discountTotalSatangs>
<quantity>1</quantity>
<subTotalSatangs>1</subTotalSatangs>
<totalSatangs>1</totalSatangs>
</appliedCrmDiscountsPurchase>
<appliedCrmDiscountsPurchase>
<appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
<appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
<discountTotalSatangs>1</discountTotalSatangs>
<quantity>1</quantity>
<subTotalSatangs>1</subTotalSatangs>
<totalSatangs>1</totalSatangs>
</appliedCrmDiscountsPurchase>
</appliedCrmDiscounts>
<appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
<baseUnitPriceSatangs>1</baseUnitPriceSatangs>
<childLineItems>
<childLineItemsPurchase>
<baseUnitPriceSatangs>1</baseUnitPriceSatangs>
<productCategoryId>sample string 3</productCategoryId>
<productCategoryName>sample string 4</productCategoryName>
<productName>sample string 2</productName>
<quantity>1</quantity>
<seq>1</seq>
<sku>sample string 1</sku>
</childLineItemsPurchase>
<childLineItemsPurchase>
<baseUnitPriceSatangs>1</baseUnitPriceSatangs>
<productCategoryId>sample string 3</productCategoryId>
<productCategoryName>sample string 4</productCategoryName>
<productName>sample string 2</productName>
<quantity>1</quantity>
<seq>1</seq>
<sku>sample string 1</sku>
</childLineItemsPurchase>
</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>
</lineItemsPurchase>
<lineItemsPurchase>
<appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
<appliedCrmDiscounts>
<appliedCrmDiscountsPurchase>
<appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
<appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
<discountTotalSatangs>1</discountTotalSatangs>
<quantity>1</quantity>
<subTotalSatangs>1</subTotalSatangs>
<totalSatangs>1</totalSatangs>
</appliedCrmDiscountsPurchase>
<appliedCrmDiscountsPurchase>
<appliedCrmDiscountTotalSatangs>1</appliedCrmDiscountTotalSatangs>
<appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
<discountTotalSatangs>1</discountTotalSatangs>
<quantity>1</quantity>
<subTotalSatangs>1</subTotalSatangs>
<totalSatangs>1</totalSatangs>
</appliedCrmDiscountsPurchase>
</appliedCrmDiscounts>
<appliedExtDiscountTotalSatangs>1</appliedExtDiscountTotalSatangs>
<baseUnitPriceSatangs>1</baseUnitPriceSatangs>
<childLineItems>
<childLineItemsPurchase>
<baseUnitPriceSatangs>1</baseUnitPriceSatangs>
<productCategoryId>sample string 3</productCategoryId>
<productCategoryName>sample string 4</productCategoryName>
<productName>sample string 2</productName>
<quantity>1</quantity>
<seq>1</seq>
<sku>sample string 1</sku>
</childLineItemsPurchase>
<childLineItemsPurchase>
<baseUnitPriceSatangs>1</baseUnitPriceSatangs>
<productCategoryId>sample string 3</productCategoryId>
<productCategoryName>sample string 4</productCategoryName>
<productName>sample string 2</productName>
<quantity>1</quantity>
<seq>1</seq>
<sku>sample string 1</sku>
</childLineItemsPurchase>
</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>
</lineItemsPurchase>
</lineItems>
<memberID>sample string 4</memberID>
<orderDate>sample string 3</orderDate>
<paymentType>sample string 11</paymentType>
<paymentTypeOthers>sample string 12</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>
<promotionsPurchase>
<exDiscountPromoSatangs>1</exDiscountPromoSatangs>
<extPromotionID>sample string 4</extPromotionID>
<invalidReason>sample string 3</invalidReason>
<isValid>true</isValid>
<promotionID>sample string 1</promotionID>
<quantity>sample string 2</quantity>
</promotionsPurchase>
<promotionsPurchase>
<exDiscountPromoSatangs>1</exDiscountPromoSatangs>
<extPromotionID>sample string 4</extPromotionID>
<invalidReason>sample string 3</invalidReason>
<isValid>true</isValid>
<promotionID>sample string 1</promotionID>
<quantity>sample string 2</quantity>
</promotionsPurchase>
</promotions>
<remainingPoints>1</remainingPoints>
<serviceChargePercent>1</serviceChargePercent>
<serviceChargeSatangs>1</serviceChargeSatangs>
<serviceType>sample string 9</serviceType>
<staffNo>sample string 5</staffNo>
<status>sample string 13</status>
<subTotalSatangs>1</subTotalSatangs>
<terminalNo>sample string 6</terminalNo>
<totalDueSatangs>1</totalDueSatangs>
<totalSatangs>1</totalSatangs>
<transactionDraftID>1</transactionDraftID>
<transactionID>sample string 1</transactionID>
<transactionRefID>sample string 2</transactionRefID>
<type>sample string 16</type>
<useExternalPromotion>true</useExternalPromotion>
<vatPercent>1</vatPercent>
<vatSatangs>1</vatSatangs>
<voidReason>sample string 21</voidReason>
<voidedAt>sample string 18</voidedAt>
<voidedByStaffNo>sample string 19</voidedByStaffNo>
<voidedByTerminalNo>sample string 20</voidedByTerminalNo>
</transactionPurchaseRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ObjectNone.
Response Formats
application/json, text/json
Sample:
{}
application/xml, text/xml
Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />