Criar novo pedido

POST  http://api.shipfy.com/v1/tracking

Descrição

Cria um novo pedido.

Running

Status

Tempo de resposta: 220ms

Header

Nome Exemplo
Authorization Basic bWljaGVsLmtvbW1lcnNAZ21haWwuY29tOjZ6Y01zL0JLbkJxZUtkcUFmTUcycnc9PQ==

Parâmetros

Nome Tipo Descrição Exemplo Obrigatório
OrderNumber String Número do Pedido P1234
ReceiptNumber String Número da nota fiscal 114395
ReceiptSerie String Série da nota fiscal 1
Code String Código de rastreamento ou número da nota fiscal SW626626822BR
carrierId String Código identificador da transportadora 48BF9922-0B7E-4FF6-B90A-DA6D61ABA05A
Description String Descrição do pedido Relógio
DatePosted DateTime Data de Postagem/Faturado 2014-01-30 13:41
DateToDelivery DateTime Data de Entrega Prometida 2014-02-30
CarrierName String Nome da Transportadora no sistema. Veja quais transportadoras estão cadastradas CORREIOS
CompanyDocumentNumber String CNPJ da Unidade de negócio 11111111111111
CustomerEmail String E-mail do cliente fulano@gmail.com
CustomerPhone String Número de telefone celular do Cliente 11994198622 (onde 11 é o código de area)
CustomerName String Nome do Cliente Fulado de Tal
CustomerDocumentNumber String CPF do Cliente 00864107090
CustomerPostalCode String CEP do Cliente 04084001
CustomerCountry String País do Cliente Brasil
CustomerState String Estado/Província do Cliente São Paulo
CustomerCity String Cidade do Cliente São Paulo
CustomerStreet String Rua do Cliente Av Paulista
CustomerNumber String Número de rua do Cliente 1200
CustomerComplement String Complemento de endereço do Cliente apt 108 bloco A
CustomerDateOfBirth Datetime Data de Nascimento do Cliente 1980-01-30
CompanyPostalCode String CEP do Varejista (em caso de multiplos CD) 04084001
DeliveryType String Tipo de Entrega Normal
SendSms Boolean Se Setado para False ignora as regras de envio de SMS Configuradas e não envia SMS True
SendEmail Boolean Se Setado para False ignora as regras de envio de Email Configuradas e não envia Email True
OrderSalesValue Number Valor de Venda do Pedido 1000
FreightNumber Number Número de Pedido junto a Transportadora 1
FreightCost Number Custo do Frete/Envio 1000
AutomaticDateDelivered Boolean Se setado para True irá calcular a data de entrega Prometida (consultar o suporte antes de usar) True
EntrySource String Identificação de origem do Registro ERP
Height Number Altura do objeto 2.5
Width Number Largura do objeto 2.0
Weight Number Peso do objeto 1.0
Length Number Comprimento do objeto 2.0
SalesChannel String Nome do Canal de Vendas pelo qual ocorreu a venda (não necessariamente o mesmo do cnpj da emissão da NF) Loja XYZ

Exemplo de Request - cURL

                                                                         
curl -X POST "http://api.shipfy.com/v1/tracking"
    -d '{
	        "CarrierName": "Correios",
	        "OrderNumber": "12345",
	        "ReceiptNumber": "12345",
	        "ReceiptSerie": "1",
	        "Code": "SW1",
	        "DateToDelivery": "2016-12-31",
	        "Description": "desc",
	        "CustomerEmail": "email@docliente.com",
	        "CustomerDocumentNumber": "11111111111",
	        "CustomerPostalCode": "88010010",
	        "SendSms": "false",
	        "SendEmail": "false",
	        "CustomerPhone": "119123456789",
	        "CustomerName": "nome do cliente"
        }'
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Authorization: Basic' + {token}        
                                
                                
Testar API

Retornos

200 Retorna um JSON com os seguintes parâmetros:

Nome Tipo Descrição Exemplo
Id String Id do rastreamento criado no sistema 26A79582-B96F-4853-9246-017637093E61
Success Boolean Valor booleano que indica se houve sucesso ou não na chamada true
Message String Mensagem adicional de erro ou sucesso Rastreamento criado com sucesso

500 Ocorreu algum erro, entre em contato com o suporte.