Estimates the points, cashback and availability dates for a sale without saving an order.

curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalId": "<string>",
  "OrderPlacementDate": "2023-11-07T05:31:56Z",
  "OrderCompletedDate": "2023-11-07T05:31:56Z",
  "OrderCancelledDate": "2023-11-07T05:31:56Z",
  "OrderStatus": "<string>",
  "IsCancelledOrReturned": true,
  "IsCompleted": true,
  "OrderTotal": 123,
  "Customer": {
    "OriginalId": "<string>",
    "Name": "<string>",
    "Email": "<string>",
    "Phone": "<string>",
    "BirthdayDate": "2023-11-07T05:31:56Z",
    "SignupDate": "2023-11-07T05:31:56Z",
    "Document": "<string>",
    "IsEnrolled": true,
    "EnrolledDate": "2023-11-07T05:31:56Z"
  },
  "Products": [
    {
      "OriginalId": "<string>",
      "Title": "<string>",
      "Url": "<string>",
      "ImageUrl": "<string>",
      "IsActive": true,
      "ProductPrice": 123,
      "ProductBrand": {
        "OriginalId": "<string>",
        "Name": "<string>"
      },
      "ProductCategory": {
        "OriginalId": "<string>",
        "Name": "<string>",
        "Description": "<string>",
        "ParentCategory": "<unknown>"
      }
    }
  ],
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Coupon": "<string>",
  "Metadatas": [
    {
      "Name": "<string>",
      "Value": "<string>"
    }
  ],
  "PaymentMethod": {
    "OriginalId": "<string>",
    "Name": "<string>",
    "PaidAmount": 123
  },
  "PaymentMethods": [
    {
      "OriginalId": "<string>",
      "Name": "<string>",
      "PaidAmount": 123
    }
  ],
  "Branch": {
    "OriginalId": "<string>",
    "Name": "<string>"
  },
  "SalesPerson": {
    "OriginalId": "<string>",
    "Name": "<string>"
  },
  "TradePolicy": {
    "OriginalId": "OUTLET",
    "Name": "Loja Outlet"
  },
  "ExternalCoupon": "<string>"
}
'

import requests

url = "https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate"

payload = {
    "OriginalId": "<string>",
    "OrderPlacementDate": "2023-11-07T05:31:56Z",
    "OrderCompletedDate": "2023-11-07T05:31:56Z",
    "OrderCancelledDate": "2023-11-07T05:31:56Z",
    "OrderStatus": "<string>",
    "IsCancelledOrReturned": True,
    "IsCompleted": True,
    "OrderTotal": 123,
    "Customer": {
        "OriginalId": "<string>",
        "Name": "<string>",
        "Email": "<string>",
        "Phone": "<string>",
        "BirthdayDate": "2023-11-07T05:31:56Z",
        "SignupDate": "2023-11-07T05:31:56Z",
        "Document": "<string>",
        "IsEnrolled": True,
        "EnrolledDate": "2023-11-07T05:31:56Z"
    },
    "Products": [
        {
            "OriginalId": "<string>",
            "Title": "<string>",
            "Url": "<string>",
            "ImageUrl": "<string>",
            "IsActive": True,
            "ProductPrice": 123,
            "ProductBrand": {
                "OriginalId": "<string>",
                "Name": "<string>"
            },
            "ProductCategory": {
                "OriginalId": "<string>",
                "Name": "<string>",
                "Description": "<string>",
                "ParentCategory": "<unknown>"
            }
        }
    ],
    "UpdatedDate": "2023-11-07T05:31:56Z",
    "Coupon": "<string>",
    "Metadatas": [
        {
            "Name": "<string>",
            "Value": "<string>"
        }
    ],
    "PaymentMethod": {
        "OriginalId": "<string>",
        "Name": "<string>",
        "PaidAmount": 123
    },
    "PaymentMethods": [
        {
            "OriginalId": "<string>",
            "Name": "<string>",
            "PaidAmount": 123
        }
    ],
    "Branch": {
        "OriginalId": "<string>",
        "Name": "<string>"
    },
    "SalesPerson": {
        "OriginalId": "<string>",
        "Name": "<string>"
    },
    "TradePolicy": {
        "OriginalId": "OUTLET",
        "Name": "Loja Outlet"
    },
    "ExternalCoupon": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    OriginalId: '<string>',
    OrderPlacementDate: '2023-11-07T05:31:56Z',
    OrderCompletedDate: '2023-11-07T05:31:56Z',
    OrderCancelledDate: '2023-11-07T05:31:56Z',
    OrderStatus: '<string>',
    IsCancelledOrReturned: true,
    IsCompleted: true,
    OrderTotal: 123,
    Customer: {
      OriginalId: '<string>',
      Name: '<string>',
      Email: '<string>',
      Phone: '<string>',
      BirthdayDate: '2023-11-07T05:31:56Z',
      SignupDate: '2023-11-07T05:31:56Z',
      Document: '<string>',
      IsEnrolled: true,
      EnrolledDate: '2023-11-07T05:31:56Z'
    },
    Products: [
      {
        OriginalId: '<string>',
        Title: '<string>',
        Url: '<string>',
        ImageUrl: '<string>',
        IsActive: true,
        ProductPrice: 123,
        ProductBrand: {OriginalId: '<string>', Name: '<string>'},
        ProductCategory: {
          OriginalId: '<string>',
          Name: '<string>',
          Description: '<string>',
          ParentCategory: '<unknown>'
        }
      }
    ],
    UpdatedDate: '2023-11-07T05:31:56Z',
    Coupon: '<string>',
    Metadatas: [{Name: '<string>', Value: '<string>'}],
    PaymentMethod: {OriginalId: '<string>', Name: '<string>', PaidAmount: 123},
    PaymentMethods: [{OriginalId: '<string>', Name: '<string>', PaidAmount: 123}],
    Branch: {OriginalId: '<string>', Name: '<string>'},
    SalesPerson: {OriginalId: '<string>', Name: '<string>'},
    TradePolicy: {OriginalId: 'OUTLET', Name: 'Loja Outlet'},
    ExternalCoupon: '<string>'
  })
};

fetch('https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'OriginalId' => '<string>',
    'OrderPlacementDate' => '2023-11-07T05:31:56Z',
    'OrderCompletedDate' => '2023-11-07T05:31:56Z',
    'OrderCancelledDate' => '2023-11-07T05:31:56Z',
    'OrderStatus' => '<string>',
    'IsCancelledOrReturned' => true,
    'IsCompleted' => true,
    'OrderTotal' => 123,
    'Customer' => [
        'OriginalId' => '<string>',
        'Name' => '<string>',
        'Email' => '<string>',
        'Phone' => '<string>',
        'BirthdayDate' => '2023-11-07T05:31:56Z',
        'SignupDate' => '2023-11-07T05:31:56Z',
        'Document' => '<string>',
        'IsEnrolled' => true,
        'EnrolledDate' => '2023-11-07T05:31:56Z'
    ],
    'Products' => [
        [
                'OriginalId' => '<string>',
                'Title' => '<string>',
                'Url' => '<string>',
                'ImageUrl' => '<string>',
                'IsActive' => true,
                'ProductPrice' => 123,
                'ProductBrand' => [
                                'OriginalId' => '<string>',
                                'Name' => '<string>'
                ],
                'ProductCategory' => [
                                'OriginalId' => '<string>',
                                'Name' => '<string>',
                                'Description' => '<string>',
                                'ParentCategory' => '<unknown>'
                ]
        ]
    ],
    'UpdatedDate' => '2023-11-07T05:31:56Z',
    'Coupon' => '<string>',
    'Metadatas' => [
        [
                'Name' => '<string>',
                'Value' => '<string>'
        ]
    ],
    'PaymentMethod' => [
        'OriginalId' => '<string>',
        'Name' => '<string>',
        'PaidAmount' => 123
    ],
    'PaymentMethods' => [
        [
                'OriginalId' => '<string>',
                'Name' => '<string>',
                'PaidAmount' => 123
        ]
    ],
    'Branch' => [
        'OriginalId' => '<string>',
        'Name' => '<string>'
    ],
    'SalesPerson' => [
        'OriginalId' => '<string>',
        'Name' => '<string>'
    ],
    'TradePolicy' => [
        'OriginalId' => 'OUTLET',
        'Name' => 'Loja Outlet'
    ],
    'ExternalCoupon' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate"

	payload := strings.NewReader("{\n  \"OriginalId\": \"<string>\",\n  \"OrderPlacementDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCompletedDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCancelledDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderStatus\": \"<string>\",\n  \"IsCancelledOrReturned\": true,\n  \"IsCompleted\": true,\n  \"OrderTotal\": 123,\n  \"Customer\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"Email\": \"<string>\",\n    \"Phone\": \"<string>\",\n    \"BirthdayDate\": \"2023-11-07T05:31:56Z\",\n    \"SignupDate\": \"2023-11-07T05:31:56Z\",\n    \"Document\": \"<string>\",\n    \"IsEnrolled\": true,\n    \"EnrolledDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"Products\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Title\": \"<string>\",\n      \"Url\": \"<string>\",\n      \"ImageUrl\": \"<string>\",\n      \"IsActive\": true,\n      \"ProductPrice\": 123,\n      \"ProductBrand\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\"\n      },\n      \"ProductCategory\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\",\n        \"Description\": \"<string>\",\n        \"ParentCategory\": \"<unknown>\"\n      }\n    }\n  ],\n  \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n  \"Coupon\": \"<string>\",\n  \"Metadatas\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"PaymentMethod\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"PaidAmount\": 123\n  },\n  \"PaymentMethods\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"PaidAmount\": 123\n    }\n  ],\n  \"Branch\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"SalesPerson\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"TradePolicy\": {\n    \"OriginalId\": \"OUTLET\",\n    \"Name\": \"Loja Outlet\"\n  },\n  \"ExternalCoupon\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"OriginalId\": \"<string>\",\n  \"OrderPlacementDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCompletedDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCancelledDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderStatus\": \"<string>\",\n  \"IsCancelledOrReturned\": true,\n  \"IsCompleted\": true,\n  \"OrderTotal\": 123,\n  \"Customer\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"Email\": \"<string>\",\n    \"Phone\": \"<string>\",\n    \"BirthdayDate\": \"2023-11-07T05:31:56Z\",\n    \"SignupDate\": \"2023-11-07T05:31:56Z\",\n    \"Document\": \"<string>\",\n    \"IsEnrolled\": true,\n    \"EnrolledDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"Products\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Title\": \"<string>\",\n      \"Url\": \"<string>\",\n      \"ImageUrl\": \"<string>\",\n      \"IsActive\": true,\n      \"ProductPrice\": 123,\n      \"ProductBrand\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\"\n      },\n      \"ProductCategory\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\",\n        \"Description\": \"<string>\",\n        \"ParentCategory\": \"<unknown>\"\n      }\n    }\n  ],\n  \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n  \"Coupon\": \"<string>\",\n  \"Metadatas\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"PaymentMethod\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"PaidAmount\": 123\n  },\n  \"PaymentMethods\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"PaidAmount\": 123\n    }\n  ],\n  \"Branch\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"SalesPerson\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"TradePolicy\": {\n    \"OriginalId\": \"OUTLET\",\n    \"Name\": \"Loja Outlet\"\n  },\n  \"ExternalCoupon\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"OriginalId\": \"<string>\",\n  \"OrderPlacementDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCompletedDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCancelledDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderStatus\": \"<string>\",\n  \"IsCancelledOrReturned\": true,\n  \"IsCompleted\": true,\n  \"OrderTotal\": 123,\n  \"Customer\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"Email\": \"<string>\",\n    \"Phone\": \"<string>\",\n    \"BirthdayDate\": \"2023-11-07T05:31:56Z\",\n    \"SignupDate\": \"2023-11-07T05:31:56Z\",\n    \"Document\": \"<string>\",\n    \"IsEnrolled\": true,\n    \"EnrolledDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"Products\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Title\": \"<string>\",\n      \"Url\": \"<string>\",\n      \"ImageUrl\": \"<string>\",\n      \"IsActive\": true,\n      \"ProductPrice\": 123,\n      \"ProductBrand\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\"\n      },\n      \"ProductCategory\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\",\n        \"Description\": \"<string>\",\n        \"ParentCategory\": \"<unknown>\"\n      }\n    }\n  ],\n  \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n  \"Coupon\": \"<string>\",\n  \"Metadatas\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"PaymentMethod\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"PaidAmount\": 123\n  },\n  \"PaymentMethods\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"PaidAmount\": 123\n    }\n  ],\n  \"Branch\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"SalesPerson\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"TradePolicy\": {\n    \"OriginalId\": \"OUTLET\",\n    \"Name\": \"Loja Outlet\"\n  },\n  \"ExternalCoupon\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "GenerateBonus": true,
    "EstimatedPoints": 123,
    "EstimatedCashback": 123,
    "EstimatedCashbackFormatted": "<string>",
    "DaysToAvailable": 123,
    "EstimatedAvailableDate": "2023-11-07T05:31:56Z",
    "ExpirationDays": 123,
    "EstimatedExpirationDate": "2023-11-07T05:31:56Z"
  },
  "Code": "<string>",
  "CodeName": "<string>",
  "Severity": 0,
  "HasWarning": true,
  "HasError": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "GenerateBonus": true,
    "EstimatedPoints": 123,
    "EstimatedCashback": 123,
    "EstimatedCashbackFormatted": "<string>",
    "DaysToAvailable": 123,
    "EstimatedAvailableDate": "2023-11-07T05:31:56Z",
    "ExpirationDays": 123,
    "EstimatedExpirationDate": "2023-11-07T05:31:56Z"
  },
  "Code": "<string>",
  "CodeName": "<string>",
  "Severity": 0,
  "HasWarning": true,
  "HasError": true
}

POST

pvt

POS

orders

estimate

Estimates the points, cashback and availability dates for a sale without saving an order.

curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalId": "<string>",
  "OrderPlacementDate": "2023-11-07T05:31:56Z",
  "OrderCompletedDate": "2023-11-07T05:31:56Z",
  "OrderCancelledDate": "2023-11-07T05:31:56Z",
  "OrderStatus": "<string>",
  "IsCancelledOrReturned": true,
  "IsCompleted": true,
  "OrderTotal": 123,
  "Customer": {
    "OriginalId": "<string>",
    "Name": "<string>",
    "Email": "<string>",
    "Phone": "<string>",
    "BirthdayDate": "2023-11-07T05:31:56Z",
    "SignupDate": "2023-11-07T05:31:56Z",
    "Document": "<string>",
    "IsEnrolled": true,
    "EnrolledDate": "2023-11-07T05:31:56Z"
  },
  "Products": [
    {
      "OriginalId": "<string>",
      "Title": "<string>",
      "Url": "<string>",
      "ImageUrl": "<string>",
      "IsActive": true,
      "ProductPrice": 123,
      "ProductBrand": {
        "OriginalId": "<string>",
        "Name": "<string>"
      },
      "ProductCategory": {
        "OriginalId": "<string>",
        "Name": "<string>",
        "Description": "<string>",
        "ParentCategory": "<unknown>"
      }
    }
  ],
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Coupon": "<string>",
  "Metadatas": [
    {
      "Name": "<string>",
      "Value": "<string>"
    }
  ],
  "PaymentMethod": {
    "OriginalId": "<string>",
    "Name": "<string>",
    "PaidAmount": 123
  },
  "PaymentMethods": [
    {
      "OriginalId": "<string>",
      "Name": "<string>",
      "PaidAmount": 123
    }
  ],
  "Branch": {
    "OriginalId": "<string>",
    "Name": "<string>"
  },
  "SalesPerson": {
    "OriginalId": "<string>",
    "Name": "<string>"
  },
  "TradePolicy": {
    "OriginalId": "OUTLET",
    "Name": "Loja Outlet"
  },
  "ExternalCoupon": "<string>"
}
'

import requests

url = "https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate"

payload = {
    "OriginalId": "<string>",
    "OrderPlacementDate": "2023-11-07T05:31:56Z",
    "OrderCompletedDate": "2023-11-07T05:31:56Z",
    "OrderCancelledDate": "2023-11-07T05:31:56Z",
    "OrderStatus": "<string>",
    "IsCancelledOrReturned": True,
    "IsCompleted": True,
    "OrderTotal": 123,
    "Customer": {
        "OriginalId": "<string>",
        "Name": "<string>",
        "Email": "<string>",
        "Phone": "<string>",
        "BirthdayDate": "2023-11-07T05:31:56Z",
        "SignupDate": "2023-11-07T05:31:56Z",
        "Document": "<string>",
        "IsEnrolled": True,
        "EnrolledDate": "2023-11-07T05:31:56Z"
    },
    "Products": [
        {
            "OriginalId": "<string>",
            "Title": "<string>",
            "Url": "<string>",
            "ImageUrl": "<string>",
            "IsActive": True,
            "ProductPrice": 123,
            "ProductBrand": {
                "OriginalId": "<string>",
                "Name": "<string>"
            },
            "ProductCategory": {
                "OriginalId": "<string>",
                "Name": "<string>",
                "Description": "<string>",
                "ParentCategory": "<unknown>"
            }
        }
    ],
    "UpdatedDate": "2023-11-07T05:31:56Z",
    "Coupon": "<string>",
    "Metadatas": [
        {
            "Name": "<string>",
            "Value": "<string>"
        }
    ],
    "PaymentMethod": {
        "OriginalId": "<string>",
        "Name": "<string>",
        "PaidAmount": 123
    },
    "PaymentMethods": [
        {
            "OriginalId": "<string>",
            "Name": "<string>",
            "PaidAmount": 123
        }
    ],
    "Branch": {
        "OriginalId": "<string>",
        "Name": "<string>"
    },
    "SalesPerson": {
        "OriginalId": "<string>",
        "Name": "<string>"
    },
    "TradePolicy": {
        "OriginalId": "OUTLET",
        "Name": "Loja Outlet"
    },
    "ExternalCoupon": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    OriginalId: '<string>',
    OrderPlacementDate: '2023-11-07T05:31:56Z',
    OrderCompletedDate: '2023-11-07T05:31:56Z',
    OrderCancelledDate: '2023-11-07T05:31:56Z',
    OrderStatus: '<string>',
    IsCancelledOrReturned: true,
    IsCompleted: true,
    OrderTotal: 123,
    Customer: {
      OriginalId: '<string>',
      Name: '<string>',
      Email: '<string>',
      Phone: '<string>',
      BirthdayDate: '2023-11-07T05:31:56Z',
      SignupDate: '2023-11-07T05:31:56Z',
      Document: '<string>',
      IsEnrolled: true,
      EnrolledDate: '2023-11-07T05:31:56Z'
    },
    Products: [
      {
        OriginalId: '<string>',
        Title: '<string>',
        Url: '<string>',
        ImageUrl: '<string>',
        IsActive: true,
        ProductPrice: 123,
        ProductBrand: {OriginalId: '<string>', Name: '<string>'},
        ProductCategory: {
          OriginalId: '<string>',
          Name: '<string>',
          Description: '<string>',
          ParentCategory: '<unknown>'
        }
      }
    ],
    UpdatedDate: '2023-11-07T05:31:56Z',
    Coupon: '<string>',
    Metadatas: [{Name: '<string>', Value: '<string>'}],
    PaymentMethod: {OriginalId: '<string>', Name: '<string>', PaidAmount: 123},
    PaymentMethods: [{OriginalId: '<string>', Name: '<string>', PaidAmount: 123}],
    Branch: {OriginalId: '<string>', Name: '<string>'},
    SalesPerson: {OriginalId: '<string>', Name: '<string>'},
    TradePolicy: {OriginalId: 'OUTLET', Name: 'Loja Outlet'},
    ExternalCoupon: '<string>'
  })
};

fetch('https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'OriginalId' => '<string>',
    'OrderPlacementDate' => '2023-11-07T05:31:56Z',
    'OrderCompletedDate' => '2023-11-07T05:31:56Z',
    'OrderCancelledDate' => '2023-11-07T05:31:56Z',
    'OrderStatus' => '<string>',
    'IsCancelledOrReturned' => true,
    'IsCompleted' => true,
    'OrderTotal' => 123,
    'Customer' => [
        'OriginalId' => '<string>',
        'Name' => '<string>',
        'Email' => '<string>',
        'Phone' => '<string>',
        'BirthdayDate' => '2023-11-07T05:31:56Z',
        'SignupDate' => '2023-11-07T05:31:56Z',
        'Document' => '<string>',
        'IsEnrolled' => true,
        'EnrolledDate' => '2023-11-07T05:31:56Z'
    ],
    'Products' => [
        [
                'OriginalId' => '<string>',
                'Title' => '<string>',
                'Url' => '<string>',
                'ImageUrl' => '<string>',
                'IsActive' => true,
                'ProductPrice' => 123,
                'ProductBrand' => [
                                'OriginalId' => '<string>',
                                'Name' => '<string>'
                ],
                'ProductCategory' => [
                                'OriginalId' => '<string>',
                                'Name' => '<string>',
                                'Description' => '<string>',
                                'ParentCategory' => '<unknown>'
                ]
        ]
    ],
    'UpdatedDate' => '2023-11-07T05:31:56Z',
    'Coupon' => '<string>',
    'Metadatas' => [
        [
                'Name' => '<string>',
                'Value' => '<string>'
        ]
    ],
    'PaymentMethod' => [
        'OriginalId' => '<string>',
        'Name' => '<string>',
        'PaidAmount' => 123
    ],
    'PaymentMethods' => [
        [
                'OriginalId' => '<string>',
                'Name' => '<string>',
                'PaidAmount' => 123
        ]
    ],
    'Branch' => [
        'OriginalId' => '<string>',
        'Name' => '<string>'
    ],
    'SalesPerson' => [
        'OriginalId' => '<string>',
        'Name' => '<string>'
    ],
    'TradePolicy' => [
        'OriginalId' => 'OUTLET',
        'Name' => 'Loja Outlet'
    ],
    'ExternalCoupon' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate"

	payload := strings.NewReader("{\n  \"OriginalId\": \"<string>\",\n  \"OrderPlacementDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCompletedDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCancelledDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderStatus\": \"<string>\",\n  \"IsCancelledOrReturned\": true,\n  \"IsCompleted\": true,\n  \"OrderTotal\": 123,\n  \"Customer\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"Email\": \"<string>\",\n    \"Phone\": \"<string>\",\n    \"BirthdayDate\": \"2023-11-07T05:31:56Z\",\n    \"SignupDate\": \"2023-11-07T05:31:56Z\",\n    \"Document\": \"<string>\",\n    \"IsEnrolled\": true,\n    \"EnrolledDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"Products\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Title\": \"<string>\",\n      \"Url\": \"<string>\",\n      \"ImageUrl\": \"<string>\",\n      \"IsActive\": true,\n      \"ProductPrice\": 123,\n      \"ProductBrand\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\"\n      },\n      \"ProductCategory\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\",\n        \"Description\": \"<string>\",\n        \"ParentCategory\": \"<unknown>\"\n      }\n    }\n  ],\n  \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n  \"Coupon\": \"<string>\",\n  \"Metadatas\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"PaymentMethod\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"PaidAmount\": 123\n  },\n  \"PaymentMethods\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"PaidAmount\": 123\n    }\n  ],\n  \"Branch\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"SalesPerson\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"TradePolicy\": {\n    \"OriginalId\": \"OUTLET\",\n    \"Name\": \"Loja Outlet\"\n  },\n  \"ExternalCoupon\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"OriginalId\": \"<string>\",\n  \"OrderPlacementDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCompletedDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCancelledDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderStatus\": \"<string>\",\n  \"IsCancelledOrReturned\": true,\n  \"IsCompleted\": true,\n  \"OrderTotal\": 123,\n  \"Customer\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"Email\": \"<string>\",\n    \"Phone\": \"<string>\",\n    \"BirthdayDate\": \"2023-11-07T05:31:56Z\",\n    \"SignupDate\": \"2023-11-07T05:31:56Z\",\n    \"Document\": \"<string>\",\n    \"IsEnrolled\": true,\n    \"EnrolledDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"Products\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Title\": \"<string>\",\n      \"Url\": \"<string>\",\n      \"ImageUrl\": \"<string>\",\n      \"IsActive\": true,\n      \"ProductPrice\": 123,\n      \"ProductBrand\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\"\n      },\n      \"ProductCategory\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\",\n        \"Description\": \"<string>\",\n        \"ParentCategory\": \"<unknown>\"\n      }\n    }\n  ],\n  \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n  \"Coupon\": \"<string>\",\n  \"Metadatas\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"PaymentMethod\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"PaidAmount\": 123\n  },\n  \"PaymentMethods\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"PaidAmount\": 123\n    }\n  ],\n  \"Branch\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"SalesPerson\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"TradePolicy\": {\n    \"OriginalId\": \"OUTLET\",\n    \"Name\": \"Loja Outlet\"\n  },\n  \"ExternalCoupon\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bonifiq.com.br/v1/pvt/POS/orders/estimate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"OriginalId\": \"<string>\",\n  \"OrderPlacementDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCompletedDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderCancelledDate\": \"2023-11-07T05:31:56Z\",\n  \"OrderStatus\": \"<string>\",\n  \"IsCancelledOrReturned\": true,\n  \"IsCompleted\": true,\n  \"OrderTotal\": 123,\n  \"Customer\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"Email\": \"<string>\",\n    \"Phone\": \"<string>\",\n    \"BirthdayDate\": \"2023-11-07T05:31:56Z\",\n    \"SignupDate\": \"2023-11-07T05:31:56Z\",\n    \"Document\": \"<string>\",\n    \"IsEnrolled\": true,\n    \"EnrolledDate\": \"2023-11-07T05:31:56Z\"\n  },\n  \"Products\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Title\": \"<string>\",\n      \"Url\": \"<string>\",\n      \"ImageUrl\": \"<string>\",\n      \"IsActive\": true,\n      \"ProductPrice\": 123,\n      \"ProductBrand\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\"\n      },\n      \"ProductCategory\": {\n        \"OriginalId\": \"<string>\",\n        \"Name\": \"<string>\",\n        \"Description\": \"<string>\",\n        \"ParentCategory\": \"<unknown>\"\n      }\n    }\n  ],\n  \"UpdatedDate\": \"2023-11-07T05:31:56Z\",\n  \"Coupon\": \"<string>\",\n  \"Metadatas\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": \"<string>\"\n    }\n  ],\n  \"PaymentMethod\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\",\n    \"PaidAmount\": 123\n  },\n  \"PaymentMethods\": [\n    {\n      \"OriginalId\": \"<string>\",\n      \"Name\": \"<string>\",\n      \"PaidAmount\": 123\n    }\n  ],\n  \"Branch\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"SalesPerson\": {\n    \"OriginalId\": \"<string>\",\n    \"Name\": \"<string>\"\n  },\n  \"TradePolicy\": {\n    \"OriginalId\": \"OUTLET\",\n    \"Name\": \"Loja Outlet\"\n  },\n  \"ExternalCoupon\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "GenerateBonus": true,
    "EstimatedPoints": 123,
    "EstimatedCashback": 123,
    "EstimatedCashbackFormatted": "<string>",
    "DaysToAvailable": 123,
    "EstimatedAvailableDate": "2023-11-07T05:31:56Z",
    "ExpirationDays": 123,
    "EstimatedExpirationDate": "2023-11-07T05:31:56Z"
  },
  "Code": "<string>",
  "CodeName": "<string>",
  "Severity": 0,
  "HasWarning": true,
  "HasError": true
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "GenerateBonus": true,
    "EstimatedPoints": 123,
    "EstimatedCashback": 123,
    "EstimatedCashbackFormatted": "<string>",
    "DaysToAvailable": 123,
    "EstimatedAvailableDate": "2023-11-07T05:31:56Z",
    "ExpirationDays": 123,
    "EstimatedExpirationDate": "2023-11-07T05:31:56Z"
  },
  "Code": "<string>",
  "CodeName": "<string>",
  "Severity": 0,
  "HasWarning": true,
  "HasError": true
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Body

application/json

Purchase Order Model

OriginalId

string

This is the Id in the client store.

OrderPlacementDate

string<date-time>

Date of the customer's purchase.

OrderCompletedDate

string<date-time> | null

Date the order reached the completed state (usually it's invoiced or delivered).

OrderCancelledDate

string<date-time> | null

if the order is cancelled, contains the date.

OrderStatus

string

Status at the client's order system.

IsCancelledOrReturned

boolean

if true the order was cancelled or returned.

IsCompleted

boolean

If true it means the order has reached its final status and points can be awarded to the consumer.

OrderTotal

number<decimal>

Can be used at Loyalty Programs. Important: these values should not include Shipping costs.

Customer

object

Buyer registration.

Show child attributes

Products

object[] | null

Products listed on the order.

Show child attributes

UpdatedDate

string<date-time>

the date from the last update on this order.

Coupon

string | null

Coupon code used on this order.

Metadatas

object[] | null

This is a key-value list of extra information regarding the order. It could be informative only or being part of an business rule to be used later.

Show child attributes

PaymentMethod

object | null

Obsolete: use PaymentMethods instead. This legacy field is still supported for backward compatibility. The Payment Method used in this purchase. Should be the more specific as possible (ie: instead of using "Credit Card" use "Visa Credit Card" and so on). This field can be used later on to create extra points purchase rules.

Show child attributes

PaymentMethods

object[] | null

Preferred field for the payment methods used in this purchase. Each item should be as specific as possible (ie: instead of using "Credit Card" use "Visa Credit Card" and so on).

Show child attributes

Branch

object | null

A Branch is physical location or outlet of a store (loja, filial, etc). This is used to receive information of which store the purchase was made. It can be later used to create rules for points or filtering reports.

Show child attributes

SalesPerson

object | null

A sales person is the person responsible for the sale. It can be used for filtering reports.

Show child attributes

TradePolicy

object | null

Optional trade policy (política comercial) of the sale, such as a full price store or an outlet store. It can be used to create extra points rules by trade policy.

Show child attributes

ExternalCoupon

string | null

Response

Standard response envelope used by the External API.

ErrorMessage

string | null

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCode

integer<int32> | null

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Result

object | null

Business payload returned by the endpoint.

Show child attributes

Code

string | null

Endpoint-specific business code formatted as a two-digit string, such as 03 or 07. This field is available for success, warning and error outcomes.

CodeName

string | null

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity

enum<integer>

Final severity of the response. Success means the action completed as expected, Warning means the request was valid but the business outcome is informational or non-ideal, and Error means the request should be treated as a failure.

Available options:

0,

1,

2

HasWarning

boolean

Convenience flag that is true when Severity is Warning. Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.

HasError

boolean

Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as false.