POST api/RateTicket

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	string	None.
StoreId	string	None.
ClientId	string	None.
PaymentMethod	string	None.
OperationDate	date	None.
Bines	Collection of string	None.
Loyalty	Collection of string	None.
Cupon	Collection of string	None.
Items	Collection of TicketItem	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "StoreId": "sample string 2",
  "ClientId": "sample string 3",
  "PaymentMethod": "sample string 4",
  "OperationDate": "2025-12-11T12:02:09.0019089-06:00",
  "Bines": [
    "sample string 1",
    "sample string 2"
  ],
  "Loyalty": [
    "sample string 1",
    "sample string 2"
  ],
  "Cupon": [
    "sample string 1",
    "sample string 2"
  ],
  "Items": [
    {
      "Barcode": "sample string 1",
      "Quantity": 2.1,
      "StorePrice": 3.1,
      "ExchangePoints": 4,
      "OriginalStorePrice": 5.1,
      "ShipmentId": "sample string 6",
      "Grocery": true
    },
    {
      "Barcode": "sample string 1",
      "Quantity": 2.1,
      "StorePrice": 3.1,
      "ExchangePoints": 4,
      "OriginalStorePrice": 5.1,
      "ShipmentId": "sample string 6",
      "Grocery": true
    }
  ]
}

application/xml, text/xml

Sample:

<Ticket xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EnigmaSDK.Request">
  <Bines xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Bines>
  <ClientId>sample string 3</ClientId>
  <Cupon xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Cupon>
  <Id>sample string 1</Id>
  <Items>
    <TicketItem>
      <Barcode>sample string 1</Barcode>
      <ExchangePoints>4</ExchangePoints>
      <Grocery>true</Grocery>
      <OriginalStorePrice>5.1</OriginalStorePrice>
      <Quantity>2.1</Quantity>
      <ShipmentId>sample string 6</ShipmentId>
      <StorePrice>3.1</StorePrice>
    </TicketItem>
    <TicketItem>
      <Barcode>sample string 1</Barcode>
      <ExchangePoints>4</ExchangePoints>
      <Grocery>true</Grocery>
      <OriginalStorePrice>5.1</OriginalStorePrice>
      <Quantity>2.1</Quantity>
      <ShipmentId>sample string 6</ShipmentId>
      <StorePrice>3.1</StorePrice>
    </TicketItem>
  </Items>
  <Loyalty xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Loyalty>
  <OperationDate>2025-12-11T12:02:09.0019089-06:00</OperationDate>
  <PaymentMethod>sample string 4</PaymentMethod>
  <StoreId>sample string 2</StoreId>
</Ticket>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValuatedTicket

Name	Type	Additional information
Message	string	None.
Items	Collection of ValuatedTicketItem	None.
Adjustments	Collection of Adjustment	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Items": [
    {
      "BarCode": "sample string 1",
      "ShipmentId": "sample string 2",
      "Grocery": true,
      "Adjustments": [
        {
          "Id": "sample string 1",
          "Description": "sample string 2",
          "Type": "sample string 3",
          "Discount": 4.1,
          "Price": 5.1,
          "AdditionalPoints": 6,
          "FixedPrice": 7.1,
          "FreeShipping": true,
          "ExchangePoints": "sample string 9",
          "PerfectPartner": "sample string 10",
          "ElectronicWallet": 11.1,
          "ShippingDiscount": 12.1,
          "Priority": 13,
          "Excecution": 64,
          "OriginalPrice": 15.1,
          "PriceAfterPoints": 16.1,
          "NumberOfInstalments": 17
        },
        {
          "Id": "sample string 1",
          "Description": "sample string 2",
          "Type": "sample string 3",
          "Discount": 4.1,
          "Price": 5.1,
          "AdditionalPoints": 6,
          "FixedPrice": 7.1,
          "FreeShipping": true,
          "ExchangePoints": "sample string 9",
          "PerfectPartner": "sample string 10",
          "ElectronicWallet": 11.1,
          "ShippingDiscount": 12.1,
          "Priority": 13,
          "Excecution": 64,
          "OriginalPrice": 15.1,
          "PriceAfterPoints": 16.1,
          "NumberOfInstalments": 17
        }
      ],
      "InstalmentsOptions": [
        {
          "DisplayText": "sample string 1",
          "NumberOfInstalments": 64
        },
        {
          "DisplayText": "sample string 1",
          "NumberOfInstalments": 64
        }
      ]
    },
    {
      "BarCode": "sample string 1",
      "ShipmentId": "sample string 2",
      "Grocery": true,
      "Adjustments": [
        {
          "Id": "sample string 1",
          "Description": "sample string 2",
          "Type": "sample string 3",
          "Discount": 4.1,
          "Price": 5.1,
          "AdditionalPoints": 6,
          "FixedPrice": 7.1,
          "FreeShipping": true,
          "ExchangePoints": "sample string 9",
          "PerfectPartner": "sample string 10",
          "ElectronicWallet": 11.1,
          "ShippingDiscount": 12.1,
          "Priority": 13,
          "Excecution": 64,
          "OriginalPrice": 15.1,
          "PriceAfterPoints": 16.1,
          "NumberOfInstalments": 17
        },
        {
          "Id": "sample string 1",
          "Description": "sample string 2",
          "Type": "sample string 3",
          "Discount": 4.1,
          "Price": 5.1,
          "AdditionalPoints": 6,
          "FixedPrice": 7.1,
          "FreeShipping": true,
          "ExchangePoints": "sample string 9",
          "PerfectPartner": "sample string 10",
          "ElectronicWallet": 11.1,
          "ShippingDiscount": 12.1,
          "Priority": 13,
          "Excecution": 64,
          "OriginalPrice": 15.1,
          "PriceAfterPoints": 16.1,
          "NumberOfInstalments": 17
        }
      ],
      "InstalmentsOptions": [
        {
          "DisplayText": "sample string 1",
          "NumberOfInstalments": 64
        },
        {
          "DisplayText": "sample string 1",
          "NumberOfInstalments": 64
        }
      ]
    }
  ],
  "Adjustments": [
    {
      "Id": "sample string 1",
      "Description": "sample string 2",
      "Type": "sample string 3",
      "Discount": 4.1,
      "Price": 5.1,
      "AdditionalPoints": 6,
      "FixedPrice": 7.1,
      "FreeShipping": true,
      "ExchangePoints": "sample string 9",
      "PerfectPartner": "sample string 10",
      "ElectronicWallet": 11.1,
      "ShippingDiscount": 12.1,
      "Priority": 13,
      "Excecution": 64,
      "OriginalPrice": 15.1,
      "PriceAfterPoints": 16.1,
      "NumberOfInstalments": 17
    },
    {
      "Id": "sample string 1",
      "Description": "sample string 2",
      "Type": "sample string 3",
      "Discount": 4.1,
      "Price": 5.1,
      "AdditionalPoints": 6,
      "FixedPrice": 7.1,
      "FreeShipping": true,
      "ExchangePoints": "sample string 9",
      "PerfectPartner": "sample string 10",
      "ElectronicWallet": 11.1,
      "ShippingDiscount": 12.1,
      "Priority": 13,
      "Excecution": 64,
      "OriginalPrice": 15.1,
      "PriceAfterPoints": 16.1,
      "NumberOfInstalments": 17
    }
  ]
}

application/xml, text/xml

Sample:

<ValuatedTicket xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EnigmaSDK.Response">
  <Adjustments>
    <Adjustment>
      <AdditionalPoints>6</AdditionalPoints>
      <Description>sample string 2</Description>
      <Discount>4.1</Discount>
      <ElectronicWallet>11.1</ElectronicWallet>
      <Excecution>64</Excecution>
      <ExchangePoints>sample string 9</ExchangePoints>
      <FixedPrice>7.1</FixedPrice>
      <FreeShipping>true</FreeShipping>
      <Id>sample string 1</Id>
      <NumberOfInstalments>17</NumberOfInstalments>
      <OriginalPrice>15.1</OriginalPrice>
      <PerfectPartner>sample string 10</PerfectPartner>
      <Price>5.1</Price>
      <PriceAfterPoints>16.1</PriceAfterPoints>
      <Priority>13</Priority>
      <ShippingDiscount>12.1</ShippingDiscount>
      <Type>sample string 3</Type>
    </Adjustment>
    <Adjustment>
      <AdditionalPoints>6</AdditionalPoints>
      <Description>sample string 2</Description>
      <Discount>4.1</Discount>
      <ElectronicWallet>11.1</ElectronicWallet>
      <Excecution>64</Excecution>
      <ExchangePoints>sample string 9</ExchangePoints>
      <FixedPrice>7.1</FixedPrice>
      <FreeShipping>true</FreeShipping>
      <Id>sample string 1</Id>
      <NumberOfInstalments>17</NumberOfInstalments>
      <OriginalPrice>15.1</OriginalPrice>
      <PerfectPartner>sample string 10</PerfectPartner>
      <Price>5.1</Price>
      <PriceAfterPoints>16.1</PriceAfterPoints>
      <Priority>13</Priority>
      <ShippingDiscount>12.1</ShippingDiscount>
      <Type>sample string 3</Type>
    </Adjustment>
  </Adjustments>
  <Items>
    <ValuatedTicketItem>
      <Adjustments>
        <Adjustment>
          <AdditionalPoints>6</AdditionalPoints>
          <Description>sample string 2</Description>
          <Discount>4.1</Discount>
          <ElectronicWallet>11.1</ElectronicWallet>
          <Excecution>64</Excecution>
          <ExchangePoints>sample string 9</ExchangePoints>
          <FixedPrice>7.1</FixedPrice>
          <FreeShipping>true</FreeShipping>
          <Id>sample string 1</Id>
          <NumberOfInstalments>17</NumberOfInstalments>
          <OriginalPrice>15.1</OriginalPrice>
          <PerfectPartner>sample string 10</PerfectPartner>
          <Price>5.1</Price>
          <PriceAfterPoints>16.1</PriceAfterPoints>
          <Priority>13</Priority>
          <ShippingDiscount>12.1</ShippingDiscount>
          <Type>sample string 3</Type>
        </Adjustment>
        <Adjustment>
          <AdditionalPoints>6</AdditionalPoints>
          <Description>sample string 2</Description>
          <Discount>4.1</Discount>
          <ElectronicWallet>11.1</ElectronicWallet>
          <Excecution>64</Excecution>
          <ExchangePoints>sample string 9</ExchangePoints>
          <FixedPrice>7.1</FixedPrice>
          <FreeShipping>true</FreeShipping>
          <Id>sample string 1</Id>
          <NumberOfInstalments>17</NumberOfInstalments>
          <OriginalPrice>15.1</OriginalPrice>
          <PerfectPartner>sample string 10</PerfectPartner>
          <Price>5.1</Price>
          <PriceAfterPoints>16.1</PriceAfterPoints>
          <Priority>13</Priority>
          <ShippingDiscount>12.1</ShippingDiscount>
          <Type>sample string 3</Type>
        </Adjustment>
      </Adjustments>
      <BarCode>sample string 1</BarCode>
      <Grocery>true</Grocery>
      <InstalmentsOptions>
        <InstalmentOption>
          <DisplayText>sample string 1</DisplayText>
          <NumberOfInstalments>64</NumberOfInstalments>
        </InstalmentOption>
        <InstalmentOption>
          <DisplayText>sample string 1</DisplayText>
          <NumberOfInstalments>64</NumberOfInstalments>
        </InstalmentOption>
      </InstalmentsOptions>
      <ShipmentId>sample string 2</ShipmentId>
    </ValuatedTicketItem>
    <ValuatedTicketItem>
      <Adjustments>
        <Adjustment>
          <AdditionalPoints>6</AdditionalPoints>
          <Description>sample string 2</Description>
          <Discount>4.1</Discount>
          <ElectronicWallet>11.1</ElectronicWallet>
          <Excecution>64</Excecution>
          <ExchangePoints>sample string 9</ExchangePoints>
          <FixedPrice>7.1</FixedPrice>
          <FreeShipping>true</FreeShipping>
          <Id>sample string 1</Id>
          <NumberOfInstalments>17</NumberOfInstalments>
          <OriginalPrice>15.1</OriginalPrice>
          <PerfectPartner>sample string 10</PerfectPartner>
          <Price>5.1</Price>
          <PriceAfterPoints>16.1</PriceAfterPoints>
          <Priority>13</Priority>
          <ShippingDiscount>12.1</ShippingDiscount>
          <Type>sample string 3</Type>
        </Adjustment>
        <Adjustment>
          <AdditionalPoints>6</AdditionalPoints>
          <Description>sample string 2</Description>
          <Discount>4.1</Discount>
          <ElectronicWallet>11.1</ElectronicWallet>
          <Excecution>64</Excecution>
          <ExchangePoints>sample string 9</ExchangePoints>
          <FixedPrice>7.1</FixedPrice>
          <FreeShipping>true</FreeShipping>
          <Id>sample string 1</Id>
          <NumberOfInstalments>17</NumberOfInstalments>
          <OriginalPrice>15.1</OriginalPrice>
          <PerfectPartner>sample string 10</PerfectPartner>
          <Price>5.1</Price>
          <PriceAfterPoints>16.1</PriceAfterPoints>
          <Priority>13</Priority>
          <ShippingDiscount>12.1</ShippingDiscount>
          <Type>sample string 3</Type>
        </Adjustment>
      </Adjustments>
      <BarCode>sample string 1</BarCode>
      <Grocery>true</Grocery>
      <InstalmentsOptions>
        <InstalmentOption>
          <DisplayText>sample string 1</DisplayText>
          <NumberOfInstalments>64</NumberOfInstalments>
        </InstalmentOption>
        <InstalmentOption>
          <DisplayText>sample string 1</DisplayText>
          <NumberOfInstalments>64</NumberOfInstalments>
        </InstalmentOption>
      </InstalmentsOptions>
      <ShipmentId>sample string 2</ShipmentId>
    </ValuatedTicketItem>
  </Items>
  <Message>sample string 1</Message>
</ValuatedTicket>