Entidade order
Fluxo de Pedidos
O processo de cada Pedido na loja virtual da Get Commerce possui 9 etapas (definidas como "Status do Pedido"). A maior parte destas etapas é processada automaticamente pelo sistema, sem a necessidade de ação por parte do lojista digital.
Abaixo, segue a tabela contendo os status (state
) de pedidos disponíveis na plataforma.
Status
Código | Título | Descrição |
---|---|---|
new | Novo | Aplicado a todos os pedidos recém-chegados à loja e ainda não foram revisados ou processados. |
pending_payment | Pendente | Aplicado a pedidos que aguardam confirmação de pagamento. |
processing | Processando | Aplicado a pedidos que tiveram seu pagamento confirmado e estão em fase de processamento para faturamento ou execução. Ou seja, pedidos faturados. |
complete | Completo | Indica que o pedido foi faturado, entregue e está finalizado, sem mais etapas pendentes. |
closed | Fechado | O status é atribuído quando é gerado um reembolso integral do pedido, efetivamente fechando-o. |
canceled | Cancelado | Indica que o pedido foi cancelado e não será completo. |
holded | Segurado | Pedidos temporariamente interrompidos, como aguardando compensação bancária para pagamentos via boleto. |
payment_review | Análise de Pagamento | Indica que o pagamento do pedido está sendo revisado pelo processador de pagamento para verificação adicional ou suspeita de problema. |
fraud | Suspeita de Fraude | Indica que o pagamento foi sinalizado como suspeito de fraude pelo processador de pagamento. |
Fluxograma dos pedidos
Campos
Abaixo, segue a descrição dos possíveis campos e seus valores nas requisições desta entidade.
Campo | Campo Pai | Tipo | Descrição |
---|---|---|---|
entity_id | - | int | Identificador único do pedido |
increment_id | - | string | ID Incremental do pedido. Ex.: #100000001 |
state | - | string | Status atual do pedido. Confira a lista de status disponíveis |
created_at | - | datetime | Data e hora da criação do pedido Formato: yyyy-MM-ddTHH:mm:ss |
updated_at | - | datetime | Data e hora da última atualização do pedido Formato: yyyy-MM-ddTHH:mm:ss |
subtotal | - | float | Subtotal do pedido (sem frete e descontos gerais) |
total | - | float | Total final do pedido, somando todos os valores e atribuindo todos os descontos (caso hajam) |
shipping | - | shipping_object | Dados referentes a entrega do pedido |
payment | - | payment_object | Dados referentes ao pagamento do pedido |
customer | - | customer_object | Dados referentes ao cliente que realizou o pedido |
items | - | array de item_object | Itens (produtos) que compõe o pedido em questão |
shipping_object
shipping_object
Dados referentes a entrega do pedido.
Campo | Campo Pai | Tipo | Descrição |
---|---|---|---|
price | shipping | float | Preço da entrega |
method | shipping | string | Método/transportadora utilizado para entrega |
address | shipping | address_object | ID do endereço de entrega. Saiba mais em: Clientes - Endereços |
payment_object
payment_object
Dados referentes ao pagamento do pedido.
Campo | Campo Pai | Tipo | Descrição |
---|---|---|---|
total_discount | payment | float | Valor total de desconto aplicado ao pedido |
method | payment | string | Código do método de pagamento. Saiba mais em: 🧩 Métodos de Pagamento |
type | payment | string | Tipo da forma de pagamentopix - PIXbillet - Boletocredit_card - Cartão de Créditoother - Tipos adicionais |
installments | payment | int |false | Número de parcelas (ou´false quando não aplicável) |
address | payment | address_object | ID do endereço de cobrança. Saiba mais em: Clientes - Endereços |
customer_object
customer_object
Campo | Campo Pai | Tipo | Descrição |
---|---|---|---|
entity_id | customer | int |false | ID do cliente. false em caso do pedido ter sido realizado por um visitante* Mesmo que o ID esteja presente neste campo, é possível que o cliente não exista mais na loja |
firstname | customer | string | Primeiro nome do cliente |
lastname | customer | string | Sobrenome do cliente |
customer | string | E-mail do cliente | |
document | customer | string | CPF/CNPJ do cliente (apenas números) |
telephone | customer | string | Telefone (apenas dígitos) do cliente. Caso não exista, retornará null |
item_object
item_object
Dados referentes ao cliente que realizou o pedido.
Campo | Campo Pai | Tipo | Descrição |
---|---|---|---|
item_id | items | int | ID do item de pedido |
product_id | items | int | ID do produto em si * Mesmo que o ID esteja presente neste campo, é possível que o produto não exista mais na loja |
sku | items | string | SKU do produto |
price | items | float | Preço do item, no contexto do pedido |
qty | items | int | Quantidade adquirida do item de pedido |