API Reference
Log In
API Reference

Este hook dispara quando o pedido é enviado para transportadora

CampoTipoDescrição
orderNumberstringIdentificador do pedido.
sellerOrderNumberstringIndicador do pedido para a loja.
trackingCodesarrayCódigos de rastreio.
shippingCompanyCodestringIdentificador único da transportadora.
shippingCompanyNamestringNome da transportadora.
invoiceNumberstringNúmero da nota fiscal.
invoiceKeystringChave da nota fiscal.
invoiceValuedecimalValor da nota fiscal
trackingUrlstringUrl de tracking de transporte
storeTrackingCodestringCódigo único da loja
extrasobjectObjeto com informações adicionais do pedid
attachmentsarray
attachments[].typestringTipo do anexo (DANFE, XML, Other)
attachments[].urlstringUrl do anexo
attachments[].contentstringConteúdo do anexo

Exemplo do corpo da requisição que será enviada.

{
   "orderNumber":"xxxxxxxxx",
   "sellerOrderNumber":"xxxxxxxxx",
   "shippingCompanyCode":"xxxxx",
   "shippingCompanyName":"transportadora",
   "invoiceNumber":"000000000",
   "invoiceKey":"000000000000000000000000000000000000000000000",
   "invoiceValue":100,
   "trackingCodes":[
      "xxxxx"
   ],
   "trackingUrl":"",
   "externalId":"xxxxx",
   "storeTrackingCode":"store-code",
   "extras":{
      "prop":"xxxxxx"
   },
   "attachments":[
     {
       "type": "",
       "url": "",
       "content": ""
     }
   ]
}