Log In

Este hook é disparado para confirmar que o pedido foi cadastrado

CampoTipoDescrição
orderNumberstringIdentificador do pedido.
sellerOrderNumberstringIdentificador do pedido na loja.
deliveryDatestringPrevisão de entrega do item
createdOnstringData de venda do pedido.
storeIdintIdentificador único da loja no Nexp
storeNamestringNome da loja física
progressstringStatus do pedido no Nexp
shippingobject (see below)Informações sobre entrega
itemsobject (see below)Lista de itens do pedido.
paymentsobject (see below)Lista de pagamentos do pedido.

Shipping

CampoTipoDescrição
namestringNome do destinatário
emailstringEmail do destinatário
phonestringTelefone do comprador
documentstringDocumento do comprador
addressLinestringEndereço de entrega
numberstringNúmero do endereço de entrega
postalCodestringCep do endereço de entrega
neighborhoodstringBairro do endereço de entrega
citystringCidade do endereço de entrega
statestringEstado do endereço de entrega
complementstringComplemento do endereço de entrega
referencestringObservação do comprador para ajudar na entrega
latdecimalLatitude do endereço de entrega
longdecimalLongitude do endereço de entrega

Items

CampoTipoDescrição
uniqueIdstringIdentificador único do item
deliveryDatestringPrevisão de entrega do item
endDeliveryDatestringPrevisão final de entrega do item, caso o cliente tenha escolhido uma janela de entrega
deliveryTypestringTipo de entrega
deliveryChannelstringCanal de entrega do item (delivery ou pickup)
skustringIdentificador único do produto no catálogo do cliente
eanstringCódigo de barras do produto
keystringIdentificador único do produto
quantitydecimalQuantidade do item
unitValuedecimalValor unitário do item
discountdecimalDesconto total do item, caso tenha mais de uma quantidade esse desconto é aplicado sobre o total de quantidades.
freightValuedecimalValor do frete do item
grossValuedecimalValor total bruto do item
netValuedecimalValor total liquido do item
shippingCompanyobject (see below)Dados da transportadora

Shipping Company

CampoTipoDescrição
namestringNome da transportadora
externalCodestringCódigo único da transportadora
statusstringSituação de cadastro da transportadora

Payments

CampoTipoDescrição
paymentIdstringInformações referente ao pagamento
paymentMethodstringMétodo de pagamento
installmentCountintQuantidade de parcelas do método de pagamento
installmentValuedecimalValor da parcela
valuedecimalValor total deste pagamento
transactionIdstringIdentificador da transação tid
extrasobjectDetalhes retornados pelo gateway de pagamento

Exemplo de retorno em caso de sucesso na integração.

{
    "ordernumber": "xxxxxxxxx",
    "sellerOrderNumber": "mkt-xxxxxxxxx",
    "storeId": 99,
    "storeName": "Angélica",
    "createdAt": "2022-01-01T10:00:00Z",
    "createdOn": "2022-01-01T10:00:00Z",
    "deliveryDate": "2022-01-10T10:00:00Z",
    "progress": "Waiting",
    "shipping": {
        "lat": 10.000,
        "lon": -10.00,
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "+5511999999999",
        "document": "00000000000",
        "addressLine": "Av. Angélica",
        "number": "2529",
        "postalCode": "01227200",
        "neighborhood": "Consolação",
        "city": "São Paulo",
        "state": "SP",
        "complement": "sala xx",
        "reference": "próximo a estação do metrô",
        "formattedAddress": "Av. Angélica, 2529 - Consolação, São Paulo - SP, 01227-200"
    },
    "items": [
        {
            "uniqueId": "xxxx",
            "deliveryDate": "2022-01-10T10:00:00Z",
            "endDeliveryDate": "2022-01-10T12:00:00Z",
            "deliveryModeName": "regular",
            "deliveryType": "Rápida",
            "deliveryChannel": "delivery",
            "sku": "1566",
            "ean": "1567",
            "key": "1566",
            "quantity": 4,
            "unitValue": 3.19,
            "freightValue": 1.25,
            "grossValue": 12.76,
            "netValue": 12.76,
            "discount": 0.00,
            "shippingCompany": {
                "name": "Correios",
                "externalCode": "xxxxx",
                "status": "Active"
            }
        }
    ],
    "payments": {
        "paymentMethod": "creditCard",
        "type": "creditCard",
        "paymentId": "xxxxx",
        "maskedCardNumber": "1234xxxxxxx",
        "transactionId": "xxxxxxxxx",
        "value": 100.00,
        "installmentValue": 100.00,
        "installmentCount": 1,
        "extras": {
            "returnCode": "00",
            "message": "Transacao autorizada",
            "authId": "000000",
            "nsu": "000000"
        }
    }
}