Importar e exportar um CSV de contrato
Use um arquivo com valores separados por vírgula (CSV, na sigla em inglês) para importar ou exportar contratos entre apps de assinatura de terceiros e o Shopify Subscriptions.
Para saber mais sobre como usar arquivos CSV, consulte Abrir e editar um arquivo CSV.
Nesta página
Fazer download de um arquivo CSV de amostra
É possível fazer download e visualizar um exemplo de arquivo CSV de contratos e usá-lo como modelo.
Considerações sobre o arquivo CSV de contratos
Antes de usar o arquivo CSV de contrato para importar contratos, revise as seguintes considerações.
Formatação do arquivo CSV
Para que o arquivo CSV do contrato seja importado corretamente, verifique se ele atende aos seguintes critérios:
- A primeira linha do arquivo CSV de contratos precisa conter os cabeçalhos das colunas, conforme especificado na tabela de descrição relacionada.
- Cada coluna precisa ser separada por vírgula.
- Um arquivo CSV pode ter no máximo 10 MB.
Entender a coluna de identificador
O identificador é usado para indicar cada contrato de maneira exclusiva e gerenciar dados das seguintes formas:
- Agrupando contratos com vários itens de linha: um identificador compartilhado agrupa contratos com vários itens de linha.
- Evitando contratos duplicados: contratos duplicados são ignorados na importação. Se uma linha com o mesmo identificador foi importada anteriormente, ela será ignorada no novo processo de importação. Esse mecanismo ajuda a evitar a duplicação de dados.
Contratos com vários itens de linha
Os contratos que incluem vários itens de linha exigem uma linha separada para cada item e são agrupados na coluna de identificador.
Por exemplo, se um contrato tiver três itens de linha, cada item precisa ser adicionado como uma linha separada. A primeira linha contém todas as informações do contrato, e as duas seguintes contêm apenas valores nas seguintes colunas:
- handle
- line_variant_id
- line_quantity
- line_current_price
- Opcional: line_selling_plan_id
- Opcional: line_selling_plan_name
O identificador precisa ser idêntico para as três colunas. Todas as outras colunas nas linhas dois e três precisam ficar em branco. Faça download do modelo de CSV de amostra para conferir um exemplo de contrato com vários itens de linha.
Descrição do arquivo CSV
As informações usadas no CSV de contrato são divididas nas seguintes categorias: * Nome do contrato * Informações de cliente e faturamento * Forma e informações de entrega * Itens incluídos na assinatura
Todas as colunas precisam ser adicionadas ao arquivo CSV para a importação correta, e todos os campos são obrigatórios, a menos que seja indicado de outra forma.
| Coluna | Descrição |
|---|---|
| Handle | Os identificadores são as etiquetas exclusivas de cada contrato. Por exemplo, camiseta-vermelha. Eles podem conter letras e números e, geralmente, são uma string combinada de letras, números ou ambos. Cada contrato precisa ter um identificador exclusivo. |
| upcoming_billing_date | A próxima data de faturamento do contrato. O horário está em UTC (Hora Universal Coordenada) e precisa ser formatado como YYYY-MM-DDTHH:MM:SSZ. Por exemplo, 15h50 de 7 de setembro de 2019, no fuso horário UTC (Hora Universal Coordenada) é representado como 2019-09-07T15:50:00Z. O valor da próxima data de faturamento precisa ser definido como uma data e hora pelo menos 24 horas após a data e a hora em que o arquivo CSV é importado. |
| customer_id | O ID do cliente, que precisa corresponder ao de um cliente atual no admin da Shopify e deve ser uma sequência de números. Por exemplo, 6320530986896. |
| currency_code | O código de moeda do contrato. Precisa corresponder a uma moeda ativa na loja. |
| status | O status do contrato, que pode ser:
|
| cadence_interval | A frequência de entrega da assinatura. O contrato pode ter um dos seguintes intervalos de cadência:
|
| cadence_interval_count | A frequência de entrega da assinatura no período geral. Por exemplo, o intervalo de cadência de cada mês é 1, e o intervalo para cada duas semanas é 2. |
| customer_payment_method_id | O ID da forma de pagamento usada pelo cliente no contrato. Precisa ser um código alfanumérico exclusivo, por exemplo, 24e8c839c47ef47d30ad28346d130e74. |
| delivery_price | O preço da entrega no formato de moeda correto. |
| delivery_method_type | A forma de entrega da assinatura, que precisa ser um dos seguintes tipos:
|
| delivery_address_first_name | O nome do destinatário no endereço de entrega. Campo obrigatório quando a forma de entrega é Frete e Entrega local. |
| delivery_address_last_name | Sobrenome do destinatário no endereço de entrega. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_address_address1 | A primeira linha do endereço de entrega. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_address_address2 | A segunda linha do endereço de entrega. Campo obrigatório apenas quando o endereço tiver um segundo campo e a forma de entrega for Frete ou Entrega local. |
| delivery_address_city | A cidade do endereço de entrega. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_address_province_code | O código ISO da província ou do estado do endereço de entrega. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_address_country_code | O código ISO do país do endereço de entrega. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_address_company | O nome da empresa do endereço de entrega. Campo obrigatório apenas quando o pedido for para uma empresa e a forma de entrega for Frete ou Entrega local. |
| delivery_address_zip | O CEP do endereço de entrega. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_address_phone | O número de telefone do endereço de entrega, por exemplo, +1 (613) 555-5555. Campo obrigatório apenas quando a forma de entrega é Frete e Entrega local. |
| delivery_local_delivery_phone | O número de telefone do endereço de entrega. Campo obrigatório para assinaturas com Entrega local. |
| delivery_local_delivery_instructions | Instruções de entrega local. O campo só precisa ser incluído quando são fornecidas instruções para assinaturas com Entrega local. |
| delivery_pickup_method_location_id | O ID de local da retirada. Campo obrigatório apenas para assinaturas com a forma Retirada no local. |
| line_variant_id | O ID de cada item de linha incluído na assinatura, por exemplo, 53154087005812. Caso vários itens de linha estejam incluídos na assinatura, cada item deverá ser adicionado como uma nova linha com o ID de variante exclusivo. |
| line_quantity | A quantidade de cada item de linha incluído na assinatura. Caso vários itens de linha estejam incluídos na assinatura, a quantidade adicionada deverá ser para o item específico, e não o total de todos os itens incluídos. |
| line_current_price | O preço do item de linha da assinatura no formato de moeda correto. |
| line_selling_plan_id | O ID do plano de assinatura, por exemplo, 3607724288. Campo opcional. |
| line_selling_plan_name | O nome do plano de assinatura. Campo opcional. |
Importar contratos com um arquivo CSV
Use um arquivo CSV para importar contratos existentes de um app de assinatura de terceiros qualificado da Shopify App Store ou do app Shopify Subscriptions em outra loja.
Não é possível usar o arquivo CSV para editar ou substituir contratos existentes. Cópias de contratos existentes são ignoradas na importação.
Importar contratos de um app de assinatura de terceiros
Talvez seja possível importar contratos de um app de assinatura de terceiros. Considere os seguintes comportamentos ao fazer essa importação:
- Se o app de assinatura de terceiros não estiver integrado ao Shopify Checkout, não será possível importar os contratos.
- Não é possível importar dados diretamente do app de terceiros. Você precisa adicionar os dados de contrato desse app a um CSV compatível com o app Shopify Subscriptions no formato correto para importar.
- Se o app de assinatura de terceiros não tiver um recurso de exportação ou se os dados exportados não incluírem todos os dados necessários, entre em contato com o desenvolvedor do app para receber atendimento.
Etapas:
- No admin da Shopify, acesse Assinaturas > Contratos.
- Clique em Importar.
- Clique em Adicionar arquivo e selecione aquele que você quer importar.
- Clique em Fazer upload de arquivo.
Após o upload do arquivo CSV, você receberá uma mensagem de confirmação na conta de e-mail usada para configurar a loja na Shopify. Leia as soluções para erros comuns de importação para ajudar em problemas de importação.
Exportar contratos com um arquivo CSV
Você pode exportar seus contratos para os registros ou importar para outra loja na Shopify em que o app Shopify Subscriptions esteja instalado.
Etapas:
- No admin da Shopify, acesse Assinaturas > Contratos.
- Clique em Exportar.