Criar envio para pedido

Cria um envio para um pedido realizado na plataforma Magento Adobe Commerce

Parâmetros

Descrição	Campo de texto	Descrição visual do conector na construção do fluxo.
	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

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).

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.

[
    {
        "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.

[
    {
        "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.

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

Sucesso

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

Sucesso na criação de envio

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.

Erro na criação de envio