(GET) /cycle
API Endpoint
https://api.omnik.io/v1/financial/cycle
# Here is a curl example
curl --location 'https://api.omnik.io/v1/financial/cycle' \
--header 'token: {token}' \
--header 'Content-Type: application/json'
Result example 2xx:
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "string",
"lastUpdate": "string",
"typeOfCycle": "string",
"financialCycleStatus": "string",
"paymentStatus": "string",
"operatorName": "string",
"sellerTenant": "string",
"transferDate": "string",
"beginningOfCycle": "SALE",
"endOfCycle": "PEND",
"statements": "string",
"type": "string",
"value": 0,
"statementId": "string",
"applicationId": "string",
"releaseDate": "string",
"paymentError": "string",
"marketplaceId": 0,
"orderId": 0,
"status": "string",
"typedLabel": {
"id": "string",
"typeId": "string",
"typeLabel": "string",
"typeDescription": "string"
}
}
Result example 4xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Result example 5xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Consulta de Lançamentos Manuais
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
(POST) /cycle/waiting-payment
API Endpoint
https://api.omnik.io/v1/financial/cycle/waiting-payment
# Here is a curl example
curl --location 'https://api.omnik.io/v1/financial/cycle/waiting-payment' \
--header 'token: {token}' \
--header 'Content-Type: application/json' \
--data '{
"tenants": [
""
],
"ids": [
""
]
}'
Result example 2xx:
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "string",
"lastUpdate": "string",
"orderId": "string",
"marketplaceId": "string",
"sellerName": "string",
"operatorName": "string",
"siteId": "string",
"calculationId": "string",
"type": "SALE",
"status": "PEND",
"description": "string",
"releaseDate": "string",
"value": 0,
"origin": "string",
"applicationId": "string",
"userId": "string",
"paymentError": "string",
"installmentNumber": 0,
"totalOfInstallments": 0,
"installmentAvailableDate": "string",
"isMultiInstallments": true,
"typedLabel": {
"id": "string",
"typeId": "string",
"typeLabel": "string",
"typeDescription": "string"
}
}
Result example 4xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Result example 5xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Cadastro de Lançamentos Manuais
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
Body Parameters
| Campo |
Tipo |
Descrição |
| tenants |
string array |
(required) ID dos Sellers |
| ids |
string array |
(required) ID do tipo de Lançamento |
(PUT) /cycle/pay
API Endpoint
https://api.omnik.io/v1/financial/cycle/pay
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/v1/financial/cycle/pay' \
--header 'token: {token}' \
--header 'Content-Type: application/json' \
--data '{
"financialCycleId": "string",
"antecipedValue": 0,
"orders": [
{
"seller": "",
"marketplaceId": "",
"value": null,
"anteciped": false,
"registersIds": [
""
]
}
]
}'
Result example 2xx:
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "string",
"lastUpdate": "string",
"orderId": "string",
"marketplaceId": "string",
"sellerName": "string",
"operatorName": "string",
"siteId": "string",
"calculationId": "string",
"type": "SALE",
"status": "PEND",
"description": "string",
"releaseDate": "string",
"value": 0,
"origin": "string",
"applicationId": "string",
"userId": "string",
"paymentError": "string",
"installmentNumber": 0,
"totalOfInstallments": 0,
"installmentAvailableDate": "string",
"isMultiInstallments": true,
"typedLabel": {
"id": "string",
"typeId": "string",
"typeLabel": "string",
"typeDescription": "string"
}
}
Result example 4xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Result example 5xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Alteração de Lançamentos Manuais
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
Body Parameters
| Campo |
Tipo |
Descrição |
| financialCycleId |
string |
(required) ID do ciclo |
| antecipedValue |
number |
(required) Deixar sempre = 0 |
| orders |
array |
| Campo |
Tipo |
Descrição |
| seller |
string |
(optional) ID do vendedor |
| marketplaceId |
string |
(optional) ID do marketplace |
| value |
integer |
(optional) Valor em centavos |
| anteciped |
boolean |
(optional) Indica se é antecipado - default: false |
| registersIds |
string array |
(optional) Array de IDs de registros |
|
(PUT) /cycle/orders/block
API Endpoint
https://api.omnik.io/v1/financial/cycle/orders/block
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/v1/financial/cycle/orders/block' \
--header 'token: {token}' \
--data '{
"marketplaceId": "string",
"tenant": "string",
"financialCycleId": "0",
"registersIds": [
""
]
}'
Result example 2xx:
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "string",
"lastUpdate": "string",
"orderId": "string",
"marketplaceId": "string",
"sellerName": "string",
"operatorName": "string",
"siteId": "string",
"calculationId": "string",
"type": "SALE",
"status": "PEND",
"description": "string",
"releaseDate": "string",
"value": 0,
"origin": "string",
"applicationId": "string",
"userId": "string",
"paymentError": "string",
"installmentNumber": 0,
"totalOfInstallments": 0,
"installmentAvailableDate": "string",
"isMultiInstallments": true,
"typedLabel": {
"id": "string",
"typeId": "string",
"typeLabel": "string",
"typeDescription": "string"
}
}
Result example 4xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Result example 5xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Alteração de Lançamentos Manuais
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
Body Parameters
| Campo |
Tipo |
Descrição |
| marketplaceId |
string |
(required) ID do pedido |
| tenant |
string |
(required) ID do seller |
| financialCycleId |
string |
(required) ID do ciclo |
| registersIds |
string array |
(optional) Array de IDs de registros para bloqueio |
(PUT) /cycle/orders/unblock
API Endpoint
https://api.omnik.io/v1/financial/cycle/orders/unblock
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/v1/financial/cycle/orders/unblock' \
--header 'token: {token}' \
--data '{
"marketplaceId": "string",
"tenant": "string",
"financialCycleId": "0",
"registersIds": [
""
]
}'
Result example 2xx:
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "string",
"lastUpdate": "string",
"orderId": "string",
"marketplaceId": "string",
"sellerName": "string",
"operatorName": "string",
"siteId": "string",
"calculationId": "string",
"type": "SALE",
"status": "PEND",
"description": "string",
"releaseDate": "string",
"value": 0,
"origin": "string",
"applicationId": "string",
"userId": "string",
"paymentError": "string",
"installmentNumber": 0,
"totalOfInstallments": 0,
"installmentAvailableDate": "string",
"isMultiInstallments": true,
"typedLabel": {
"id": "string",
"typeId": "string",
"typeLabel": "string",
"typeDescription": "string"
}
}
Result example 4xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Result example 5xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Alteração de Lançamentos Manuais
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
Body Parameters
| Campo |
Tipo |
Descrição |
| marketplaceId |
string |
(required) ID do pedido |
| tenant |
string |
(required) ID do seller |
| financialCycleId |
string |
(required) ID do ciclo |
| registersIds |
string array |
(optional) Array de IDs de registros para desbloqueio |
(GET) /register/order-financial-detail/{marketplaceId}
API Endpoint
https://api.omnik.io/v1/financial/register/order-financial-detail/{marketplaceId}
# Here is a curl example
curl --location 'https://api.omnik.io/v1/financial/register/order-financial-detail/{marketplaceId}' \
--header 'token: {token}' \
--header 'tenant: {tenant}' \
--header 'Content-Type: application/json'
Result example 2xx:
{
"orderId": "string",
"marketplaceId": "string",
"commissionOrigins": [
{
"sku": "string",
"commissionOrigin": "string",
"totalCommissionPercentage": number,
"totalCommissionValue": number,
"productCommissionPercentage": number,
"productCommissionValue": number,
"freightCommissionPercentage": number,
"freightCommissionValue": number,
"discountCommissionOrigins": []
}
],
"itensCommissionPercent": number,
"itensCommissionValue": number,
"freightCommissionPercent": number,
"freightCommissionValue": number,
"totalCommissionValue": number,
"financialCicleType": "string",
"financialTransferDaysAfterEndCicle": integer,
"discounts": [
{
"promotionId": "string",
"promotionName": "string",
"subsidyPercentMarketplace": number,
"subsidyValueMarketplace": number,
"subsidyPercentSeller": number,
"subsidyValueSeller": number
}
],
"totalTransferSeller": number,
"financialStatements": [
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"orderId": "string",
"marketplaceId": "string",
"siteId": "string",
"type": "string",
"status": "string",
"description": "string",
"releaseDate": "1970-01-01T00:00:00.000000",
"value": number,
"installmentNumber": integer,
"totalOfInstallments": integer,
"installmentAvailableDate": "1970-01-01T00:00:00.000000",
"isMultiInstallments": "boolean",
"typedLabel": {
"id": "string",
"typeId": "string",
"typeLabel": "string",
"typeDescription": "string"
},
"ivalue": number
}
]
}
Result example 4xx:
[
{
"field": "string",
"message": "string",
"timestamp": [
yyyy,
MM,
dd
]
}
]
Result example 5xx:
[
{
"field": "string",
"message": "string",
"timestamp": [
yyyy,
MM,
dd
]
}
]
Consulta de Lançamentos do Pedido
Path Parameters
| Campo |
Tipo |
Descrição |
| marketplaceId |
string |
(required) ID do Marketplace do Pedido |
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
| tenant |
string |
(required) ID do seller |
(POST) /commission/calculate/allSellers
API Endpoint
https://api.omnik.io/v1/commissioning/commission/calculate/allSellers
# Here is a curl example
curl --location 'https://api.omnik.io/v1/commissioning/commission/calculate/allSellers' \
--header 'token: {token}' \
--header 'Content-Type: application/json' \
--data '[
{
"id": "string",
"tenant": "string",
"operator": "string",
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"account": "string",
"orderData": {
"id": "string",
"orderDate": "1970-01-01T00:00:00.000000",
"status": "string",
"subStatus": "string",
"approvalDate": "1970-01-01T00:00:00.000000"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"hostname": "string"
},
"orderValuesData": {
"value": 0,
"discount": 0,
"interest": 0
},
"freightData": {
"chargedValue": 0,
"shippingChargedValue": 0,
"currentValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string"
},
"priceData": {
"unitPrice": 0,
"fromPrice": 0,
"price": 0,
"costPrice": 0,
"discountUnit": 0
},
"quantityData": {
"quantity": 1,
"quantityReturned": 0
},
"freightData": {
"chargedValue": 0,
"shippingChargedValue": 0,
"currentValue": 0
},
"catalogCategoryData": {
"channel": "string",
"id": "string",
"name": "string",
"fullName": "string"
}
}
],
"devolutionsData": [
{
"integrationId": "string",
"devolutionDate": "1970-01-01T00:00:00.000000",
"reason": "string",
"description": "string",
"moveStock": true,
"returnedItems": [],
"requestedIn": "1970-01-01T00:00:00.000000",
"finishedIn": "1970-01-01T00:00:00.000000",
"logisticsData": { "status": "string" }
}
],
"cancellationsData": [
{
"cancellationDate": "1970-01-01T00:00:00.000000",
"reason": "string",
"description": "string",
"moveStock": true,
"canceledItems": []
}
],
"postageData": {
"processingStatus": "string",
"finished": true,
"objects": [
{
"products": [
{ "product": "string" }
],
"declaredValue": 0,
"object": "string"
}
]
},
"paymentData": {
"formsPayments": [
{
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"generateReturnStatement": false
}
]'
Result example 2xx:
[
{
"id": "string",
"tenant": "string",
"hubTenant": "string",
"account": "string",
"orderId": "string",
"marketplaceId": "string",
"siteId": "string",
"costOfGoods": 0,
"freightCost": 0,
"interest": 0,
"discount": 0,
"items": [
{
"item": {
"skuData": {
"id": "string",
"sku": "string"
},
"priceData": {
"unitPrice": 0,
"fromPrice": 0,
"price": 0,
"costPrice": 0,
"discountUnit": 0
},
"quantityData": {
"quantity": 1,
"quantityReturned": 0
},
"freightData": {
"chargedValue": 0,
"shippingChargedValue": 0,
"currentValue": 0
}
},
"itemCost": 0,
"freightCost": 0,
"discount": 0,
"productCommission": {
"percentage": 0,
"ammount": 0
},
"freightCommission": {
"percentage": 0,
"ammount": 0
},
"totalCommission": {
"percentage": 0,
"ammount": 0
},
"fixedRuleApplied": {
"id": "string",
"name": "string",
"description": "string",
"isSellerContract": true,
"value": 0,
"valueFreight": 0,
"applyToShipping": true
},
"discountRulesApplied": [
{
"id": "string",
"name": "string",
"description": "string",
"isSellerContract": false,
"value": 0,
"valueFreight": 0,
"applyToShipping": false
}
]
}
],
"productCommission": {
"percentage": 0,
"ammount": 0
},
"freightCommission": {
"percentage": 0,
"ammount": 0
},
"totalCommission": {
"percentage": 0,
"ammount": 0
},
"isCached": false,
"isExternalCalculation": false,
"paidWithBonus": false
}
]
Result example 4xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Result example 5xx:
{
"statusCode": "0",
"logId": "string",
"name": "string",
"message": "string",
"fields": {
"additionalProp1": {
"message": "string"
}
}
}
Calcula as comissões para um lote de pedidos de múltiplos sellers. Recebe um array de pedidos, aplica as regras de comissionamento configuradas por seller/marketplace e retorna o detalhamento de comissão por item, incluindo a regra fixa aplicada e as regras de desconto utilizadas no cálculo.
Header Parameters
| Campo |
Tipo |
Descrição |
| token |
string |
(required) Authorization do seu Endpoint |
Body Parameters
Array de objetos de pedido. Cada elemento possui os campos abaixo:
| Campo |
Tipo |
Descrição |
| id | string | (optional) ID interno do pedido |
| tenant | string | (required) Tenant ID do seller |
| operator | string | (optional) Tenant ID do operador |
| createDate | string | (optional) Data de criação — pattern: yyyy-MM-dd'T'HH:mm:ss.SSSSSS |
| lastUpdate | string | (optional) Data de última atualização — pattern: yyyy-MM-dd'T'HH:mm:ss.SSSSSS |
| account | string | (optional) Conta do pedido |
| orderData.id | string | (optional) ID do pedido |
| orderData.orderDate | string | (required) Data do pedido — pattern: yyyy-MM-dd'T'HH:mm:ss.SSSSSS |
| orderData.status | string | (optional) Status do pedido |
| orderData.subStatus | string | (optional) Sub-status do pedido |
| orderData.approvalDate | string | (optional) Data de aprovação do pedido |
| marketplaceData.marketPlaceId | string | (required) ID do pedido no marketplace |
| marketplaceData.siteId | string | (required) ID do site/canal de venda |
| marketplaceData.marketplace | string | (required) Nome do marketplace |
| marketplaceData.hostname | string | (optional) Hostname do marketplace |
| orderValuesData.value | number | (required) Valor total do pedido |
| orderValuesData.discount | number | (optional) Valor de desconto |
| orderValuesData.interest | number | (optional) Valor de juros |
| freightData.chargedValue | number | (required) Valor de frete cobrado do cliente |
| freightData.shippingChargedValue | number | (optional) Valor cobrado pela transportadora |
| freightData.currentValue | number | (optional) Valor atual de frete |
| items[].skuData.id | string | (required) ID do SKU |
| items[].skuData.sku | string | (required) Código do SKU |
| items[].priceData.unitPrice | number | (required) Preço unitário |
| items[].priceData.fromPrice | number | (optional) Preço de origem |
| items[].priceData.price | number | (optional) Preço de venda |
| items[].priceData.costPrice | number | (optional) Preço de custo |
| items[].priceData.discountUnit | number | (optional) Desconto unitário |
| items[].quantityData.quantity | integer | (required) Quantidade (deve ser positivo) |
| items[].quantityData.quantityReturned | integer | (optional) Quantidade devolvida |
| items[].freightData.chargedValue | number | (required) Frete cobrado do item |
| items[].freightData.shippingChargedValue | number | (optional) Frete da transportadora |
| items[].freightData.currentValue | number | (optional) Frete atual do item |
| items[].catalogCategoryData.channel | string | (optional) Canal do catálogo |
| items[].catalogCategoryData.id | string | (optional) ID da categoria |
| items[].catalogCategoryData.name | string | (optional) Nome da categoria |
| items[].catalogCategoryData.fullName | string | (optional) Nome completo da hierarquia de categorias |
| devolutionsData[].integrationId | string | (required) ID de integração da devolução |
| devolutionsData[].devolutionDate | string | (required) Data da devolução |
| devolutionsData[].reason | string | (required) Motivo da devolução |
| devolutionsData[].description | string | (required) Descrição detalhada |
| devolutionsData[].moveStock | boolean | (required) Indica se movimenta estoque |
| devolutionsData[].returnedItems[] | array | (optional) Itens devolvidos — mesma estrutura de items[] |
| devolutionsData[].requestedIn | string | (optional) Data de solicitação |
| devolutionsData[].finishedIn | string | (optional) Data de conclusão |
| devolutionsData[].logisticsData.status | string | (optional) Status logístico da devolução |
| cancellationsData[].cancellationDate | string | (required) Data do cancelamento |
| cancellationsData[].reason | string | (required) Motivo do cancelamento |
| cancellationsData[].description | string | (required) Descrição detalhada |
| cancellationsData[].moveStock | boolean | (required) Indica se movimenta estoque |
| cancellationsData[].canceledItems[] | array | (optional) Itens cancelados — mesma estrutura de items[] |
| postageData.processingStatus | string | (required) Status de processamento da postagem |
| postageData.finished | boolean | (required) Indica se a postagem foi finalizada |
| postageData.objects[].products[].product | string | (required) Identificador do produto no objeto de postagem |
| postageData.objects[].declaredValue | number | (required) Valor declarado do objeto |
| postageData.objects[].object | string | (required) Código do objeto de postagem |
| paymentData.formsPayments[].formPaymentId | string | (required) ID da forma de pagamento |
| paymentData.formsPayments[].paymentConditionId | string | (required) ID da condição de pagamento |
| generateReturnStatement | boolean | (optional) Indica se deve gerar lançamento de estorno — default: false |
Response Body
Array com o resultado do cálculo de comissão para cada pedido enviado:
| Campo |
Tipo |
Descrição |
| id | string | ID do registro de comissão |
| tenant | string | Tenant ID do seller |
| hubTenant | string | Tenant ID do hub/operador |
| account | string | Conta associada |
| orderId | string | ID interno do pedido |
| marketplaceId | string | ID do pedido no marketplace |
| siteId | string | ID do site/canal de venda |
| costOfGoods | number | Custo total dos produtos (CMV) |
| freightCost | number | Custo total de frete do pedido |
| interest | number | Valor de juros aplicado |
| discount | number | Valor de desconto aplicado |
| items[].item.skuData.id | string | ID do SKU |
| items[].item.skuData.sku | string | Código do SKU |
| items[].item.priceData.unitPrice | number | Preço unitário |
| items[].item.priceData.fromPrice | number | Preço de origem |
| items[].item.priceData.price | number | Preço de venda |
| items[].item.priceData.costPrice | number | Preço de custo |
| items[].item.priceData.discountUnit | number | Desconto unitário |
| items[].item.quantityData.quantity | integer | Quantidade vendida |
| items[].item.quantityData.quantityReturned | integer | Quantidade devolvida |
| items[].item.freightData.chargedValue | number | Frete cobrado do item |
| items[].item.freightData.shippingChargedValue | number | Frete da transportadora |
| items[].item.freightData.currentValue | number | Frete atual do item |
| items[].itemCost | number | Custo do item (CMV) |
| items[].freightCost | number | Custo de frete do item |
| items[].discount | number | Desconto aplicado ao item |
| items[].productCommission.percentage | number | Percentual de comissão sobre produto |
| items[].productCommission.ammount | number | Valor de comissão sobre produto |
| items[].freightCommission.percentage | number | Percentual de comissão sobre frete |
| items[].freightCommission.ammount | number | Valor de comissão sobre frete |
| items[].totalCommission.percentage | number | Percentual total de comissão do item |
| items[].totalCommission.ammount | number | Valor total de comissão do item |
| items[].fixedRuleApplied.id | string | ID da regra fixa aplicada |
| items[].fixedRuleApplied.name | string | Nome da regra fixa |
| items[].fixedRuleApplied.description | string | Descrição da regra fixa |
| items[].fixedRuleApplied.isSellerContract | boolean | Indica se é regra do contrato do seller |
| items[].fixedRuleApplied.value | number | Percentual da regra sobre produto |
| items[].fixedRuleApplied.valueFreight | number | Percentual da regra sobre frete |
| items[].fixedRuleApplied.applyToShipping | boolean | Indica se a regra aplica ao frete |
| items[].discountRulesApplied[].id | string | ID da regra de desconto aplicada |
| items[].discountRulesApplied[].name | string | Nome da regra de desconto |
| items[].discountRulesApplied[].description | string | Descrição da regra de desconto |
| items[].discountRulesApplied[].isSellerContract | boolean | Indica se é regra do contrato do seller |
| items[].discountRulesApplied[].value | number | Percentual da regra sobre produto |
| items[].discountRulesApplied[].valueFreight | number | Percentual da regra sobre frete |
| items[].discountRulesApplied[].applyToShipping | boolean | Indica se a regra aplica ao frete |
| productCommission.percentage | number | Percentual total de comissão sobre produtos do pedido |
| productCommission.ammount | number | Valor total de comissão sobre produtos do pedido |
| freightCommission.percentage | number | Percentual total de comissão sobre frete do pedido |
| freightCommission.ammount | number | Valor total de comissão sobre frete do pedido |
| totalCommission.percentage | number | Percentual total de comissão do pedido |
| totalCommission.ammount | number | Valor total de comissão do pedido |
| isCached | boolean | Indica se o resultado veio de cache |
| isExternalCalculation | boolean | Indica se o cálculo foi feito por engine externa |
| paidWithBonus | boolean | Indica se o pagamento utilizou Vale Bônus |