get https://api.homologation.hubiss.com.br/v1/orders
Listar todas as Marcas cadastradas.
Descrição dos atributos retornados
Nó | Nó Pai | Descrição |
---|---|---|
id | - | Código do pedido na Hubiss |
marketplace_account | - | Código da conta Marketplace que originou o pedido |
marketplace_order_id | - | Código do Pedido no Marketplace |
marketplace_order_additional_id | - | Código adicional do pedido no Marketplace. Geralmente estará em branco, porém em alguns momentos temos 2 códigos. |
order_date | - | Data do Pedido, Formato: Y-m-dTH:i:s |
estimated_delivery_date | - | Data estimada de entrega do Pedido, Formato: Y-m-dTH:i:s |
- | E-mail do comprador, quando disponível. O marketplace não dispoem mais dessa informação, porém se você conseguir, é possível realizar o cadastro para futuras comunicações com o cliente. | |
status | - | Status do pedido na Hubiss (Veja a lista de status disponíveis no final da página) |
marketplace_status | - | Nome do status atual no Marketplace integrado (Não existe padrão entre marketplace) |
internal_observations | - | Observações internas, use-o para manter um registro de observação para sua equipe |
message_to_seller | - | Quando um cliente deixa uma mensagem ao vendedor no ato da compra, esse atributo é preenchido. Nota. Não são dados do chat com o cliente. |
marketplace_client_id | - | Código de identificação do cliente no Marketplace |
fraud_alert | - | Alguns marketplaces já alertam automaticamente se o pedido em questão é uma possível fraude, use-o para decidir se mesmo assim irá enviar ou não. |
order_in_marketplace_dispute | - | Informa que o pedido entrou em disputa no Marketplace |
created_at | - | Data que o pedido entrou na Hubiss, normalmente entra alguns segundos depois de efetuar no Marketplace, porém atrasos e erros podem ocorrer, então a data pode ser diferente da data do pedido. |
updated_at | - | Informa a última data que o pedido recebeu alguma atualização nos dados da raiz |
dropshipping_crossdocking | - | Informações referente a dropshipping ou crossdocking. |
is_dropshipping_crossdocking | -- dropshipping_crossdocking | Informa que esse pedido será feito dropshipping ou crossdocking. Reconhecemos quando o produto está cadastrado sendo de outro fornecedor em nossa plataforma. |
order_buyed_in_supplier | -- dropshipping_crossdocking | Informa que o pedido já foi efetuado a compra no fornecedor |
customer | - | Informações do comprador |
documents | -- customer | Documentos do comprador |
primary | --- documents | Documento principal do comprador |
type | ---- primary | Tipo de documento principal do comprador. Possíveis opções: cpf, cnpj |
number | ---- primary | Número do documento principal correspondente ao tipo de documento. Aceito apenas números, sem máscara. |
secondary | --- documents | Documento secundário do comprador |
type | ---- secondary | Tipo de documento secundário do comprador. Possíveis opções: i.e, rg |
number | ---- secondary | Número do documento secundário correspondente ao tipo de documento. Não existe padrão, aceita quaisquer caracteres. |
phones | -- customer | Números de telefone do cliente |
primary | --- phones | Números do telefone principal para contato com o comprador. Aceito apenas números, sem formatação |
secondary | --- phones | Números do telefone secundário para contato com o comprador. Aceito apenas números, sem formatação |
billing_address | -- customer | Dados do endereço de cobrança |
name | --- billing_address | Nome do comprador |
zip_code | --- billing_address | CEP do comprador |
street_name | --- billing_address | Logradouro do comprador |
street_number | --- billing_address | Número da casa do comprador |
district | --- billing_address | Bairro do comprador |
complement | --- billing_address | Complemento do endereço do comprador |
city | --- billing_address | Cidade/Municipio do Comprador |
state | --- billing_address | Sigla do estado do comprador |
country | --- billing_address | Sigla do país do comprador |
shipping | - | Dados para envio |
is_fullfilment | -- shipping | Informa se o pedido é de origem fullfilment ou não |
responsible_issuing_label | -- shipping | Informa quem é o responsável por disponibilizar a etiqueta de envio. Possíveis opções: marketplace, seller |
first_printing_date_label | -- shipping | Informa a data que a etiqueta de envio foi impressa a primeira vez. |
print_label_url | -- shipping | Url para impressão de etiqueta. Quando o responsável pela emissão de etiqueta é o Marketplace, a Hubiss baixa a etiqueta do Marketplace e imprime na hora para você no padrão do Marketplace com o código de postagem do Marketplace. Quando o responsável pela emissão da etiqueta é o próprio vendedor, a Hubiss gera uma etiqueta simples para você despachar normalmente. |
shipping_address | -- shipping | Dados do endereço do destinatário |
name | --- shipping_address | Nome do destinatário |
zip_code | --- shipping_address | CEP do destinatário (Apenas números) |
street_name | --- shipping_address | Logradouro do destinatário |
street_number | --- shipping_address | Número da casa do destinatário |
district | --- shipping_address | Bairro do destinatário |
complement | --- shipping_address | Complemento do destinatário |
city | --- shipping_address | Cidade/Município do destinatário |
state | --- shipping_address | Sigla do estado do destinatário |
country | --- shipping_address | Sigla do pais do destinatário |
products | - | Lista de produtos no Pedido |
marketplace_order_id | -- products | Código do pedido no Marketplace |
dropshipping_crossdocking | -- products | Informações do produto para caso de Dropshipping ou Crossdocking |
is_dropshipping_crossdocking | --- dropshipping_crossdocking | Informa que esse produto será feito dropshipping ou crossdocking. Reconhecemos quando o produto está cadastrado sendo de outro fornecedor em nossa plataforma. |
order_buyed_in_supplier | --- dropshipping_crossdocking | Informa que o produto já foi efetuado a compra no fornecedor |
name | -- products | Nome do produto |
sku | -- products | Código SKU do produto |
marketplace_listing_id | -- products | Código do anuncio no Marketplace |
attributes_variation | -- products | Atributos referente a variação para caso de variação. Exemplo: 36,Preto |
product_condition | -- products | Condição do produto. Possíveis opções: new, used, refurbished |
quantity | -- products | Quantidade de itens |
unit_price | -- products | Valor unitário do item |
discounts | -- products | Descontos |
gross_amount | -- products | Valor bruto |
total_value | -- products | Valor total |
marketplace_comission_value | -- products | Valor da comissão do Marketplace |
marketplace_discount | -- products | Desconto no Marketplace |
days_to_send | -- products | Dias limite para enviar |
current_data | -- products | Dados atuais na plataforma |
current_stock | current_data | Informa a quantidade em estoque atual no ato da requisição do pedido |
current_reserved_stock | current_data | Informa quantas unidades atualmente estão reservadas para esse produto |
payments | - | Dados dos pagamentos efetuados no Marketplace quando disponível |
id | -- payments | Id do pagamento no marketplace |
payment_date | -- payments | Data do pagamento no marketplace |
created_at | -- payments | Data de cadastro do pagamento na Hubiss |
status | -- payments | Status do pagamento no marketplace |
type | -- payments | Tipo de pagamento no marketplace |
installments | -- payments | Número de parcelas no marketplace (quando disponível) |
installment_value | -- payments | Valor da parcela no marketplace (quando disponível) |
total | -- payments | Valor total do pagamento no marketplace |
invoice | - | Dados da nota fisca (Quanda informada pelo vendedor á Hubiss) |
number | -- invoice | Número da nota fiscal |
serie | -- invoice | Número de série da nota fiscal |
date | -- invoice | Data da nota fiscal (formato Y-m-d) |
access_key | -- invoice | Chave de acesso a nota fiscal |
cfop | -- invoice | CFOP |
state_registration | -- invoice | Inscrição estadual |
consultation_url | -- invoice | URL para consulta da nota fiscal online |
file_url | -- invoice | URL para download do arquivo xml da nota fiscal |
shipment | - | Dados do envio |
shipment_marketplace_code | -- shipment | Código do envio no Marketplace |
status_marketplace | -- shipment | Status do envio no Marketplace |
logistic_name | -- shipment | Nome do operador logístico |
shipping_method | -- shipment | Nome do Método de Envio |
tracking_code | -- shipment | Código de rastreamento do pedido |
submission_deadline | -- shipment | Prazo de envio imposto pelo Marketplace |
tracking_url | -- shipment | URL de acompanhamento do envio |
shipping_company_id | -- shipment | CNPJ da transportadora responsável |
sent_date | -- shipment | Data de envio |
expected_delivery_date | -- shipment | Data estimada de entrega |
delivery_date | -- shipment | Data de entrega |
financial | - | Dados financeiros do pedido |
shipping_cost_merchant | -- financial | Custo do envio ao Vendedor |
products | -- financial | Valor total nos produtos |
interest | -- financial | Juros |
shipping | -- financial | Valor do envio |
discount | -- financial | Valor nos descontos |
total | -- financial | Total do pedido |
total_marketplace_products_fee | -- financial | Total de comissão |
marketplace_discount | -- financial | Descontos no Marketplace |
reverse_shipping_fee | -- financial | Custo adicional de logística reversa |
hubiss_comission | -- financial | Valor da comissão cobrada pela Hubiss no Pedido |
hubiss_percentual_comission | -- financial | Percentual de comissão cobrada pela Hubiss no Pedido |
hubiss_comission_is_trial | -- financial | Informa se o pedido estava dentro do limite de pedidos gratuitos pelo plano ou não. |
other_discounts | -- financial | Lista de Outros descontos disponíveis pelo marketplace |
name | --- other_discounts | Nome do outro desconto do marketplace |
informations | --- other_discounts | Informações detalhadas referente ao outro desconto do Marketplace |
value | --- other_discounts | Valor do outro desconto no Marketplace |
Status dos Pedidos
Nome | Descrição | Possíveis transições DE |
---|---|---|
cancelled | Pedido cancelado | pending, paid_waiting_shipment, paid_waiting_shipment, paid_waiting_order_ship ment_at_supplier, invoiced |
pending | Pedido está pendente, significa que o pedido foi feito no Marketplace, porém ainda não foi pago. | N/a |
paid_waiting_shipment | Pedido foi pago no marketplace e está aguardando envio. | pending |
paid_waiting_order_at_supplier | Pedido foi pago no marketplace e está aguardando realização de compra no fornecedor. O pedido só chegará nesse status contendo itens que foram vendidos como Dropshipping ou Crossdocking. | pending |
paid_waiting_order_ship ment_at_supplier | Pedido realizado no fornecedor, porém aguardando envio por parte do fornecedor. O pedido só chegará nesse status assim que você efetuar o pedido no fornecedor e marcar como pedido efetuado no fornecedor. | paid_waiting_order_at_supplier, invoiced |
invoiced | Pedido faturado, ou seja, a nota fiscal foi emitida e informada a plataforma. | paid_waiting_shipment, paid_waiting_order_at_supplier |
paid_waiting_delivery | Pago aguardando entrega, o pedido só entrará nesse status assim que você realizar o envio ou se o responsável pela etiqueta for o Marketplace, a plataforma atualizará automaticamente para seu devido status. | paid_waiting_shipment, paid_waiting_order_at_supplier, paid_waiting_order_ship ment_at_supplier, invoiced |
concluded | Pedido entregue ao cliente. | paid_waiting_delivery |