Este hook é disparado para confirmar que o pedido foi cadastrado
Campo | Tipo | Descrição |
---|---|---|
orderNumber | string | Identificador do pedido. |
sellerOrderNumber | string | Identificador do pedido na loja. |
deliveryDate | string | Previsão de entrega do item |
createdOn | string | Data de venda do pedido. |
storeId | int | Identificador único da loja no Nexp |
storeName | string | Nome da loja física |
progress | string | Status do pedido no Nexp |
shipping | object (see below) | Informações sobre entrega |
items | object (see below) | Lista de itens do pedido. |
payments | object (see below) | Lista de pagamentos do pedido. |
Shipping
Campo | Tipo | Descrição |
---|---|---|
name | string | Nome do destinatário |
string | Email do destinatário | |
phone | string | Telefone do comprador |
document | string | Documento do comprador |
addressLine | string | Endereço de entrega |
number | string | Número do endereço de entrega |
postalCode | string | Cep do endereço de entrega |
neighborhood | string | Bairro do endereço de entrega |
city | string | Cidade do endereço de entrega |
state | string | Estado do endereço de entrega |
complement | string | Complemento do endereço de entrega |
reference | string | Observação do comprador para ajudar na entrega |
lat | decimal | Latitude do endereço de entrega |
long | decimal | Longitude do endereço de entrega |
Items
Campo | Tipo | Descrição |
---|---|---|
uniqueId | string | Identificador único do item |
deliveryDate | string | Previsão de entrega do item |
endDeliveryDate | string | Previsão final de entrega do item, caso o cliente tenha escolhido uma janela de entrega |
deliveryType | string | Tipo de entrega |
deliveryChannel | string | Canal de entrega do item (delivery ou pickup) |
sku | string | Identificador único do produto no catálogo do cliente |
ean | string | Código de barras do produto |
key | string | Identificador único do produto |
quantity | decimal | Quantidade do item |
unitValue | decimal | Valor unitário do item |
discount | decimal | Desconto total do item, caso tenha mais de uma quantidade esse desconto é aplicado sobre o total de quantidades. |
freightValue | decimal | Valor do frete do item |
grossValue | decimal | Valor total bruto do item |
netValue | decimal | Valor total liquido do item |
shippingCompany | object (see below) | Dados da transportadora |
Shipping Company
Campo | Tipo | Descrição |
---|---|---|
name | string | Nome da transportadora |
externalCode | string | Código único da transportadora |
status | string | Situação de cadastro da transportadora |
Payments
Campo | Tipo | Descrição |
---|---|---|
paymentId | string | Informações referente ao pagamento |
paymentMethod | string | Método de pagamento |
installmentCount | int | Quantidade de parcelas do método de pagamento |
installmentValue | decimal | Valor da parcela |
value | decimal | Valor total deste pagamento |
transactionId | string | Identificador da transação tid |
extras | object | Detalhes 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"
}
}
}