Campo | Tipo | Obrigatório | Informações | Exemplo de preenchimento | Valor fixo |
| CompanyId | String(50) | Sim | Numero da companhia/grupo da loja.
No LIVE é o código da Master | "CompanyId": "220000002" |
|
BranchId | String(50) | Sim | Numero da Unidade de negócio(Loja) que está fazendo o Pedido. No LIVE é o número de série da loja. | "BranchId": "9017986" |
|
| CustomerOrderId | String(64) | Sim | Numero do pedido no sistema que está chamando | "CustomerOrderId":"v82908980bot-01" |
|
| RegisterDate | DateTime | Sim | Data de Inclusão do Pedido | "RegisterDate":"2019-05-27T00:00:00" |
|
| OrderId | String(64) | Sim | Numero do Pedido | "OrderId":"v82908980bot-01" |
|
| RegisterHour | String(10) | Sim | Hora de Inclusão do Pedido | "RegisterHour":"19:05:44" |
|
| dhinidelivery | DateTime | Não | Data Inicial de Entrega | "dhinidelivery": "2020-08-04T21:19:55.801Z" |
|
| dhfindelivery | DateTime | Não | Data Final de Entrega | "dhfindelivery": "2020-08-04T21:19:55.801Z" |
|
| FreightType | Integer | Não | Tipo de Frete :
1 - CIF 2 - FOB 3 - SFT | "FreightType": "1" |
|
| FreightValue | Decimal | Não | Valor do Frete | "FreightValue": 0 |
|
| Finality | Integer | Não | Finalidade :
1 - Contribuinte ICMS (Indústria/Comércio) 2 - Não-contribuinte ICMS | "Finality": "1" |
|
| InsuranceValue | Decimal | Não | Valor do Seguro (Conta e Ordem) | "InsuranceValue": 0 |
|
| ExpenseValue | Decimal | Não | Valor de Despesas Acessórias | "ExpenseValue": 0 |
|
| SalesChannel | String(128) | Não | Canal da operação do Pedido.
Para o LIVE atualmente é valor fixo "Omni". | "SalesChannel":"Omni" | "SalesChannel":" Omni" |
| SalesChannelInternalId | String(128) | Não | Canal da operação do Pedido. Para o LIVE atualmente é valor fixo "Omni". | "SalesChannelInternalId": "OMNI" | "SalesChannelInternalId": "OMNI" |
| Segment | String(50) | Não | Descrição da Modalidade | "Segment": "" | "Segment": "" |
| Gift | Bit | Não | Identifica se o pedido é para presente 1 - Sim 0 - Não | "Gift": 1 | "Gift": 1 |
| Status | Integer | Sim | Status do Pedido : No Processo tradicional o status deve ser enviado com valor "1". Mas caso o sistema externo fará também o processo de separação, poderá enviar ao LIVE com o Status "90".
Em Aberto = 1,
Bloqueado = 2,
Liberado = 3,
Liberado Financeiro = 4,
Liberado Financeiro Comercial = 5,
Suspenso = 6,
Cancelado = 7,
Pedido Recebido = 90,
Confirmado Loja = 91,
Faturado = 92,
Em Faturamento = 93,
Em Separação = 94,
Pedido Devolvido = 100 | "Status":90 |
|
| dhinidelivery | DateTime | Não | Data de Inicio de Entrega | "dhinidelivery": "2020-03-27T21:19:55.801Z" |
|
| dhfindelivery | DateTime | Não | Data de Fim de Entrega | "dhfindelivery": "2020-03-27T21:19:55.801Z" |
|
| CustomerCode | String(64) | Não | Identificação do Cliente, usado para informar o CPF. | "CustomerCode":"20103464832" |
|
| CustomerEmail | String(50) | Não | Email do Cliente | "CustomerEmail": "123456789@email.com" |
|
| CustomerLoyality | Boolean | Não | Identificação de venda para cliente fidelidade : true : sim false : não | "CustomerLoyalty": false |
|
| CustomerTelephone | String(15) | Não | Telefone do Cliente | "CustomerTelephone": "123456789" |
|
| CustomerGovInfo | Objeto | Não | Informações Governamentais do Cliente | "CustomerGovInfo": {
"Id": [
{}
],
"scope": "Federal",
"name": "Cliente ABC",
"issueOn": "2019-01-24T21:19:55.802Z",
"expiresOn": "2019-01-24T21:19:55.802Z"
} |
|
| DeliveryCustomerCode | String(15) | Não | Codigo do Cliente cliente que fará a retirada | "DeliveryCustomerCode": "98765432109" |
|
| DeliveryCustomerGovernmentalInformation | Objeto | Não | Informações Governamentais do Cliente que fará a retirada | "DeliveryCustomerGovernmentalInformation": {
"Id": [
{}
],
"scope": "Federal",
"name": "Cliente ABC Retirada",
"issueOn": "2019-01-24T21:19:55.802Z",
"expiresOn": "2019-01-24T21:19:55.802Z"
} |
|
| DeliveryInfo | Objeto | Não | Dados de Entrega | "DeliveryInfo": {
"DeliveryTelephone": "(011)123456789",
"BillingLocationGovernmentalInfo": "123456789-01",
"DeliveryAddress": "Rua das tamareiras",
"DeliveryNumber": 1300,
"DeliveryNeighborhood": "BAIRRO da TOCA",
"DeliveryComplement": "TOCA 10",
"DeliveryCep": "132000-123",
"DeliveryCity": "JUNDIAÍ City",
"DeliveryState": "SP",
"DeliveryCountry": "BRASIL"
} |
|
| FreightInfo | Objeto | Não | Dados do Frete | "FreightInfo": {
"CarrierGovernmentalInfo": "123456789-01",
"CarrierCode": "2424",
"CarrierName": "NOME DO ENTREGADOR",
"FreightType": 1,
"FreightValue": 10.0
} |
|
| TypeDelivery | String(100) | Não | Tipo de Entrega/Retirada | "TypeDelivery": "Retira Loja" |
|
| OrderItemAmount | Decimal | Não | Valor total liquido dos itens do pedido | "OrderItemAmount":10.90 |
|
| TotalPercentageOfOrderDiscount | Decimal | Não | Percentual de desconto total do pedido | "TotalPercentageOfOrderDiscount": 0 |
|
| OrderPayments | Lista de Objetos | Não | Formas de Pagamento do Pedido | "OrderPayments": [
{
"PaymentTermCode": "33",
"DescConditionpay": "Cartão - Crédito",
"Portion": "3",
"PaymentAmount": "600.00",
"NSU": "12345678901234567890",
"Authorization": "98765432109876543210",
"FlagIdentifier": "BANDEIRA",
"BinIdentifier": "CARTÃO",
"NetworkIdentifier": "CIELO"
},
{
"PaymentTermCode": "44",
"DescConditionpay": "Cartão Débito",
"Portion": "1",
"PaymentAmount": "125.00",
"NSU": "123456789Z123456789X",
"Authorization": "Z#W23456789Z123456789X",
"FlagIdentifier": "IDENTIFICADOR",
"BinIdentifier": "BINDOCARTAO",
"NetworkIdentifier": "MASTERCARD"
}
] |
|
| SalesOrderItens | Objeto | Sim | A lista dos Itens do Pedido | "SalesOrderItens":{
"Item":[
{
"CompanyId":"220000002",
"BranchId":"9017986",
"OrderId":0,
"OrderItem":"1",
"typecodprod":0,
"ItemCode":"72056",
"Quantity":1.0,
"typepacking":0,
"UnityPrice":10.9,
"netunitaryprice":10.9,
"TotalPrice":10.9
}
]
} |
|
| SUMMARY | Objeto | Sim | Sumário de totalização do Pedido | "SUMMARY": {
"ordertotalnetamount": 1428.36,
"valtotipimerchan": 0,
"discountamount": 8.36,
"valtottaxes": 0,
"valtotdesccomm": 0,
"valtotaacesscost": 0,
"valtotacessnottaxes": 0,
"ordertotalamount": 1420.00,
"valtotbonus": 0,
"numtotpacking": 0,
"OTHER": "string" } |
|
