---
title: Criar uma encomenda
description: "Aqui podes encontrar um guia completo sobre como criar uma encomenda na Skyplanner com todos os dados relacionados. Alguns destes aspectos já foram abordados no [tutorial](https://skyplanner.ai/it/docs/tutorial-sullintegrazione/) de integração, mas aqui abordamos a estrutura de dados da Skyplanner e o processo…"
url: "https://skyplanner.ai/pt-pt/docs/criar-uma-encomenda/"
updated: "2025-10-07"
category: Integrações
tags:
  - API
  - Integração
---

# Criar uma encomenda

Aqui podes encontrar um guia completo sobre como criar uma encomenda na Skyplanner com todos os dados relacionados. Alguns destes aspectos já foram abordados no [tutorial](https://skyplanner.ai/it/docs/tutorial-sullintegrazione/) de integração, mas aqui abordamos a estrutura de dados da Skyplanner e o processo de integração com mais pormenor.

#### Estrutura de dados

Em primeiro lugar, vamos ver como está estruturada uma encomenda Skyplanner. Os [pontos de extremidade da API](https://integration.skyplanner.app/api/swagger) para as entidades de dados mencionadas aqui são destacados da seguinte forma: /phaser-orders

No nível superior, temos a **encomenda**(/phaser-orders)

Cada **encomenda** *deve*ter um **cliente**(/clientes).

Cada **encomenda** pode ter vários **itens de encomenda**(/phaser-order-rows)

Cada **item de encomenda** *pode* ter um **produto**(/products) associado, mas não é obrigatório. Cada **produto** tem um **stock**(/saldos). Nota que a entidade stock é criada automaticamente quando um produto é criado com a API.

Cada **item de encomenda** pode ter várias **tarefas** (também conhecidas como etapas do processo)(/phaser-jobs).

Cada **tarefa** *deve*ter uma **fase de trabalho**(/workstages).

![](https://skyplanner.ai/wp-content/uploads/2025/02/phaser-order.drawio-1-655x1024.png)
**Fig. 1** Estrutura da encomenda e dados conexos

#### Fluxo de trabalho de integração

Aqui está um exemplo passo a passo de como pode estruturar a integração do seu sistema ERP com a Skyplanner.

1. Vai buscar as vendas/ordens de trabalho ao ERP
2. Cria um **cliente**(obtém o ID do cliente na resposta)
3. Cria uma **encomenda** com o ID do cliente (obtém o ID da encomenda na resposta)
4. Obtém os dados do item de ordem de venda/ordem de serviço do ERP
5. Cria um **produto** (obtém o ID do produto na resposta)
6. Cria um **item de encomenda** com o ID da encomenda e outros dados (obtém o ID do item de encomenda na resposta)
7. Obtém os dados da etapa do processo a partir do ERP
8. Cria uma **fase de trabalho** (obtém o ID da fase de trabalho na resposta)
9. Cria um **trabalho** com a identificação da fase de trabalho e outros dados

#### Dicas extra

##### Ao apagar

Eliminar phaser-orders, phaser-order-items ou phaser-jobs através da API (e a partir da UI) é feito de uma forma *soft delete*. Isto significa que os dados não são realmente eliminados da base de dados, mas são marcados como arquivados. De facto, o atributo is_archive da entidade é definido como verdadeiro quando é eliminado. As entidades arquivadas/eliminadas podem ainda ser acedidas com a API utilizando o parâmetro include_archived. Quando include_archived=true, um pedido GET recupera a entidade mesmo que esteja arquivada.

**Tem em atenção que a eliminação suave não está disponível em todos os pontos de extremidade da API! Por isso, tens de ter cuidado, pois a eliminação de, por exemplo, clientes, pessoas, etc. é permanente!**

##### Utilizar etapas de processo predefinidas para o teu item de ordem

Se tiveres criado algumas etapas de processo predefinidas para o produto que o teu item de encomenda está a produzir, podes dizer ao sistema para trazer as etapas predefinidas para o item de encomenda com a API, utilizando o atributo **get_default_steps**.

![](https://skyplanner.ai/wp-content/uploads/2025/02/image-158.png)
**Fig. 2.** Criar um novo item de ordem com etapas de processo predefinidas

##### Adiciona materiais ao item da ordem

Se tiveres anexado materiais ao produto produzido, estes são automaticamente anexados à linha da encomenda.

No entanto, se não pretenderes utilizar os materiais associados ao produto (por exemplo, se o artigo for uma encomenda especial e pretenderes utilizar materiais diferentes, etc.), podes utilizar o atributo **use_custom_materials**.

![](https://skyplanner.ai/wp-content/uploads/2025/02/image-159.png)
**Fig. 3.** Criar um item de ordem sem utilizar os materiais padrão