POST RTVPPurchaseTransaction
Request Information
URI Parameters
None.
Body Parameters
TransactionDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| RetailerID | integer |
None. |
|
| TillID | integer |
None. |
|
| InvoiceID | integer |
None. |
|
| TillMode | integer |
None. |
|
| RegistrationNumber | string |
None. |
|
| CaptureMethod | integer |
None. |
|
| CustomerStatus | CustomerStatusEnum |
None. |
|
| RemainingTobacco | decimal number |
None. |
|
| RemainingFuel | decimal number |
None. |
|
| OverrideNumber | string |
None. |
|
| OverrideReason | integer |
None. |
|
| PermitNumber | string |
None. |
|
| PurchaseCaptureMethod | integer |
None. |
|
| PurchaseException | character |
None. |
|
| Type | TransactionTypeEnum |
None. |
|
| ErrorPK | integer |
None. |
|
| ErrorLastUpdatedBy | string |
None. |
|
| CreateTime | date |
None. |
|
| SentTime | date |
None. |
|
| ReceivedTime | date |
None. |
|
| ReplyTime | date |
None. |
|
| ItemUPC | Collection of string |
None. |
|
| ItemCategory | Collection of integer |
None. |
|
| ItemTotal | Collection of decimal number |
None. |
|
| ItemEquivalence | Collection of decimal number |
None. |
|
| NumItems | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"<RetailerID>k__BackingField": 1,
"<TillID>k__BackingField": 2,
"<InvoiceID>k__BackingField": 3,
"<TillMode>k__BackingField": 4,
"<RegistrationNumber>k__BackingField": "sample string 5",
"<CaptureMethod>k__BackingField": 6,
"<CustomerStatus>k__BackingField": 1,
"<RemainingTobacco>k__BackingField": 7.1,
"<RemainingFuel>k__BackingField": 8.1,
"<OverrideNumber>k__BackingField": "sample string 9",
"<OverrideReason>k__BackingField": 10,
"<PermitNumber>k__BackingField": "sample string 11",
"<PurchaseCaptureMethod>k__BackingField": 12,
"<PurchaseException>k__BackingField": "A",
"<Type>k__BackingField": 1,
"<ErrorPK>k__BackingField": 14,
"<ErrorLastUpdatedBy>k__BackingField": "sample string 15",
"<CreateTime>k__BackingField": "2024-07-07T19:18:26.5150926-06:00",
"<SentTime>k__BackingField": "2024-07-07T19:18:26.5150926-06:00",
"<ReceivedTime>k__BackingField": "2024-07-07T19:18:26.5160935-06:00",
"<ReplyTime>k__BackingField": "2024-07-07T19:18:26.5160935-06:00",
"<ItemUPC>k__BackingField": [
"sample string 1",
"sample string 2"
],
"<ItemCategory>k__BackingField": [
1,
2
],
"<ItemTotal>k__BackingField": [
1.1,
2.1
],
"<ItemEquivalence>k__BackingField": [
1.1,
2.1
],
"<NumItems>k__BackingField": 20
}
application/xml, text/xml
Sample:
<TransactionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RTVP.Common">
<_x003C_CaptureMethod_x003E_k__BackingField>6</_x003C_CaptureMethod_x003E_k__BackingField>
<_x003C_CreateTime_x003E_k__BackingField>2024-07-07T19:18:26.5150926-06:00</_x003C_CreateTime_x003E_k__BackingField>
<_x003C_CustomerStatus_x003E_k__BackingField>Active</_x003C_CustomerStatus_x003E_k__BackingField>
<_x003C_ErrorLastUpdatedBy_x003E_k__BackingField>sample string 15</_x003C_ErrorLastUpdatedBy_x003E_k__BackingField>
<_x003C_ErrorPK_x003E_k__BackingField>14</_x003C_ErrorPK_x003E_k__BackingField>
<_x003C_InvoiceID_x003E_k__BackingField>3</_x003C_InvoiceID_x003E_k__BackingField>
<_x003C_ItemCategory_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</_x003C_ItemCategory_x003E_k__BackingField>
<_x003C_ItemEquivalence_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:double>1.1</d2p1:double>
<d2p1:double>2.1</d2p1:double>
</_x003C_ItemEquivalence_x003E_k__BackingField>
<_x003C_ItemTotal_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:double>1.1</d2p1:double>
<d2p1:double>2.1</d2p1:double>
</_x003C_ItemTotal_x003E_k__BackingField>
<_x003C_ItemUPC_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</_x003C_ItemUPC_x003E_k__BackingField>
<_x003C_NumItems_x003E_k__BackingField>20</_x003C_NumItems_x003E_k__BackingField>
<_x003C_OverrideNumber_x003E_k__BackingField>sample string 9</_x003C_OverrideNumber_x003E_k__BackingField>
<_x003C_OverrideReason_x003E_k__BackingField>10</_x003C_OverrideReason_x003E_k__BackingField>
<_x003C_PermitNumber_x003E_k__BackingField>sample string 11</_x003C_PermitNumber_x003E_k__BackingField>
<_x003C_PurchaseCaptureMethod_x003E_k__BackingField>12</_x003C_PurchaseCaptureMethod_x003E_k__BackingField>
<_x003C_PurchaseException_x003E_k__BackingField>65</_x003C_PurchaseException_x003E_k__BackingField>
<_x003C_ReceivedTime_x003E_k__BackingField>2024-07-07T19:18:26.5160935-06:00</_x003C_ReceivedTime_x003E_k__BackingField>
<_x003C_RegistrationNumber_x003E_k__BackingField>sample string 5</_x003C_RegistrationNumber_x003E_k__BackingField>
<_x003C_RemainingFuel_x003E_k__BackingField>8.1</_x003C_RemainingFuel_x003E_k__BackingField>
<_x003C_RemainingTobacco_x003E_k__BackingField>7.1</_x003C_RemainingTobacco_x003E_k__BackingField>
<_x003C_ReplyTime_x003E_k__BackingField>2024-07-07T19:18:26.5160935-06:00</_x003C_ReplyTime_x003E_k__BackingField>
<_x003C_RetailerID_x003E_k__BackingField>1</_x003C_RetailerID_x003E_k__BackingField>
<_x003C_SentTime_x003E_k__BackingField>2024-07-07T19:18:26.5150926-06:00</_x003C_SentTime_x003E_k__BackingField>
<_x003C_TillID_x003E_k__BackingField>2</_x003C_TillID_x003E_k__BackingField>
<_x003C_TillMode_x003E_k__BackingField>4</_x003C_TillMode_x003E_k__BackingField>
<_x003C_Type_x003E_k__BackingField>LimitRequest</_x003C_Type_x003E_k__BackingField>
</TransactionDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
WebServiceErrorsResponse Formats
application/json, text/json
Sample:
0
application/xml, text/xml
Sample:
<WebServiceErrors xmlns="http://schemas.datacontract.org/2004/07/RTVP.Common">Success</WebServiceErrors>