setOrder

POST /tmwxdapi/setOrder

Cria ou altera um pedido. Se o campo id for informado, o pedido será alterado. Caso contrário, o sistema tentará criar um novo pedido.

Os campos da requisição abaixo marcados como required, somente são obrigatórios em caso de criação de novo pedido (quando id não é informado). Se for uma alteração, basta informar os campos id e plataforma e os campos que serão alterados.

Parâmetros do Corpo da Requisição

id int cadastro
Número do pedido a ser alterado. Se for um novo pedido, não informe este campo. Neste caso, será obrigatório pelo menos 1 dos campos abaixo, além de plataforma.
plataforma char(20) required cadastro alteração
Identificador da plataforma (ERP, App, etc...) que está efetuando a alteração/criação do pedido. Se o pedido foi criado pela loja, o campo plataforma deverá conter o IP do cliente que fez a compra. Você pode obter essa informação com o recurso getOrders. Isso é necessário para haver segurança nas alterações.
bloqueiaEmails boolean cadastro alteração
Quando true o sistema não enviará emails para o cliente referente ao pedido que está sendo criado/alterado
dataCad datetime(Y-m-d H:i:s) cadastro
Data do cadastro. Se omitida, será assumida a data do envio.
status char(50) alteração
Situação do pedido. Para criação, o status não deve ser informado, pois será criado como Aguardando Pagamento. Para alteração, os status permitidos via API são:

Rejeitado Pela Operadora Pagamento rejeitado
Pagamento Confirmado Pedido pago
Integrado ERP Pedido Integrado com o ERP
Embalado Pedido separado para envio
Enviado Pedido enviado. Informe juntamente os campos codRastreio e nf
Concluído Pedido concluído
Cancelado Pedido cancelado

Se o status for mudado pelo ERP, o mesmo se responsabiliza pelas alterações dos demais status, posto que qualquer status automático do e-commerce só funciona se o pedido se encontrar no status inicial Aguardando Pagamento.
codRastreio char(20) alteração
Código de rastreamento da entrega. Apenas alteração, quando o pedido recebe o status Enviado.
nf object alteração
Dados da NF. Apenas alteração, quando o pedido recebe o status Enviado.

object
- num char(9) required
  Número da NF.
- serie char(2) required
  Série da NF.
- chave char(44) required
  Chave da NF.
- data datetime(Y-m-d H:i:s) required
  Data de emissão da NF.
- urlNFe char(200)
  URL para o XML da NFe.
- urlDANFE char(200)
  URL para a DANFE.
obs text required cadastro alteração
Observações do pedido. Se for uma alteração, os dados aqui informados serão acrescentados ao dados já existentes. Por isso recomendamos o uso de tags HTML para haver separação entre as informações, uma vez que o comprador terá acesso a essas informações. Enviado.
cliente object required cadastro
Dados do cliente. Se for um cliente previamente cadastrado, basta informar o campo id. Caso seja um cliente novo, informe pelo menos os campos obrigatórios.

object
- id int
  ID do cliente. Se informado, os demais campos abaixo serão ignorados.
- nome char(100) required
  Nome do cliente.
- email char(100) required
  Email principal (de login) do cliente.
- pass char(10)
  Senha do cliente, mínimo de 6 caracteres. Se omitida, ou inválida, o cliente receberá uma senha aleatória que poderá ser resgatada depois pelo formulário "Esqueci minha senha" na loja.
- pessoa char(3) required
  Declare FIS para pessoa Física, ou JUR para pessoa Jurídica.
- tipo char(10)
  Tipo de consumo. Pode ser Consumidor (padrão se omitido) ou Revenda.
- cpfCnpj char(18) required
  CPF ou CNPJ do cliente, de acordo com o que for informado em pessoa.
- rgIe char(25) required
  RE ou IE do cliente, de acordo com o que for informado em pessoa.
- sexo char(1)
  Pode ser F ou M.
- dataNF date(Y-m-d)
  Data de nascimento ou fundação.
- tel char(15)[(99) 9999-99999] required
  Telefone principal.
- cel char(15)[(99) 9999-99999]
  Celular do cliente.
- cep int required
  CEP do cliente. Apenas números. Por exemplo, para o CEP 05271-160 informe 5271160.
- logradouro char(250) required
  Rua, avenida ou travessa.
- num char(5) required
  Número da casa.
- comp char(100)
  Complemento/Referência.
- bairro char(100) required
  Bairro.
- cidade char(50) required
  Cidade.
- uf char(2) required
  Estado.
compradorNome char(100) cadastro
Nome do comprador. Se o campo pessoa for JUR, este campo passa a ser required.
compradorCPF char(20) cadastro
CPF do comprador. Se o campo pessoa for JUR, este campo passa a ser required.
entrega object cadastro
Dados da entrega. Se o endereço informado no campo cliente for o mesmo que o de entrega, não é necessário informar.

object
- cep int required
  CEP da entrega. Apenas números. Por exemplo, para o CEP 05271-160 informe 5271160.
- logradouro char(250) required
  Rua, avenida ou travessa.
- num char(5) required
  Número da casa.
- comp char(100)
  Complemento/Referência.
- bairro char(100) required
  Bairro.
- cidade char(50) required
  Cidade.
- uf char(2) required
  Estado.
- recebedor char(50)
  Nome do recebedor se for diferente do nome do cliente.
- tel char(15)[(99) 9999-99999]
  Telefone do recebedor se for diferente do nome do cliente.
formaPgto char(10) required cadastro
Forma de pagamento. São aceitos as seguintes opções:

boleto Boleto
bb Transferência Bancária Banco do Brasil
bradesco Transferência Bancária Bradesco
itau Transferência Bancária Itaú
banrisul Transferência Bancária Banrisul
hsbc Transferência Bancária HSBC
visa Cartão Visa
master Cartão Mastercard
amex Cartão American Express
aura Cartão Aura
dinners Cartão Dinners Club
hiper Cartão Hipercard
elo Cartão Elo

Se a forma de pagamento escolhida for do tipo Cartão, será obrigatório informar parcelasQtde e parcelasValor.
detalhesPagamento text (JSON) cadastro
Detalhes sobre o pagamento. Podem ser passadas quaisquer informações que achar relevante, desde que o formato seja uma string contendo um JSON válido.
valorTotal decimal(10,2) cadastro
Valor total do pedido (Produtos + Frete + Acrescimos - Descontos). Excetua-se aqui os juros de parcelamento em caso de compra por cartão, posto que estes estarão inclusos em parcelasValor.
parcelasQtde int cadastro
Quandidade de parcelas. Se formaPgto for do tipo cartão, este campo torna-se required.
parcelasValor decimal(10,2) cadastro
Valor de cada parcela. Se formaPgto for do tipo cartão, este campo torna-se required.
frete object required cadastro
Dados do frete.

object
- id int required
  ID do frete a ser usado. Ele pode ser obtido utilizando o recurso calculateShipping.
- valor decimal(10,2) required
  Valor do frete. Informe 0 (zero) para frete grátis.
- prazo int required
  Prazo do frete em dias.
produtos array required cadastro
Produtos do Pedido.

array
object
- id int required
  ID do produto. Ele pode ser obtido utilizando o recurso getProducts.
- conId char(100)
  ID do Conjunto de Variações. Ele pode ser obtido utilizando o recurso getProducts.
- qtde int required
  Quantidade de peças.
- valor decimal(10,2) required
  Valor da unidade do item no momento da compra.

POST /tmwxdapi/setOrder

Dados vindos da API na  Loja Modelo
Acesse o Teste:  Runscope

Request (JSON):

{
    "plataforma": "177.67.159.205",
    "id": 1123,
    "status": "Enviado",
    "codRastreio": "DM534105512BR",
    "nf": {
        "num": 123456,
        "serie": 1,
        "chave": "11112222333344445555666677778888999900001111",
        "data": "2017-03-27 18:30"
    },
    "obs": "<p>Alteração de Teste</p>"
}

Response (JSON):

{
    "status":true,
    "pedido":"1123",
    "erros":[]
}

Parâmetros do Corpo da Requisição

Exemplos de Requisição