Como fazer um pedido usando um produto do cliente

Este guia vai orientar você no processo de fazer um pedido usando um produto do cliente através da API GelatoConnect. Os produtos do cliente permitem que você use suas próprias configurações de produto ao fazer pedidos, simplificando o processo e garantindo consistência com suas definições internas de produto.

Endpoint da API

POST https://order.ie.live.gelato.tech/api/v4/orders

Estrutura da solicitação

Os elementos-chave para usar um produto do cliente no seu pedido são os campos productName e productVariant dentro do array items. Aqui está um exemplo de estrutura de solicitação:

{
    "clientId": "your-client-id",
    "orderReferenceId": "your-order-reference",
    "customerReferenceId": "your-customer-reference",
    "orderType": "order",
    "currency": "USD",
    "retailCurrency": "USD",
    "retailShippingPriceInclVat": 5.99,
    "shippingAddress": {
        "country": "US",
        "firstName": "John",
        "lastName": "Doe",
        "addressLine1": "123 Main St",
        "city": "Anytown",
        "postCode": "12345",
        "state": "CA",
        "email": "[email protected]",
        "phone": "1234567890"
    },
    "items": [
        {
            "itemReferenceId": "your-item-reference",
            "productName": "sample for order intake",
            "productVariant": {
                "paper": "a1",
                "color": "front"
            },
            "files": [
                {
                    "type": "default",
                    "url": "https://example.com/your-file.pdf"
                }
            ],
            "quantity": 1,
            "retailPriceInclVat": 79.99
        }
    ]
}

Campos principais para produtos do cliente

Ao usar um produto do cliente, preste atenção especial a estes campos no array items:

productName: Deve corresponder ao nome do seu produto do cliente conforme definido no GelatoConnect.
productVariant: Este objeto contém as opções específicas para o seu produto. As chaves e valores devem corresponder às opções de variante que você configurou para o seu produto do cliente.

No exemplo acima:

"productName": "sample for order intake",
"productVariant": {
    "paper": "a1",
    "color": "front"
}

Esta configuração informa ao GelatoConnect para usar o produto do cliente chamado "sample for order intake" com as opções de papel e cor especificadas.

Notas importantes

Ao usar um produto do cliente, você não precisa fornecer um productUid para o item. Os campos productName e productVariant são usados em vez disso para determinar a configuração exata do produto.
Certifique-se de que o productName corresponde exatamente ao nome do seu produto do cliente no GelatoConnect.
O objeto productVariant deve incluir apenas opções que você definiu para o seu produto do cliente. Incluir opções não definidas resultará em erro.
O restante da estrutura da solicitação de pedido permanece o mesmo de um pedido padrão. Você pode incluir vários itens, cada um usando um produto do cliente diferente, se necessário.
Sempre garanta que os arquivos fornecidos correspondam aos requisitos da configuração do seu produto do cliente.

Resposta

Depois de fazer um pedido com sucesso, você vai receber uma resposta que inclui detalhes sobre o pedido, incluindo um ID do pedido, status de atendimento de pedidos e muito mais. Sempre confira a resposta pra garantir que seu pedido foi processado corretamente.

Solução de problemas

Se você encontrar problemas ao fazer um pedido com um produto do cliente, verifique o seguinte:

Verifique se o productName corresponde exatamente ao nome do seu produto do cliente.
Certifique-se de que todas as opções obrigatórias de productVariant sejam fornecidas e correspondam à configuração do seu produto do cliente.
Verifique se os arquivos fornecidos atendem aos requisitos do seu produto do cliente.
Verifique se suas credenciais de API estão corretas e se você tem permissão para usar o produto do cliente especificado.

[Order Intake - GCW] Fazer um pedido usando produto do cliente