Pedidos V1

⚠️
Atenção: O endpoint de pedidos acessado pela url /v1/pedidos está depreciado. Novas homologações devem ser realizadas na versão 2 (/v2/pedidos). A versão 1 não receberá mais atualizações e com o tempo deixará de ser suportada.

A entidade Pedidos engloba tanto pedidos realizados quanto orçamentos pendentes.

O que diferencia um orçamento de um pedido efetivado é a propriedade status, que pode ser consultado usando GET EX:

https://app.mercos.com/api/v1/pedidos/?alterado_apos=2019-03-01 07:21:44&status=2

Estrutura de Retorno do Pedido

Campo	Tipo	Descrição
id	Integer	Identificador único.
cliente_id	Integer	Identificador único do cliente.
cliente_razao_social	String: 100	Razão social do cliente.
cliente_nome_fantasia	String: 100	Nome fantasia do cliente.
cliente_cnpj	String: 14	CNPJ do cliente, no formato numérico ou alfanumérico.
cliente_inscricao_estadual	String: 30	Inscrição estadual do cliente.
cliente_rua	String: 100	Rua do cliente.
cliente_numero	String: 100	Número do endereço do cliente.
cliente_complemento	String: 50	Complemento do cliente.
cliente_cep	String: 8	CEP do cliente.
cliente_bairro	String: 30	Bairro do cliente.
cliente_cidade	String: 50	Cidade do cliente.
cliente_estado	String: 2	Estado do cliente.
cliente_suframa	String: 20	Suframa do cliente.
representada_id	Integer	ID da Representada.
representada_nome_fantasia	String: 50	Nome fantasia da Representada.
representada_razao_social	String: 50	Razão Social da Representada.
transportadora_id	Integer	Identificador único da transportadora.
transportadora_nome	String: 50	Nome da transportadora.
criador_id	Integer	Identificador único do vendedor que fez o pedido.
nome_contato	String: 50	Nome do contato do cliente.
status	String: 1	Status atual do pedido. `0` = Cancelado, `1` = Orçamento, `2` = Pedido.
numero	Integer	Número auto-incremental do pedido.
rastreamento	String: 200	Código ou link para rastreamento de envio do pedido.
valor_frete	Double	Valor do frete.
total	Double	Valor total do pedido.
condicao_pagamento	String: 100	Condição de pagamento em formato texto livre. Usado apenas caso você não integre a entidade Condições de Pagamento.
condicao_pagamento_id	Integer	Identificador único da condição de pagamento. Usado apenas caso você integre a entidade Condições de Pagamento.
tipo_pedido_id	Integer	Identificador único do tipo de pedido. Usado apenas caso você integre a entidade Tipo de Pedido.
forma_pagamento_id	Integer	Identificador único da forma de pagamento. Usado apenas caso você integre a entidade Formas de Pagamento.
data_emissao	Date	Data de emissão do pedido. Pode ser null.
observacoes	String: 500	Informações adicionais que o vendedor registrou no pedido.
status_faturamento	Integer	`0` = Não faturado, `1` = Parcialmente faturado, `2` = Faturado.
status_custom_id	Integer	Identificador único do status de pedido customizado. Usado apenas caso você integre a entidade Status de Pedido Customizado.
status_b2b	Integer	Status atual do pedido no B2B. `null` = Pedido não foi gerado com o B2B, `1` = Em aberto, `2` = Concluído.
data_criacao *	DateTime	Data de criação do pedido, só será preenchida se for informada. Pode ser diferente da `data_emissao` pois um pedido pode ter sido criado ontem e emitido apenas hoje.

*Obs.: Esse campo só será preenchido caso seja enviado no POST de pedidos, pois ele se refere à data de criação do registro e não à data de inserção no banco.

Estrutura de Retorno do Item do Pedido

Campo	Tipo	Descrição
id	Integer	Identificador único do item do pedido.
produto_id	Integer	ID do produto na Mercos.
produto_codigo	String: 50	Código do produto na Mercos.
produto_nome	String: 100	Nome do produto na Mercos.
tabela_preco_id	Integer	ID da tabela de preço na Mercos. Caso tenha sido utilizado o preço padrão (campo `preco_tabela` da entidade Produto), será `null`.
quantidade	Double	Quantidade vendida.
preco_bruto	Double	Preço padrão do produto no momento da venda, ou o valor da tabela de preço utilizada caso `tabela_preco_id` seja diferente de `null`.
preco_liquido	Double	Preço de venda do produto.
cotacao_moeda	Double	Cotação da moeda, em caso de venda em moeda estrangeira.
quantidade_grades	List	Lista com as grades de cores e tamanhos usadas e suas respectivas quantidades. Caso o produto possua somente Cor, o Tamanho será `null`, e vice-versa. A soma das quantidades nesta lista será igual ao campo `quantidade` do item. Campos: `cor` (String: 15), `tamanho` (String: 15), `quantidade` (Double).
descontos_do_vendedor	List	Lista com os acréscimos e descontos concedidos pelo vendedor ao item, em formato Double. Um acréscimo é identificado por um desconto com valor negativo.
descontos_de_promocoes	List	Lista com os descontos de promoções aplicadas ao item. Formato: `{"regra_id": Integer, "desconto": Double}`.
descontos_de_politicas	List	Lista com os acréscimos ou descontos de políticas comerciais aplicadas ao item. Formato: `{"regra_id": Integer, "desconto": Double}`. Um acréscimo é identificado por um desconto com valor negativo.
descontos	List	Lista com todos os descontos aplicados ao item, em formato Double. Equivale à concatenação de `descontos_do_vendedor`, `descontos_de_promocoes` e `descontos_de_politicas`.
observacoes	String: 500	Informações adicionais que o vendedor registrou no item.
excluido	Boolean	Indica se o item está excluído.
ipi	Double	Valor do IPI do produto.
tipo_ipi	Char	Indica se o IPI é percentual (`P`) ou valor fixo (`V`).
st	Double	Valor da ST (Substituição Tributária).
subtotal	Double	Subtotal final calculado.

Estrutura de Retorno de Campos Extras do Pedido

Campo	Tipo	Descrição
campo_extra_id	Integer	Identificador único do campo extra.
nome	String: 50	Nome do campo extra.
tipo	String	`"0"` = Texto livre, `"1"` = Data, `"2"` = Numérico, `"3"` = Hora, `"4"` = Lista, `"5"` = Somente leitura.
valor_texto	String: 50	Retorna um texto se o campo for do tipo texto ou somente leitura.
valor_data	String	Retorna uma data se o campo for do tipo data.
valor_decimal	Double	Retorna um Double se o campo for do tipo numérico.
valor_hora	String	Retorna uma hora se o campo for do tipo hora.
valor_lista	List	Retorna uma lista de IDs e valores dos itens da lista. Ex: `[[1, "sp"], [2, "sc"]]`.
valor	—	O tipo deste atributo depende do tipo do campo extra conforme tabela abaixo.

Tipos do campo `valor` (retorno)

Tipo do campo extra	Tipo	Formato
Texto simples (`"0"`)	String: 50	—
Data (`"1"`)	String	`"yyyy-dd-mm"`, ex: `"2018-21-02"`.
Numérico (`"2"`)	Double	Valor máximo: `99999999.99999`.
Hora (`"3"`)	String	`"HH:mm"`, ex: `"21:56"`.
Lista (`"4"`)	List	Lista de IDs e valores. Ex: `[[1, "sp"], [2, "sc"]]`.
Somente leitura (`"5"`)	String: 50	—

Estrutura de Envio de Campos Extras do Pedido

Obs.: Os campos extras cadastrados que não forem enviados serão salvos como vazio.

Campo	Tipo	Descrição
id	Integer	Identificador único do campo extra.
valor	—	O tipo deste atributo depende do tipo do campo extra conforme tabela abaixo.

Tipos do campo `valor` (envio)

Tipo do campo extra	Tipo	Formato
Texto simples (`"0"`)	String: 50	—
Data (`"1"`)	String	`"yyyy-dd-mm"`, ex: `"2018-21-02"`.
Numérico (`"2"`)	Double	Valor máximo: `99999999.99999`.
Hora (`"3"`)	String	`"HH:mm"`, ex: `"21:56"`.
Lista (`"4"`)	List: int	Lista de IDs dos itens selecionados. Se `lista_multipla` for verdadeiro, pode ser enviado mais de 1 ID.
Somente leitura (`"5"`)	String: 50	—

Estrutura de Retorno do Endereço de Entrega

Obs.: Os dados do endereço de entrega só serão preenchidos caso o endereço de entrega não seja o endereço principal do cliente.

Campo	Tipo	Descrição
id	Integer	Identificador único do endereço. Este identificador é o mesmo de endereço adicional de cliente.
cep	String: 8	CEP da localização do endereço.
endereco	String: 200	Endereço ou rua.
numero	String: 100	Número do local.
complemento	String: 200	Complementos do endereço.
bairro	String: 200	Bairro do endereço.
cidade	String: 200	Cidade do endereço.
estado	String: 2	Estado da cidade.