# Criar envio para pedido

{% tabs %}
{% tab title="Parâmetros" %}

| Descrição                                               | Campo de texto       | Descrição visual do conector na construção do fluxo.                                                                                                                                                                                                                       |
| ------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Conta de serviço](#user-content-fn-1)[^1]              | Seletor              | Permite selecionar uma conta de serviço do tipo Bearer Token, cadastrada no Workspace Floui, para realizar a conexão e autenticação com o ambiente Adobe Commerce Magento.                                                                                                 |
| ID do pedido (order\_id)                                | Campo de texto       | Identificador do pedido realizado no e-commerce. Este não é o increment\_id exibido nas grades de pedido.                                                                                                                                                                  |
| Lista com itens para envio (objeto JS/JSON)             | Campo de texto       | Permite informar o caminho, dentro do objeto msg, de uma lista JSON contendo os dados dos itens para envio. Os dados do envio deverão conter o identificador dos itens do pedido que serão enviados, a quantidade de itens e atributos opcionais extensíveis do reembolso. |
| Notificar cliente                                       | Seletor              | Define se o cliente será notificado por e-mail.                                                                                                                                                                                                                            |
| Acrescentar comentários anteriores                      | Seletor              | Define se será enviado ou não um comentário junto a criação do envio.                                                                                                                                                                                                      |
| Comentário visível na vitrine                           | Campo de texto       | Permite definir se os comentários adicionados junto ao envio serão visíveis pelo usuário comprador nos detalhes do pedido.                                                                                                                                                 |
| Atributos extensíveis adicionais para comentários       | Tabela de parâmetros | Definem informações adicionais e extensíveis associadas ao comentário do pedido. Configurado no formato de Chave e Valor.                                                                                                                                                  |
| Adicionar rastreamento                                  | Seletor              | Permite adicionar ou não informações de frete junto ao envio.                                                                                                                                                                                                              |
| Lista com informações de rastreamentos (objeto JS/JSON) | Campo de texto       | Campo disponível quando configuração Adicionar Rastreamento está como Sim. Permite informar o caminho, dentro do objeto msg, de uma lista JSON contendo os dados do rastreamento do envio.                                                                                 |
| Adicionar pacotes                                       | Seletor              | Permite adicionar ou não informações do pacote de envio.                                                                                                                                                                                                                   |
| Lista com informações de pacotes (objeto JS/JSON)       | Campo de texto       | Campo disponível quando configuração Adicionar Pacotes está como Sim. Permite informar o caminho, dentro do objeto msg, de uma lista JSON contendo os dados do pacote do envio.                                                                                            |
| Código da fonte (source\_code)                          | Campo de texto       | Código da fonte de estoque onde o estoque do produto será deduzido para realizar o envio do pedido.                                                                                                                                                                        |
| Atributos extensíveis adicionais                        | Tabela de parâmetros | Definem informações adicionais e extensíveis associadas ao envio do pedido. Configurado no formato de Chave e Valor.                                                                                                                                                       |
| Output Path                                             | Campo de texto       | Refere-se ao caminho do resultado da requisição na saída do conector no contexto de execução do fluxo                                                                                                                                                                      |
| {% endtab %}                                            |                      |                                                                                                                                                                                                                                                                            |

{% tab title="Payload" %}

### Detalhes

O conector Criar envio para pedido oferece uma interface simples e automatizada para gerenciar envios de pedidos realizados no e-commerce por meio da API REST.

O conector utiliza o endpoint **POST** `/rest/V1/order/{id}/ship`, onde `{id}` é o identificador do pedido. Para saber mais sobre esta ou outras APIs disponibilizadas para Adobe Commerce Magento, acesse o link [REST endpoints (ReDocly)](https://developer.adobe.com/commerce/webapi/rest/quick-reference/).

## Lista de itens de envio

Para adicionar uma lista com os itens que serão enviados será necessário que o JSON siga um padrão específico. Segue um exemplo da estrutura para gerar o reembolso. No caso abaixo o JSON está no caminho `msg.shipment`, logo, na configuração **Lista com itens para envio (objeto JS/JSON)** será necessário passar o caminho msg.shipment. 

```json
[
    {
        "order_item_id": 3534,
        "qty": 1,
        "extension_attributes": {}
    }
]
```

## Lista com dados de rastreamento

Para gerar o envio do pedido com informações de rastreamento é necessário que os dados estejam como no formato abaixo, uma lista JSON com as informações de envio. No exemplo, os dados estão no caminho `msg.tracking_info`, logo na configuração **Lista com informações de rastreamentos (objeto JS/JSON)** deverá ser informado o mesmo caminho, `msg.tracking_info`.

```json
[
    {
        "track_number": "BRXXXXXXXXXXX",
        "title": "Entrega Rápida - 2 Dias",
        "carrier_code": "correios"
    }
]
```

## Lista com dados de pacote

Para armazenar informações do pacote do envio, as informações deverão estar presentes dentro do objeto `extension_attributes`. Na configuração **Lista com informações de pacotes (objeto JS/JSON)** deverá ser informado o mesmo caminho onde esta lista com as informações do pacote estão localizados. Importante notar que os atributos devem estar cadastrados na plataforma para que o envio seja gerado com sucesso, caso não sejam válidos o envio não será gerado.

```json
[
    {
        "extension_attributes": {
            "attr": "value"
        }
    }
]
```

## Sucesso

Quando a requisição for bem-sucedida, a resposta conterá um identificador único do envio gerado no e-commerce.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXeN5sqkZ7K3RO3vanwLoUN6GKuE1ROl0qioNiMg_RBhwOu8D7kPrkQMCga6qeQy0-0tdczXoewE_JOXf4EwHN6VxV7UE3DTQVFpx2O4YJddaVkZEMHmb2dJhxYjGgsgQlUqY2dd?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Sucesso na criação de envio</p></figcaption></figure>

## Erros

Cenários de erro poderão ocorrer por diversos motivos, desde o uso de listas com formato não esperado pelo conector até erros na atualização devido ao fluxo de pedidos no e-commerce. Segue um exemplo abaixo de como os erros são retornados da API.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfHoxKfpN2DxD2kn-wnCj_vMLLJGUyQn5Psr0EU1GAqNNAD_1anvyDS9mUa0QIF6aOI0U_FYTihKlwKT5nrIMDIsPVtcSFS8fa4W0YyyVLL4FpblHI_uIGVA2YCw3b2Jl_wdXo-?key=Yp0qdx99PgGWwiHA4kq1q_wj" alt=""><figcaption><p>Erro na criação de envio</p></figcaption></figure>
{% endtab %}
{% endtabs %}

[^1]: A conta de serviço precisa ser adicionada no painel de configuração do Floui antes de ser selecionada dentro do componente.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.floui.io/guia/conectores/categorias/servicos-externos/adobe-commerce/envio/criar-envio-para-pedido.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.