Pré-requisitos
Campos de retorno
Abaixo sera apresentado os campos existentes no método e informações de uso.
Obs : Os campos não constantes nas tabelas podem ser preenchidos conforme a o exemplo de chamada no fim do documento
DtoOrder
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 : 2 - FOB 3 - SFT | "FreightType": "1" | |
FreightValue | Decimal | Não | Valor do Frete | "FreightValue": 0 | |
Finality | Integer | Não | Finalidade : 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". | "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": { | |
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": { | |
DeliveryInfo | Objeto | Não | Dados de Entrega | "DeliveryInfo": { | |
FreightInfo | Objeto | Não | Dados do Frete | "FreightInfo": { | |
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": [ | |
SalesOrderItens | Objeto | Sim | A lista dos Itens do Pedido | "SalesOrderItens":{ | |
SUMMARY | Objeto | Sim | Sumário de totalização do Pedido | "SUMMARY": { |
OrderPayment
Campo | Tipo | Obrigatório | Informações | Exemplo de preenchimento | Valor fixo |
PaymentTermCode | Integer | Não | Codigo da Forma de Pagamento Para o LIVE: 81 - TEF CREDITO | "PaymentTermCode": "81" | |
DescConditionpay | String(50) | Não | Descrição da Forma de Pagamento | "DescConditionpay": "TEF CREDITO" | |
Portion | Integer | Não | Número total de parcelas | "Portion": "3" | |
PaymentAmount | Decimal | Não | Valor Total do Pagamento | "PaymentAmount": "600.00" | |
NSU | String(50) | Não | NSU da transação feita no TEF ou Similar | "NSU": "511550" | |
Authorization | String(50) | Não | Número da identificação da transação | "Authorization": "PAY-K179Q152ZDUL" | |
FlagIdentifier | String(50) | Não | Bin da bandeira usada na transação | "FlagIdentifier": "00002" | |
BinIdentifier | String(50) | Não | Bin da transação | "BinIdentifier": "123456" | |
NetworkIdentifier | String(50) | Não | Indetificador da Rede usada | "NetworkIdentifier": "001" |
DeliveryInfo
Campo | Tipo | Obrigatório | Informações | Exemplo de preenchimento | Valor fixo |
DeliveryTelephone | String(15) | Não | Telefone de Entrega | "DeliveryTelephone": "(011)123456789" | |
BillingLocationGovernmentalInfo | String(18) | Não | Informação Governamental de Entrega | "BillingLocationGovernmentalInfo": "123456789-01" | |
DeliveryAddress | String(200) | Não | Endereço de Entrega | "DeliveryAddress": "Endereço de Entrega do Ronaldo Nova TAG Joaquim Barboza da Silva costa Larga Frederico Ambrozio" | |
DeliveryNumber | String(30) | Não | Número do Endereço de Entrega | "DeliveryNumber": 1300 | |
DeliveryNeighborhood | String(70) | Não | Bairro de Entrega | "DeliveryNeighborhood": "BAIRRO da TOCA" | |
DeliveryComplement | String(80) | Não | Complemento de Entrega | "DeliveryComplement": "TOCA 10" | |
DeliveryCep | String(10) | Não | Cep de Entrega | "DeliveryCep": "132000-123" | |
DeliveryCity | String(50) | Não | Cidade de Entrega | "DeliveryCity": "JUNDIAÍ City" | |
DeliveryState | String(4) | Não | Estado de Entrega | "DeliveryState": "SP" | |
DeliveryCountry | String(50) | Não | País de Entrega | "DeliveryCountry": "BRASIL" |
FreightInfo
Campo | Tipo | Obrigatório | Informações | Exemplo de preenchimento | Valor fixo |
CarrierGovernmentalInfo | String(30) | Não | Informação Governamental do Entregador | "CarrierGovernmentalInfo": "123456789-01" | |
CarrierCode | String(50) | Não | Código do Entregador | "CarrierCode": "2424" | |
CarrierName | String(200) | Não | Nome do Entregador | "CarrierName": "NOME DO ENTREGADOR" | |
FreightType | Integer | Não | Tipo de Frete : 2 - FOB 3 - SFT | "FreightType": 1 | |
FreightValue | Decimal | Não | Valor do Frete | "FreightValue": 10.0 |
SalesOrderItens : Item
Campo | Tipo | Obrigatório | Informações | Exemplo de preenchimento | Valor fixo |
CompanyId | String(50) | Sim | Numero da Master do Live | "CompanyId": "220000002" | |
BranchId | String(50) | Sim | Numero da Unidade de negócio(Loja) que está fazendo o Pedido | "BranchId": "9017986" | |
OrderId | String | Sim | Numero do Pedido | "OrderId":"v82908980bot-01" | |
OrderItem | String(64) | Sim | Numero sequencial da lista de Itens | "OrderItem":"1" | |
ItemCode | String(64) | Sim | Código do Produto | "ItemCode":"72056" | |
ItemDescription | String(1000) | Sim | Descrição do Produto | "ItemDescription": "Produto Teste Order - 4517186557618" | |
Quantity | Decimal | Sim | Quantidade | "Quantity":1.0 | |
UnityPrice | Decimal | Sim | Preço Unitário | "UnityPrice":10.9 | |
Netunitaryprice | Decimal | Sim | PreçoUnitario Liquido | "netunitaryprice": 0 | |
TotalPrice | Decimal | Sim | Valor Total do Item | "TotalPrice":10.9 | |
TaxOpCode | String(64) | Sim | Codigo da Fiscal da Operacao - CFOP | "TaxOpCode":"0" | |
DiscountPercentage | Decimal | Sim | Percentual de desconto do item | "DiscountPercentage": 0 | |
Valnetlineitem | Decimal | Sim | Gets or Sets Valnetlineitem | "valnetlineitem": 0 | |
FreightValue | Decimal | Sim | Valor do unitário do frete | "FreightValue": 0 | |
InsuranceValue | Decimal | Sim | Valor do Seguro Unitário | "InsuranceValue": 0 | |
Observation | String(1000) | Sim | Observações Item do Pedido | "Observation":"" | |
DiscountTotalValue | Decimal | Sim | Valor desconto total | "DiscountTotalValue": 0 | |
DeliveryDate | DateTime | Sim | Data de Entrega ou Previsão de entrega do item | "DeliveryDate": "2019-01-24T21:19:55.807Z" |
SUMMARY
Campo | Tipo | Obrigatório | Informações | Exemplo de preenchimento | Valor fixo |
Ordertotalnetamount | Decimal | Sim | Total Líquido do Pedido | "ordertotalnetamount": 1428.36 | |
Discountamount | Decimal | Sim | Total de Desconto | "discountamount": 8.36 | |
Valtottaxes | Decimal | Sim | Total de Impostos | "valtottaxes": 0 | |
Ordertotalamount | Decimal | Sim | Total do pedido | "ordertotalamount": 1420.00 |
Exemplo de Chamada do Método
{ "CompanyId": "220000287", "CompanyInternalId": "220000287", "BranchId": "081716508", "OrderPurpose": "1", "CustomerOrderId": "04082020Status_90E", "RegisterDate": "2020-08-04T21:19:55.801Z", "OrderId": "04082020Status_90E", "RegisterHour": "14", "dhinidelivery": "2020-08-04T21:19:55.801Z", "dhfindelivery": "2020-08-04T21:19:55.801Z", "RequestDate": "2020-08-04T21:19:55.801Z", "FreightType": "1", "FreightValue": 0, "NetWeight": 0, "GrossWeight": 0, "TareWeight": 0, "CubicVolume": 0, "NumberOfVolumes": 0, "Finality": "1", "InsuranceValue": 0, "ExpenseValue": 0, "AdditionValue": 0, "SalesChannel": "", "SalesChannelInternalId": "OMNI", "Segment": "", "Gift": 1, "Status": 90, "VendorGovInfo": { "Id": [ {} ], "scope": "Federal", "issueOn": "2019-01-24T21:19:55.802Z", "expiresOn": "2019-01-24T21:19:55.802Z" }, "CustomerCode": "34470084824", "CustomerEmail": "[email protected]", "CustomerLoyalty": false, "CustomerTelephone": "123456789", "CustomerGovInfo": { "Id": [ {} ], "scope": "Federal", "name": "Cliente ABC", "issueOn": "2019-01-24T21:19:55.802Z", "expiresOn": "2019-01-24T21:19:55.802Z" }, "DeliveryCustomerCode": "98765432109", "DeliveryCustomerGovernmentalInformation": { "Id": [ {} ], "scope": "Federal", "name": "Cliente ABC Retirada", "issueOn": "2019-01-24T21:19:55.802Z", "expiresOn": "2019-01-24T21:19:55.802Z" }, "DeliveryInfo": { "DeliveryTelephone": "(011)123456789", "BillingLocationGovernmentalInfo": "123456789-01", "DeliveryAddress": "Endereço de Entrega do Ronaldo Nova TAG Joaquim Barboza da Silva costa Larga Frederico Ambrozio", "DeliveryNumber": 1300, "DeliveryNeighborhood": "BAIRRO da TOCA", "DeliveryComplement": "TOCA 10", "DeliveryCep": "132000-123", "DeliveryCity": "JUNDIAÍ City", "DeliveryState": "SP", "DeliveryCountry": "BRASIL" }, "FreightInfo": { "CarrierGovernmentalInfo": "123456789-01", "CarrierCode": "2424", "CarrierName": "NOME DO ENTREGADOR", "FreightType": 1, "FreightValue": 10.0 }, "TypeDelivery": "Retira Loja", "BillingLocationGovInfo": { "Id": [ {} ], "scope": "Federal", "issueOn": "2019-01-24T21:19:55.802Z", "expiresOn": "2019-01-24T21:19:55.802Z" }, "CarrierGovInfo": { "Id": [ {} ], "scope": "Federal", "issueOn": "2019-01-24T21:19:55.802Z", "expiresOn": "2019-01-24T21:19:55.802Z" }, "OrderItemAmount": 0, "TotalPercentageOfOrderDiscount": 0, "IsDiscountTableUsedInThisOrder": true, "ValuePackaging": 0, "priority": 0, "Discounts": { "Discount": [ {} ] }, "FinancialDiscount": 0, "TotalDiscount": 0, "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" } ], "PAYMENTPLAN": [ { "datereference": "2019-01-24T21:19:55.804Z", "periodnum": 0, "termduedate": "2019-01-24T21:19:55.804Z", "termamount": 0, "termpaymentpercentage": 0 } ], "LISTOFTAXESDOCUMENT": [ { "VALUESANDTAXES": [ { "percdescandtaxes": 0, "valuedescandtaxes": 0 } ] } ], "SalesOrderItens": { "Item": [ { "CompanyId": "220000287", "BranchId": "9010982", "OrderId": "1502", "OrderItem": "1", "numitemrequest": 0, "typecodprod": "EN", "ItemCode": "4517186557618", "ItemDescription": "Produto Teste Order - 4517186557618", "numunitconsembped": 0, "Quantity": 5, "amountsubsid": 0, "quantexchange": 0, "typepacking": "AE", "numpacking": 0, "UnityPrice": 79.36, "netunitaryprice": 0, "baseunitprice": 0, "TotalPrice": 396.80, "DiscountPercentage": 0, "valnetlineitem": 0, "unitvaltradedisc": 0, "perccommdiscount": 0, "bonusdiscountvalue": 0, "bonuspercentage": 0, "valipi": 0, "industrializedproducttaxpercentage": 0, "servicesandproductscirculationtaxpercentage": 0, "precenticmssubst": 0, "unitvalacesscost": 0, "unitvalnotacesscost": 0, "ItemDiscounts": { "ItemDiscount": [ {} ] }, "FreightValue": 0, "InsuranceValue": 0, "UnitWeight": 0, "ItemMessages": { "ItemMessage": [ {} ] }, "convumprovider": 0, "ListOfReturnedInputDocuments": [ [ { "InputDocumentQuantity": 0 } ] ], "LISTOFTAXESITEM": [ [ { "VALUESANDTAXES": [ { "percdescandtaxes": 0, "valuedescandtaxes": 0 } ] } ] ], "PriceOfPriceTable": 0, "Event": "delete", "ListOfApportionOrderItem": [ { "Value": 0, "Percentual": 0, "Quantity": 0, "Event": "delete" } ], "RetentionValue": 0, "DeductionValue": 0, "DirectDeductionValue": 0, "AmountBilled": 0, "AmountRequested": 0, "AmountAttended": 0, "DiscountTotalValue": 0, "DeliveryDate": "2019-01-24T21:19:55.807Z" } ], "Item": [ { "CompanyId": "220000287", "BranchId": "081716508", "OrderId": "1502", "OrderItem": "2", "numitemrequest": 0, "typecodprod": "EN", "ItemCode": "4500176548512", "ItemDescription": "Produto Teste Order - 4500176548512", "numunitconsembped": 0, "Quantity": 10, "amountsubsid": 0, "quantexchange": 0, "typepacking": "AE", "numpacking": 0, "UnityPrice": 79.36, "netunitaryprice": 0, "baseunitprice": 0, "TotalPrice": 793.60, "DiscountPercentage": 0, "valnetlineitem": 0, "unitvaltradedisc": 0, "perccommdiscount": 0, "bonusdiscountvalue": 0, "bonuspercentage": 0, "valipi": 0, "industrializedproducttaxpercentage": 0, "servicesandproductscirculationtaxpercentage": 0, "precenticmssubst": 0, "unitvalacesscost": 0, "unitvalnotacesscost": 0, "ItemDiscounts": { "ItemDiscount": [ {} ] }, "FreightValue": 0, "InsuranceValue": 0, "UnitWeight": 0, "ItemMessages": { "ItemMessage": [ {} ] }, "convumprovider": 0, "ListOfReturnedInputDocuments": [ [ { "InputDocumentQuantity": 0 } ] ], "LISTOFTAXESITEM": [ [ { "VALUESANDTAXES": [ { "percdescandtaxes": 0, "valuedescandtaxes": 0 } ] } ] ], "PriceOfPriceTable": 0, "Event": "delete", "ListOfApportionOrderItem": [ { "Value": 0, "Percentual": 0, "Quantity": 0, "Event": "delete" } ], "RetentionValue": 0, "DeductionValue": 0, "DirectDeductionValue": 0, "AmountBilled": 0, "AmountRequested": 0, "AmountAttended": 0, "DiscountTotalValue": 0, "DeliveryDate": "2019-01-24T21:19:55.807Z" } ], "Item": [ { "CompanyId": "220000287", "BranchId": "081716508", "OrderId": "1502", "OrderItem": "3", "numitemrequest": 0, "typecodprod": "EN", "ItemCode": "4517145084728", "ItemDescription": "Produto Teste Order 4517145084728", "numunitconsembped": 0, "Quantity": 1, "amountsubsid": 0, "quantexchange": 0, "typepacking": "AE", "numpacking": 0, "UnityPrice": 79.36, "netunitaryprice": 0, "baseunitprice": 0, "TotalPrice": 79.36, "DiscountPercentage": 0, "valnetlineitem": 0, "unitvaltradedisc": 0, "perccommdiscount": 0, "bonusdiscountvalue": 0, "bonuspercentage": 0, "valipi": 0, "industrializedproducttaxpercentage": 0, "servicesandproductscirculationtaxpercentage": 0, "precenticmssubst": 0, "unitvalacesscost": 0, "unitvalnotacesscost": 0, "ItemDiscounts": { "ItemDiscount": [ {} ] }, "FreightValue": 0, "InsuranceValue": 0, "UnitWeight": 0, "ItemMessages": { "ItemMessage": [ {} ] }, "convumprovider": 0, "ListOfReturnedInputDocuments": [ [ { "InputDocumentQuantity": 0 } ] ], "LISTOFTAXESITEM": [ [ { "VALUESANDTAXES": [ { "percdescandtaxes": 0, "valuedescandtaxes": 0 } ] } ] ], "PriceOfPriceTable": 0, "Event": "delete", "ListOfApportionOrderItem": [ { "Value": 0, "Percentual": 0, "Quantity": 0, "Event": "delete" } ], "RetentionValue": 0, "DeductionValue": 0, "DirectDeductionValue": 0, "AmountBilled": 0, "AmountRequested": 0, "AmountAttended": 0, "DiscountTotalValue": 3.60, "DeliveryDate": "2019-01-24T21:19:55.807Z" } ], "Item": [ { "CompanyId": "220000002", "BranchId": "081716508", "OrderId": "1502", "OrderItem": "4", "numitemrequest": 0, "typecodprod": "EN", "ItemCode": "4507616518210", "ItemDescription": "Produto Teste Order - 4507616518210", "numunitconsembped": 0, "Quantity": 2, "amountsubsid": 0, "quantexchange": 0, "typepacking": "AE", "numpacking": 0, "UnityPrice": 79.30, "netunitaryprice": 0, "baseunitprice": 0, "TotalPrice": 158.60, "DiscountPercentage": 0, "valnetlineitem": 0, "unitvaltradedisc": 0, "perccommdiscount": 0, "bonusdiscountvalue": 0, "bonuspercentage": 0, "valipi": 0, "industrializedproducttaxpercentage": 0, "servicesandproductscirculationtaxpercentage": 0, "precenticmssubst": 0, "unitvalacesscost": 0, "unitvalnotacesscost": 0, "ItemDiscounts": { "ItemDiscount": [ {} ] }, "FreightValue": 0, "InsuranceValue": 0, "UnitWeight": 0, "ItemMessages": { "ItemMessage": [ {} ] }, "convumprovider": 0, "ListOfReturnedInputDocuments": [ [ { "InputDocumentQuantity": 0 } ] ], "LISTOFTAXESITEM": [ [ { "VALUESANDTAXES": [ { "percdescandtaxes": 0, "valuedescandtaxes": 0 } ] } ] ], "PriceOfPriceTable": 0, "Event": "delete", "ListOfApportionOrderItem": [ { "Value": 0, "Percentual": 0, "Quantity": 0, "Event": "delete" } ], "RetentionValue": 0, "DeductionValue": 0, "DirectDeductionValue": 0, "AmountBilled": 0, "AmountRequested": 0, "AmountAttended": 0, "DiscountTotalValue": 0, "DeliveryDate": "2019-01-24T21:19:55.807Z" } ] }, "SUMMARY": { "ordertotalnetamount": 1428.36, "valtotipimerchan": 0, "discountamount": 8.36, "valtottaxes": 0, "valtotdesccomm": 0, "valtotaacesscost": 0, "valtotacessnottaxes": 0, "ordertotalamount": 1420.00, "valtotbonus": 0, "numtotpacking": 0, }, "ListOfCreditDocument": [ { "Value": 0 } ]}
{ "idUnicoDuplicado": false, "sucesso": true }