POST Partner/DoParticipantSupplierRedeem

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ParticipantID	integer	Required
SupplierID	integer	Required
SupplierAccessToken	string	Required
ShippingTypeID	integer	None.
CartTotalProductsPrice	decimal number	None.
ShippingValue	decimal number	None.
ShippingValueIncrement	decimal number	None.
ComplementValue	decimal number	None.
AreaCode	integer	None.
PhoneNumber	string	None.
ProductID	string	None.
ProductSKU	string	None.
CardNumber	string	None.
ProductSku	string	None.
ProductPrice	string	None.
InvoiceCode	string	None.
DiscountValue	string	None.
ExpirationDate	date	None.
TipoServico	TipoServico	None.
InvoiceReciever	string	None.
BankID	integer	None.
Agency	integer	None.
Account	integer	None.
AccountDigit	integer	None.
ValueInPoints	decimal number	None.
TaxValue	decimal number	None.
TransactionValue	decimal number	None.
BankName	string	None.
TipoContaBanco	TipoContaBanco	None.
CostFactor	decimal number	None.
TotalValue	string	None.
CreditCardFlagID	integer	None.
CreditCardNumber	string	None.
CreditCardHolderName	string	None.
CreditCardValidThroughMonthValue	integer	None.
CreditCardValidThroughYearValue	integer	None.
CreditCardSecurityNumber	string	None.
CreditCardPaymentFormID	integer	None.
CreditCardParcelQuantity	integer	None.
CreditCardMonthlyTax	decimal number	None.
CreditCardParcelValue	decimal number	None.
CreditCardTotalValue	decimal number	None.
CardID	integer	None.
Document	string	None.
PartnerAccessKey	string	None.
CampaignID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantID": 1,
  "SupplierID": 2,
  "SupplierAccessToken": "sample string 3",
  "ShippingTypeID": 1,
  "CartTotalProductsPrice": 1.1,
  "ShippingValue": 1.1,
  "ShippingValueIncrement": 1.1,
  "ComplementValue": 1.1,
  "AreaCode": 1,
  "PhoneNumber": "sample string 4",
  "ProductID": "sample string 5",
  "ProductSKU": "sample string 6",
  "CardNumber": "sample string 7",
  "ProductSku": "sample string 8",
  "ProductPrice": "sample string 9",
  "InvoiceCode": "sample string 10",
  "DiscountValue": "sample string 11",
  "ExpirationDate": "2026-02-17T14:25:11.0913031+00:00",
  "TipoServico": 0,
  "InvoiceReciever": "sample string 12",
  "BankID": 13,
  "Agency": 14,
  "Account": 15,
  "AccountDigit": 16,
  "ValueInPoints": 17.1,
  "TaxValue": 18.1,
  "TransactionValue": 19.1,
  "BankName": "sample string 20",
  "TipoContaBanco": 0,
  "CostFactor": 21.1,
  "TotalValue": "sample string 22",
  "CreditCardFlagID": 23,
  "CreditCardNumber": "sample string 24",
  "CreditCardHolderName": "sample string 25",
  "CreditCardValidThroughMonthValue": 26,
  "CreditCardValidThroughYearValue": 27,
  "CreditCardSecurityNumber": "sample string 28",
  "CreditCardPaymentFormID": 29,
  "CreditCardParcelQuantity": 30,
  "CreditCardMonthlyTax": 31.1,
  "CreditCardParcelValue": 32.1,
  "CreditCardTotalValue": 33.1,
  "CardID": 1,
  "Document": "sample string 34",
  "PartnerAccessKey": "sample string 35",
  "CampaignID": 36
}

application/xml, text/xml

Sample:

<DoParticipantSupplierRedeemDTORequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PartnerAccessKey>sample string 35</PartnerAccessKey>
  <CampaignID>36</CampaignID>
  <ParticipantID>1</ParticipantID>
  <SupplierID>2</SupplierID>
  <SupplierAccessToken>sample string 3</SupplierAccessToken>
  <ShippingTypeID>1</ShippingTypeID>
  <CartTotalProductsPrice>1.1</CartTotalProductsPrice>
  <ShippingValue>1.1</ShippingValue>
  <ShippingValueIncrement>1.1</ShippingValueIncrement>
  <ComplementValue>1.1</ComplementValue>
  <AreaCode>1</AreaCode>
  <PhoneNumber>sample string 4</PhoneNumber>
  <ProductID>sample string 5</ProductID>
  <ProductSKU>sample string 6</ProductSKU>
  <CardNumber>sample string 7</CardNumber>
  <ProductSku>sample string 8</ProductSku>
  <ProductPrice>sample string 9</ProductPrice>
  <InvoiceCode>sample string 10</InvoiceCode>
  <DiscountValue>sample string 11</DiscountValue>
  <ExpirationDate>2026-02-17T14:25:11.0913031+00:00</ExpirationDate>
  <TipoServico>INDEFINIDO</TipoServico>
  <InvoiceReciever>sample string 12</InvoiceReciever>
  <BankID>13</BankID>
  <Agency>14</Agency>
  <Account>15</Account>
  <AccountDigit>16</AccountDigit>
  <ValueInPoints>17.1</ValueInPoints>
  <TaxValue>18.1</TaxValue>
  <TransactionValue>19.1</TransactionValue>
  <BankName>sample string 20</BankName>
  <TipoContaBanco>CC</TipoContaBanco>
  <CostFactor>21.1</CostFactor>
  <TotalValue>sample string 22</TotalValue>
  <CreditCardFlagID>23</CreditCardFlagID>
  <CreditCardNumber>sample string 24</CreditCardNumber>
  <CreditCardHolderName>sample string 25</CreditCardHolderName>
  <CreditCardValidThroughMonthValue>26</CreditCardValidThroughMonthValue>
  <CreditCardValidThroughYearValue>27</CreditCardValidThroughYearValue>
  <CreditCardSecurityNumber>sample string 28</CreditCardSecurityNumber>
  <CreditCardPaymentFormID>29</CreditCardPaymentFormID>
  <CreditCardParcelQuantity>30</CreditCardParcelQuantity>
  <CreditCardMonthlyTax>31.1</CreditCardMonthlyTax>
  <CreditCardParcelValue>32.1</CreditCardParcelValue>
  <CreditCardTotalValue>33.1</CreditCardTotalValue>
  <CardID>1</CardID>
  <Document>sample string 34</Document>
</DoParticipantSupplierRedeemDTORequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DoParticipantSupplierRedeemDTORequest'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.