Compartilhar via


Etsy (Editor Independente)

Esse conector usa sua chave de API para acessar vários recursos de Etsy.com. Ele dá suporte a ações de inventário, pedidos de vendas e gerenciamento de lojas. Todas as ações são baseadas na API Aberta do Etsy v3, que tem pontos de extremidade que ainda estão na versão beta. Se, como ações, usarem a API beta, a ação com incluir Beta no título e retornará um código de resposta 501.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor, Hitachi Solutions
Site https://www.etsy.com/
Política de privacidade https://www.etsy.com/legal/privacy/
Categorias Commerce

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
chave de API secureString A chave de API para essa api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar as imagens de variação de uma listagem

Cria imagens de variação em uma listagem.

Atualizar o inventário de uma listagem

Atualiza o inventário de uma listagem identificada por uma ID de listagem. A atualização falhará se os valores fornecidos para a SKU do produto, a quantidade de oferta e/ou o preço forem incompatíveis com valores em campos de propriedade. Ao definir um preço, atribua um float igual ao valor dividido por divisor, conforme especificado no recurso de dinheiro.

Atualizar um destino de perfil de envio

Atualiza um destino de envio existente, que pode definir ou reatribuir o custo de envio, a transportadora e a classe para um destino.

Atualizar um perfil de envio

Altera as configurações em um perfil de envio.

Atualizar uma atualização de perfil de envio

Atualiza uma atualização de perfil de envio e atualiza todas as listagens que usam o perfil de envio.

Atualizar uma listagem

Atualiza uma listagem, identificada por uma ID de listagem, para uma loja específica identificada por uma ID de loja.

Atualizar uma loja

Atualize uma loja. Pressupõe que todos os parâmetros de cadeia de caracteres sejam fornecidos no idioma principal da loja.

Atualizar uma propriedade de listagem

Atualiza ou preenche a lista de propriedades que define ofertas de produtos para uma listagem. Cada oferta requer um valor e uma ID de valor que são válidos para uma ID de escala atribuída à listagem ou que você atribui à listagem com essa solicitação.

Atualizar uma tradução de listagem

Atualiza uma tradução de listagem listando a ID e o idioma.

Carregar um arquivo de listagem

Carrega um novo arquivo para uma listagem digital ou associa um arquivo existente a uma listagem específica. Você deve fornecer a ID de arquivo de listagem de um arquivo existente ou o nome e os dados de arquivo binário para um arquivo carregar. Associar um arquivo existente a uma listagem física converte a listagem física em uma listagem digital, o que remove todos os custos de envio e quaisquer variações de produto e inventário.

Carregar uma imagem de listagem

Carrega ou atribui uma imagem a uma listagem identificada por uma ID de loja com uma ID de listagem. Para carregar uma nova imagem, defina o arquivo de imagem como o valor do parâmetro de imagem. Você pode atribuir uma imagem excluída anteriormente a uma listagem usando a ID de imagem da imagem excluída no parâmetro de ID da imagem de listagem. Quando uma solicitação contém valores de parâmetro de ID de imagem e de listagem, o ponto de extremidade carrega a imagem somente no parâmetro de imagem.

Criar um destino de perfil de envio

Cria um novo destino de remessa, que define o custo de envio, a transportadora e a classe para um destino em um perfil de remessa. Isso atribui custos usando a moeda da loja associada. Defina o destino usando o ISO do país de destino ou a região de destino; ISO do país de destino e região de destino são mutuamente exclusivos – defina um ou outro. Definir ambos dispara o erro 400. Se a solicitação não definir o ISO do país de destino nem a região de destino, o destino padrão estará em todos os lugares. Você também deve atribuir uma ID de transportadora de remessa e uma classe de email ou dias de entrega mínimos e dias máximos de entrega.

Criar um perfil de envio

Cria um novo perfil de envio. Você pode passar um código ISO de país ou uma região ao criar um perfil de envio, mas não ambos. Apenas um é necessário. Você deve passar uma ID de transportadora de transporte e uma classe de email ou dias de entrega mínimos e máximos.

Criar um recibo de remessa

Envia informações de acompanhamento para um recibo de loja, que cria uma entrada de remessa de recibo de loja para a ID de recibo fornecida. Sempre que você envia informações de acompanhamento com êxito, o Etsy envia um email de notificação para o usuário comprador. Quando a CCO de envio é verdadeira, a Etsy também envia notificações de envio para o vendedor. Quando o código de rastreamento e o nome da transportadora não são enviados, o recibo é marcado apenas como fornecido.

Criar uma atualização de perfil de envio

Cria uma nova atualização de perfil de remessa, que pode estabelecer um preço para uma opção de envio, como uma transportadora alternativa ou entrega mais rápida.

Criar uma listagem de rascunho

Cria um produto de listagem de rascunho físico em uma loja no canal Etsy.

Criar uma seção de loja

Cria uma nova seção em uma loja específica.

Criar uma tradução de listagem

Cria uma tradução de listagem listando a ID e o idioma.

Excluir um arquivo da listagem

Quando você exclui o arquivo final de uma listagem digital, a listagem é convertida em uma listagem física. A resposta a uma solicitação de exclusão retorna uma lista dos registros de arquivo restantes associados à listagem fornecida.

Excluir um destino de perfil de envio

Exclui um destino de envio e remove a opção de destino de cada listagem que usa o perfil de envio associado. Um perfil de envio requer pelo menos um destino de envio, portanto, esse ponto de extremidade não pode excluir o destino de envio final para qualquer perfil de envio. Para excluir o destino de envio final de um perfil de envio, você deve excluir todo o perfil de envio.

Excluir um perfil de envio

Exclui um perfil de envio por determinada ID.

Excluir uma atualização de perfil de envio

Exclui uma atualização de perfil de envio e remove a opção de atualização de cada listagem que usa o perfil de envio associado.

Excluir uma imagem de listagem

Exclui uma imagem de listagem. Uma cópia do arquivo permanece em nossos servidores e, portanto, uma imagem excluída pode ser associada novamente à listagem sem carregar novamente a imagem original.

Excluir uma listagem

Essa ação exclui uma listagem de loja. Uma listagem só poderá ser excluída se o estado for um dos seguintes: SOLD_OUT, RASCUNHO, EXPIRADO, INATIVO, ATIVO e is_available ou ACTIVE e tiver sinalizadores de vendedor: SUPRESSED (congelado), VACATION, CUSTOM_SHOPS (padrão), SELL_ON_FACEBOOK

Excluir uma propriedade de listagem

Exclui uma propriedade de uma listagem.

Obter a ID do proprietário da loja

Recupera a loja identificada pela ID de usuário do proprietário da loja.

Obter a propriedade de uma listagem (Beta)

Recupera a propriedade de uma listagem. O desenvolvimento para esse ponto de extremidade está em andamento. Ele só retornará uma resposta 501.

Obter a tradução de uma listagem

Retorna a tradução para uma listagem no idioma especificado.

Obter a transação de uma loja

Recupera a lista de transações associadas a uma loja.

Obter as propriedades de uma listagem

Retorna uma lista das propriedades de uma listagem.

Obter atualizações de perfil de envio

Recupera a lista de atualizações de perfil de envio atribuídas a um perfil de envio específico.

Obter destinos de perfil enviando perfil

Recupera uma lista de objetos de destino de envio associados a um perfil de envio.

Obter endereços de usuário

Recupere uma lista de endereços de usuário.

Obter entradas do razão da conta de pagamento de uma loja

Recupere as entradas do razão da conta de pagamento de uma loja.

Obter imagens de uma listagem

Recupera todos os recursos de imagem de listagem para uma listagem com uma ID de listagem específica.

Obter imagens de variação da listagem

Obtém todas as imagens de variação em uma listagem.

Obter listagens ativas

Uma lista de todas as listagens ativas no Etsy paginadas pela data de criação. Sem listagens de ordem de classificação, as listagens serão retornadas primeiro por padrão.

Obter listagens ativas por loja

Recupera uma lista de todas as listagens ativas no Etsy em uma loja específica, paginada pela data de criação da listagem.

Obter listagens em destaque por loja

Recupera as listagens associadas a uma loja que são apresentadas.

Obter listagens por ID

Permite consultar várias IDs de listagem ao mesmo tempo. Limite o máximo de 100 IDs por consulta.

Obter listagens por ID da seção da loja

Recupera todas as listagens da seção de uma loja específica.

Obter listagens por loja

Retorna listagens que pertencem a uma Loja. As listagens podem ser filtradas usando o parâmetro de estado.

Obter listagens por recibo de loja

Obtém todas as listagens associadas a um recibo.

Obter nós de taxonomia do vendedor

Recupera a árvore de hierarquia completa dos nós de taxonomia do vendedor.

Obter o endereço do usuário

Recupera o endereço do usuário. O desenvolvimento para esse ponto de extremidade está em andamento. Ele só retornará uma resposta 501.

Obter o inventário de uma listagem

Recupera o registro de inventário de uma listagem. As listagens que você não editou usando as ferramentas de inventário Etsy.com não têm registros de inventário. Esse ponto de extremidade retornará dados de SKU se você for o proprietário dos registros de inventário que estão sendo buscados.

Obter o produto de uma listagem

Recupere um produto de listagem por ID.

Obter perfis de envio

Recupera uma lista de perfis de envio disponíveis na loja etsy específica identificada pela ID da loja.

Obter propriedades do produto por ID de taxonomia

Recupera uma lista de propriedades do produto, com escalas e valores aplicáveis, com suporte para uma ID de taxonomia de vendedor específica.

Obter recibos

Solicita os recibos da loja de uma loja específica, não filtradas ou filtradas pelo intervalo de ID de recibo ou deslocamento, data, pagamento e/ou compras enviadas.

Obter revisões

Recupera as revisões de uma loja dada sua ID.

Obter seção de loja

Recupera uma seção de loja, referenciada pela ID da seção e pela ID da loja.

Obter seções de loja

Recupera a lista de seções de loja em uma loja específica identificada pela ID da loja.

Obter todos os arquivos de listagem

Recupera todos os arquivos associados à listagem digital fornecida. Solicitar arquivos de uma listagem física retorna um resultado vazio.

Obter transportadoras de transporte

Recupera uma lista de transportadoras de transporte disponíveis e as classes de email associadas a elas para um determinado país.

Obter um arquivo de uma listagem

Recupera um único arquivo associado à listagem digital fornecida. Solicitar um arquivo de uma listagem física retorna um resultado vazio.

Obter um pagamento de um recibo específico

Recupera um pagamento de um recibo específico, identificado pela ID de recibo, de uma loja específica, identificada pela ID da loja.

Obter um pagamento de uma ID de entrada do razão da conta de pagamento

Obtenha um pagamento de uma ID de entrada do razão da conta de pagamento, se aplicável.

Obter um perfil de envio

Recupera um perfil de envio referenciado pela ID do perfil de envio.

Obter um recibo

Recupera um recibo, identificado por uma ID de recibo, de uma loja etsy.

Obter uma imagem de listagem

Recupera as referências e metadados de uma imagem de listagem com uma ID de imagem específica.

Obter uma lista de pagamentos

Recupera uma lista de pagamentos de uma loja identificada pela ID da loja. Você também pode filtrar os resultados usando uma lista de IDs de pagamento.

Obter uma listagem

Recupera um registro de listagem listando a ID.

Obter uma oferta de listagem

Obtenha uma oferta para uma listagem.

Obter uma transação

Recupera uma transação por ID da transação.

Obter uma transação de recibo

Recupera a lista de transações associadas a um recibo específico.

Obter usuário

Retorna o perfil de usuário para o usuário identificado por uma ID de usuário.

Pesquisar lojas

Retorna uma lista de lojas com o nome correspondente.

Ping

Verifique se há conectividade com a API etsy com um aplicativo.

Recuperar transações de uma listagem

Recupera a lista de transações associadas a uma listagem.

Atualizar as imagens de variação de uma listagem

Cria imagens de variação em uma listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Imagens de variação
variation_images True string

Uma matriz de dados de imagem de variação.

Retornos

Representa várias imagens de variação de listagem.

ListingVariationImages
ListingVariationImages

Atualizar o inventário de uma listagem

Atualiza o inventário de uma listagem identificada por uma ID de listagem. A atualização falhará se os valores fornecidos para a SKU do produto, a quantidade de oferta e/ou o preço forem incompatíveis com valores em campos de propriedade. Ao definir um preço, atribua um float igual ao valor dividido por divisor, conforme especificado no recurso de dinheiro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True string

A ID numérica da listagem associada a essa transação.

Products
products True string

Uma matriz JSON de produtos disponíveis em uma listagem, mesmo que apenas um produto. Todos os nomes de campo nos blobs JSON são minúsculos.

Preço na Propriedade
price_on_property string

Uma matriz de inteiros exclusivos de ID de propriedade de listagem para as propriedades que alteram os preços do produto, se houver. Por exemplo, se você cobrar preços específicos por diferentes produtos de tamanho na mesma listagem, essa matriz conterá a ID da propriedade para tamanho.

Quantidade na Propriedade
quantity_on_property string

Uma matriz de inteiros exclusivos de ID da propriedade de listagem para as propriedades que alteram a quantidade dos produtos, se houver. Por exemplo, se você estocar quantidades específicas de produtos coloridos diferentes na mesma listagem, essa matriz conterá a ID da propriedade para cor.

SKU na Propriedade
sku_on_property string

Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram o SKU do produto, se houver. Por exemplo, se você usar skus específicos para diferentes produtos coloridos na mesma listagem, essa matriz conterá a ID da propriedade para cor.

Retornos

Uma representação do registro de inventário de uma única listagem.

ListingInventory
ListingInventory

Atualizar um destino de perfil de envio

Atualiza um destino de envio existente, que pode definir ou reatribuir o custo de envio, a transportadora e a classe para um destino.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True string

A ID numérica do perfil de envio associado à listagem.

ID de destino do perfil de envio
shipping_profile_destination_id True string

A ID numérica do perfil de envio de destinoassociada com a listagem.

primary_cost
primary_cost string

primary_cost

secondary_cost
secondary_cost string

secondary_cost

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

Retornos

Representa um destino de envio atribuído a um perfil de envio.

ShopShippingProfileDestination
ShopShippingProfileDestination

Atualizar um perfil de envio

Altera as configurações em um perfil de envio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Title
title string

A cadeia de caracteres de nome deste perfil de envio.

ISO do país de origem
origin_country_iso string

O código ISO do país do qual a listagem é fornecida.

Tempo mínimo de processamento
min_processing_time integer

O tempo mínimo necessário para processar para enviar listagens com esse perfil de envio.

Tempo máximo de processamento
max_processing_time integer

O tempo máximo de processamento que a listagem precisa enviar.

Unidade de Tempo de Processamento
processing_time_unit string

A unidade usada para representar quanto tempo é o tempo de processamento. Uma semana é equivalente a 5 dias úteis. Se nenhum for fornecido, a unidade será definida como business_days.

Código Postal de Origem
origin_postal_code string

A cadeia de caracteres de código postal (não necessariamente um número) para o local do qual a listagem é fornecida.

Retornos

Representa um perfil usado para definir as informações de envio de uma listagem. Observe que não é possível criar modelos de envio calculados por meio da API. No entanto, você pode associar perfis de envio calculados criados do Shop Manager a listagens usando a API.

ShopShippingProfile
ShopShippingProfile

Atualizar uma atualização de perfil de envio

Atualiza uma atualização de perfil de envio e atualiza todas as listagens que usam o perfil de envio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

ID de atualização
upgrade_id True integer

A ID numérica associada a uma atualização de envio

Tipo
type string

O tipo da atualização de envio. Doméstico (0) ou internacional (1).

Nome da Atualização
upgrade_name string

Nome da atualização de envio mostrada aos compradores no check-out, por exemplo, Prioridade do USPS.

Preço
price float

Custo adicional de adição da atualização de envio.

Preço secundário
secondary_price float

Custo adicional de adição da atualização de envio para cada item adicional.

ID da transportadora de transporte
shipping_carrier_id integer

A ID exclusiva de uma transportadora com suporte, que é usada para calcular uma Data de Entrega Estimada.

Classe de email
mail_class string

A cadeia de caracteres de ID exclusiva da classe de email de uma transportadora, que é usada para calcular uma data de entrega estimada.

Dias mínimos de entrega
min_delivery_days integer

min_delivery_days

Dias máximos de entrega
max_delivery_days integer

O número máximo de dias úteis que um comprador pode esperar para receber seu item comprado depois de enviado.

Retornos

Uma representação de uma opção de atualização de perfil de envio.

ShopShippingProfileUpgrade
ShopShippingProfileUpgrade

Atualizar uma listagem

Atualiza uma listagem, identificada por uma ID de listagem, para uma loja específica identificada por uma ID de loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Quantidade
quantity integer

O número positivo não zero de produtos disponíveis para compra na listagem.

Title
title string

A cadeia de caracteres de título da listagem. As cadeias de caracteres de título válidas contêm apenas letras, números, marcas de pontuação, símbolos matemáticos, caracteres ™ © de espaço em branco e ® . (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) Você só pode usar os caracteres %, :, &e + uma vez cada.

Description
description string

Uma cadeia de caracteres de descrição do produto à venda na listagem.

Preço
price float

O preço positivo diferente de zero do produto. (As listagens de produtos vendidos são privadas) Observação: o preço é o preço mínimo possível.

Quem fez
who_made string

Uma cadeia de caracteres inidcatou quem fez o produto. Ajuda os compradores a localizar a listagem sob o título Artesanal. Requer 'is_supply' e 'when_made'.

Quando Feito
when_made string

Uma cadeia de caracteres para a era em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar a listagem sob o título Vintage. Requer 'is_supply' e 'who_made'.

ID da taxonomia
taxonomy_id integer

A ID de taxonomia numérica da listagem. O vendedor gerencia a listagem de IDs de taxonomia para sua loja.

ID do perfil de envio
shipping_profile_id integer

A ID numérica do perfil de envio associado à listagem.

Materials
materials string

Uma matriz de cadeias de caracteres de material para materiais usados no produto. As cadeias de caracteres de materiais válidos contêm apenas letras, números e caracteres de espaço em branco. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

ID da Seção da Loja
shop_section_id integer

A ID numérica da seção da loja para esta listagem.

Processamento mínimo
processing_min integer

O número mínimo de dias necessários para processar essa listagem.

Máximo de processamento
processing_max integer

O número máximo de dias necessários para processar essa listagem.

Etiquetas
tags string

Uma matriz de cadeias de caracteres de marca para a listagem. As cadeias de caracteres de marca válidas contêm apenas letras, números, caracteres de espaço em branco, -, ', ™ , © e ® . (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

Uma cadeia de caracteres que indica uma pessoa para quem este produto faria um presente apropriado.

Ocasião
occasion string

Uma cadeia de caracteres que indica uma ocasião para a qual este produto seria um presente apropriado.

Estilos
styles string

Uma matriz de cadeias de caracteres de estilo para esta listagem, cada uma delas é uma cadeia de caracteres de texto de forma livre, como Formal ou Steampunk. Uma listagem pode ter até dois estilos. As cadeias de caracteres de estilo válidas contêm apenas letras, números e caracteres de espaço em branco. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Peso do item
item_weight float

O peso numérico do produto medido em unidades definidas na unidade de peso do item.

Comprimento do item
item_length integer

O comprimento numérico do produto medido em unidades definidas na unidade de dimensões do item.

Largura do Item
item_width float

A largura numérica do produto medido em unidades definidas em "unidade de dimensões de item".

Altura do Item
item_height float

A altura numérica do produto medido em unidades definidas em "unidade de dimensões de item".

Unidade de peso do item
item_weight_unit string

Uma cadeia de caracteres que define as unidades usadas para medir o peso do produto.

Unidade dimensões de item
item_dimensions_unit string

Uma cadeia de caracteres que define as unidades usadas para medir as dimensões do produto.

É personalizável
is_personalizable boolean

Quando verdadeiro, essa listagem é personalizável.

IDs de imagem
image_ids string

Uma matriz de IDs de imagem numérica das imagens em uma listagem, que pode incluir até 10 imagens.

É o fornecimento
is_supply boolean

Quando verdadeiro, marca a listagem como um produto de fornecimento, caso contrário, indica que ele é um produto concluído. Ajuda os compradores a localizar a listagem no título Suprimentos. Requer "quem fez" e "quando feito".

É personalizável
is_customizable boolean

Quando verdadeiro, um comprador pode entrar em contato com o vendedor para obter um pedido personalizado. O valor padrão é verdadeiro quando uma loja aceita pedidos personalizados. Não se aplica a lojas que não aceitam pedidos personalizados.

É tributável
is_taxable boolean

Quando verdadeiro, as taxas de imposto de loja aplicáveis se aplicam a esta listagem no check-out.

Classificação em destaque
featured_ rank integer

A posição numérica positiva diferente de zero nas listagens em destaque da loja com listagens de classificação 1 aparecendo na posição mais à esquerda na listagem em destaque na home page de uma loja.

Deve renovar automaticamente
should_auto_renew boolean

Quando verdadeiro, renova uma listagem por quatro meses após a expriação. Se definido como true quando anteriormente falso, etsy.com renovará a listagem antes de expirar, mas o período de renovação começará imensualmente em vez de estender a data de validade da listagem. Qualquer tempo não utilizado restante na listagem é perdido. As renovações resultam em encargos na fatura de um usuário.

Tipo
type string

Indica se a listagem é física ou um download digital.

Canais
channels string

Uma matriz de cadeias de caracteres de ID de canal enumeradas. Um canal é um local para vendedores alcançarem compradores para fazer vendas.

Retornos

Uma listagem de uma loja, que contém uma quantidade de produto, título, descrição, preço etc.

ShopListing
ShopListing

Atualizar uma loja

Atualize uma loja. Pressupõe que todos os parâmetros de cadeia de caracteres sejam fornecidos no idioma principal da loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Title
title string

Uma breve cadeia de caracteres de título para a página principal da loja.

Comunicado
announcement string

Uma cadeia de caracteres de anúncio para compradores que é exibida na home page da loja.

Mensagem de venda
sale_message string

Uma cadeia de caracteres de mensagem enviada aos usuários que concluirem uma compra desta loja.

Mensagem de venda digital
digital_sale_message string

Uma cadeia de caracteres de mensagem enviada aos usuários que compram um item digital desta loja.

Retornos

Uma loja criada por um usuário do Etsy.

Shop
Shop

Atualizar uma propriedade de listagem

Atualiza ou preenche a lista de propriedades que define ofertas de produtos para uma listagem. Cada oferta requer um valor e uma ID de valor que são válidos para uma ID de escala atribuída à listagem ou que você atribui à listagem com essa solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

ID da Propriedade
property_id True integer

A ID exclusiva de uma propriedade de listagem etsy.

IDs de valor
value_ids True integer

A ID numérica de uma única escala de medida de Etsy.com.

Valores
values True string

Uma matriz de cadeias de caracteres de valor para vários valores de propriedade de listagem etsy.

ID de escala
scale_id integer

A ID numérica de uma única escala de medida de Etsy.com.

Retornos

Uma representação de valores de dados estruturados.

ListingPropertyValue
ListingPropertyValue

Atualizar uma tradução de listagem

Atualiza uma tradução de listagem listando a ID e o idioma.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Linguagem
language True string

A marca de idioma IETF para o idioma dessa tradução. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Title
title True string

O título da Listagem desta Tradução.

Description
description True string

A descrição da Listagem desta Tradução.

Etiquetas
tags string

As marcas da Listagem desta Tradução.

Retornos

Representa os dados de tradução de uma listagem.

ListingTranslation
ListingTranslation

Carregar um arquivo de listagem

Carrega um novo arquivo para uma listagem digital ou associa um arquivo existente a uma listagem específica. Você deve fornecer a ID de arquivo de listagem de um arquivo existente ou o nome e os dados de arquivo binário para um arquivo carregar. Associar um arquivo existente a uma listagem física converte a listagem física em uma listagem digital, o que remove todos os custos de envio e quaisquer variações de produto e inventário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Listando A ID do Arquivo
listing_file_id integer

A ID numérica exclusiva de um arquivo associado a uma listagem digital.

File
file True string

Um arquivo binário a ser carregado.

Nome
name string

A cadeia de caracteres de nome de arquivo de um arquivo a ser carregado

Classificação
rank integer

A posição numérica positiva diferente de zero nas imagens exibidas em uma listagem, com imagens de classificação 1 aparecendo na posição mais à esquerda em uma listagem.

Retornos

Um arquivo associado a uma listagem digital.

ShopListingFile
ShopListingFile

Carregar uma imagem de listagem

Carrega ou atribui uma imagem a uma listagem identificada por uma ID de loja com uma ID de listagem. Para carregar uma nova imagem, defina o arquivo de imagem como o valor do parâmetro de imagem. Você pode atribuir uma imagem excluída anteriormente a uma listagem usando a ID de imagem da imagem excluída no parâmetro de ID da imagem de listagem. Quando uma solicitação contém valores de parâmetro de ID de imagem e de listagem, o ponto de extremidade carrega a imagem somente no parâmetro de imagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Imagem
image string

A cadeia de caracteres de nome de arquivo de um arquivo a ser carregado.

Listando a ID da imagem
listing_image_id integer

A ID numérica da imagem de listagem primária para essa transação.

Classificação
rank integer

A posição numérica positiva diferente de zero nas imagens exibidas em uma listagem, com imagens de classificação 1 aparecendo na posição mais à esquerda em uma listagem.

Sobrescrever
overwrite boolean

Quando true, essa solicitação substitui a imagem existente em uma determinada classificação.

Está marcado como marca d'água
is_watermarked boolean

Quando true, indica que a imagem carregada tem uma marca d'água.

Retornos

Urls de referência e metadados para uma imagem associada a uma listagem específica. O url_fullxfull parâmetro contém a URL do arquivo de imagem binária de tamanho completo.

ListingImage
ListingImage

Criar um destino de perfil de envio

Cria um novo destino de remessa, que define o custo de envio, a transportadora e a classe para um destino em um perfil de remessa. Isso atribui custos usando a moeda da loja associada. Defina o destino usando o ISO do país de destino ou a região de destino; ISO do país de destino e região de destino são mutuamente exclusivos – defina um ou outro. Definir ambos dispara o erro 400. Se a solicitação não definir o ISO do país de destino nem a região de destino, o destino padrão estará em todos os lugares. Você também deve atribuir uma ID de transportadora de remessa e uma classe de email ou dias de entrega mínimos e dias máximos de entrega.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Custo Primário
primary_cost True float

O custo de envio apenas para este país/região, medido na moeda padrão da loja.

Custo Secundário
secondary_cost True string

O custo de envio para este país/região com outro item, medido na moeda padrão da loja.

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

Retornos

Representa um destino de envio atribuído a um perfil de envio.

ShopShippingProfileDestination
ShopShippingProfileDestination

Criar um perfil de envio

Cria um novo perfil de envio. Você pode passar um código ISO de país ou uma região ao criar um perfil de envio, mas não ambos. Apenas um é necessário. Você deve passar uma ID de transportadora de transporte e uma classe de email ou dias de entrega mínimos e máximos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Title
title True string

A cadeia de caracteres de nome deste perfil de envio.

ISO do país de origem
origin_country_iso True string

O código ISO do país do qual a listagem é fornecida.

Custo Primário
primary_cost True float

O custo de envio apenas para este país/região, medido na moeda padrão da loja.

Custo Secundário
secondary_cost True float

O custo de envio para este país/região com outro item, medido na moeda padrão da loja.

Tempo mínimo de processamento
min_processing_time True integer

O tempo mínimo necessário para processar para enviar listagens com esse perfil de envio.

Tempo máximo de processamento
max_processing_time True integer

O tempo máximo de processamento que a listagem precisa enviar.

Unidade de Tempo de Processamento
processing_time_unit string

A unidade usada para representar quanto tempo é o tempo de processamento. Uma semana é equivalente a 5 dias úteis.

ISO do país de destino
destination_country_iso string

O código ISO do país para o qual a listagem é fornecida. Se for nulo, a solicitação definirá o destino para a região de destino.

Região de destino
destination_region string

O código da região para a qual a listagem é fornecida. Uma região representa um conjunto de países. As regiões com suporte são a União Europeia e a União Não Europeia (países da Europa não estão na UE). Se nenhum, a solicitação definirá o destino como ISO do país de destino ou em todos os lugares se o ISO do país de destino também for nulo.

Código Postal de Origem
origin_postal_code string

A cadeia de caracteres de código postal (não necessariamente um número) para o local do qual a listagem é fornecida.

ID da transportadora de transporte
shipping_carrier_id integer

A ID exclusiva de uma transportadora com suporte, que é usada para calcular uma data de entrega estimada.

Classe de email
mail_class string

A cadeia de caracteres de ID exclusiva da classe de email de uma transportadora, que é usada para calcular uma data de entrega estimada.

Dias mínimos de entrega
min_delivery_days integer

O número mínimo de dias úteis que um comprador pode esperar para receber seu item comprado assim que for enviado.

Dias máximos de entrega
max_delivery_days integer

O número máximo de dias úteis que um comprador pode esperar para receber seu item comprado depois de enviado.

Retornos

Representa um perfil usado para definir as informações de envio de uma listagem. Observe que não é possível criar modelos de envio calculados por meio da API. No entanto, você pode associar perfis de envio calculados criados do Shop Manager a listagens usando a API.

ShopShippingProfile
ShopShippingProfile

Criar um recibo de remessa

Envia informações de acompanhamento para um recibo de loja, que cria uma entrada de remessa de recibo de loja para a ID de recibo fornecida. Sempre que você envia informações de acompanhamento com êxito, o Etsy envia um email de notificação para o usuário comprador. Quando a CCO de envio é verdadeira, a Etsy também envia notificações de envio para o vendedor. Quando o código de rastreamento e o nome da transportadora não são enviados, o recibo é marcado apenas como fornecido.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do recibo
receipt_id True integer

O recibo para o qual enviar o acompanhamento.

Código de acompanhamento
tracking_code string

O código de acompanhamento deste recibo.

Nome da transportadora
carrier_name string

O nome da transportadora para este recibo.

Enviar CCO
send_bcc boolean

Se for true, a notificação de envio também será enviada ao vendedor

Retornos

O registro de uma compra de uma loja. Os recibos da loja exibem valores monetários usando a moeda da loja.

ShopReceipt
ShopReceipt

Criar uma atualização de perfil de envio

Cria uma nova atualização de perfil de remessa, que pode estabelecer um preço para uma opção de envio, como uma transportadora alternativa ou entrega mais rápida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Tipo
type True string

O tipo da atualização de envio. Doméstico (0) ou internacional (1).

Nome da Atualização
upgrade_name True string

Nome da atualização de envio mostrada aos compradores no check-out, por exemplo, Prioridade do USPS.

Preço
price True float

Custo adicional de adição da atualização de envio.

Preço secundário
secondary_price True float

Custo adicional de adição da atualização de envio para cada item adicional.

ID da transportadora de transporte
shipping_carrier_id integer

A ID exclusiva de uma transportadora com suporte, que é usada para calcular uma Data de Entrega Estimada.

Classe de email
mail_class string

A cadeia de caracteres de ID exclusiva da classe de email de uma transportadora, que é usada para calcular uma data de entrega estimada.

Dias mínimos de entrega
min_delivery_days integer

min_delivery_days

Dias máximos de entrega
max_delivery_days integer

O número máximo de dias úteis que um comprador pode esperar para receber seu item comprado depois de enviado.

Retornos

Uma representação de uma opção de atualização de perfil de envio.

ShopShippingProfileUpgrade
ShopShippingProfileUpgrade

Criar uma listagem de rascunho

Cria um produto de listagem de rascunho físico em uma loja no canal Etsy.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Quantidade
quantity True integer

O número positivo não zero de produtos disponíveis para compra na listagem.

Title
title True string

A cadeia de caracteres de título da listagem. As cadeias de caracteres de título válidas contêm apenas letras, números, marcas de pontuação, símbolos matemáticos, caracteres ™ © de espaço em branco e ® . (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) Você só pode usar os caracteres %, :, &e + uma vez cada.

Description
description True string

Uma cadeia de caracteres de descrição do produto à venda na listagem.

Preço
price True float

O preço positivo diferente de zero do produto. (As listagens de produtos vendidos são privadas) Observação: o preço é o preço mínimo possível.

Quem fez
who_made True string

Uma cadeia de caracteres inidcatou quem fez o produto. Ajuda os compradores a localizar a listagem sob o título Artesanal. Requer 'is_supply' e 'when_made'.

Quando Feito
when_made string

Uma cadeia de caracteres para a era em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar a listagem sob o título Vintage. Requer 'is_supply' e 'who_made'.

ID da taxonomia
taxonomy_id True integer

A ID de taxonomia numérica da listagem. O vendedor gerencia a listagem de IDs de taxonomia para sua loja.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Materials
materials string

Uma matriz de cadeias de caracteres de material para materiais usados no produto. As cadeias de caracteres de materiais válidos contêm apenas letras, números e caracteres de espaço em branco. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

ID da Seção da Loja
shop_section_id integer

A ID numérica da seção da loja para esta listagem.

Processamento mínimo
processing_min integer

O número mínimo de dias necessários para processar essa listagem.

Máximo de processamento
processing_max integer

O número máximo de dias necessários para processar essa listagem.

Etiquetas
tags string

Uma matriz de cadeias de caracteres de marca para a listagem. As cadeias de caracteres de marca válidas contêm apenas letras, números, caracteres de espaço em branco, -, ', ™ , © e ® . (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

Uma cadeia de caracteres que indica uma pessoa para quem este produto faria um presente apropriado.

Ocasião
occasion string

Uma cadeia de caracteres que indica uma ocasião para a qual este produto seria um presente apropriado.

Estilos
styles string

Uma matriz de cadeias de caracteres de estilo para esta listagem, cada uma delas é uma cadeia de caracteres de texto de forma livre, como Formal ou Steampunk. Uma listagem pode ter até dois estilos. As cadeias de caracteres de estilo válidas contêm apenas letras, números e caracteres de espaço em branco. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Peso do item
item_weight float

O peso numérico do produto medido em unidades definidas na unidade de peso do item.

Comprimento do item
item_length integer

O comprimento numérico do produto medido em unidades definidas na unidade de dimensões do item.

Largura do Item
item_width float

A largura numérica do produto medido em unidades definidas em "unidade de dimensões de item".

Altura do Item
item_height float

A altura numérica do produto medido em unidades definidas em "unidade de dimensões de item".

Unidade de peso do item
item_weight_unit string

Uma cadeia de caracteres que define as unidades usadas para medir o peso do produto.

Unidade dimensões de item
item_dimensions_unit string

Uma cadeia de caracteres que define as unidades usadas para medir as dimensões do produto.

É personalizável
is_personalizable boolean

Quando verdadeiro, essa listagem é personalizável.

IDs de imagem
image_ids string

Uma matriz de IDs de imagem numérica das imagens em uma listagem, que pode incluir até 10 imagens.

É o fornecimento
is_supply boolean

Quando verdadeiro, marca a listagem como um produto de fornecimento, caso contrário, indica que ele é um produto concluído. Ajuda os compradores a localizar a listagem no título Suprimentos. Requer "quem fez" e "quando feito".

É personalizável
is_customizable boolean

Quando verdadeiro, um comprador pode entrar em contato com o vendedor para obter um pedido personalizado. O valor padrão é verdadeiro quando uma loja aceita pedidos personalizados. Não se aplica a lojas que não aceitam pedidos personalizados.

É tributável
is_taxable boolean

Quando verdadeiro, as taxas de imposto de loja aplicáveis se aplicam a esta listagem no check-out.

Retornos

Uma listagem de uma loja, que contém uma quantidade de produto, título, descrição, preço etc.

ShopListing
ShopListing

Criar uma seção de loja

Cria uma nova seção em uma loja específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Title
title True string

A cadeia de caracteres de título de uma seção de loja.

Retornos

Uma seção dentro de uma loja, na qual um usuário pode classificar listagens.

ShopSection
ShopSection

Criar uma tradução de listagem

Cria uma tradução de listagem listando a ID e o idioma.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Linguagem
language True string

A marca de idioma IETF para o idioma dessa tradução. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Title
title True string

O título da Listagem desta Tradução.

Description
description True string

A descrição da Listagem desta Tradução.

Etiquetas
tags string

As marcas da Listagem desta Tradução.

Retornos

Representa os dados de tradução de uma listagem.

ListingTranslation
ListingTranslation

Excluir um arquivo da listagem

Quando você exclui o arquivo final de uma listagem digital, a listagem é convertida em uma listagem física. A resposta a uma solicitação de exclusão retorna uma lista dos registros de arquivo restantes associados à listagem fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Listando A ID do Arquivo
listing_file_id True integer

A ID numérica exclusiva de um arquivo associado a uma listagem digital.

Excluir um destino de perfil de envio

Exclui um destino de envio e remove a opção de destino de cada listagem que usa o perfil de envio associado. Um perfil de envio requer pelo menos um destino de envio, portanto, esse ponto de extremidade não pode excluir o destino de envio final para qualquer perfil de envio. Para excluir o destino de envio final de um perfil de envio, você deve excluir todo o perfil de envio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

ID de destino do perfil de envio
shipping_profile_destination_id True integer

A ID numérica do destino do perfil de envio no perfil de envio associado à listagem.

Excluir um perfil de envio

Exclui um perfil de envio por determinada ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Retornos

Representa um perfil usado para definir as informações de envio de uma listagem. Observe que não é possível criar modelos de envio calculados por meio da API. No entanto, você pode associar perfis de envio calculados criados do Shop Manager a listagens usando a API.

ShopShippingProfile
ShopShippingProfile

Excluir uma atualização de perfil de envio

Exclui uma atualização de perfil de envio e remove a opção de atualização de cada listagem que usa o perfil de envio associado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio.

ID de atualização
upgrade_id True integer

A ID numérica associada a uma atualização de envio

Excluir uma imagem de listagem

Exclui uma imagem de listagem. Uma cópia do arquivo permanece em nossos servidores e, portanto, uma imagem excluída pode ser associada novamente à listagem sem carregar novamente a imagem original.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Listando a ID da imagem
listing_image_id True integer

A ID numérica da imagem de listagem primária para essa transação.

Excluir uma listagem

Essa ação exclui uma listagem de loja. Uma listagem só poderá ser excluída se o estado for um dos seguintes: SOLD_OUT, RASCUNHO, EXPIRADO, INATIVO, ATIVO e is_available ou ACTIVE e tiver sinalizadores de vendedor: SUPRESSED (congelado), VACATION, CUSTOM_SHOPS (padrão), SELL_ON_FACEBOOK

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Excluir uma propriedade de listagem

Exclui uma propriedade de uma listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

ID da Propriedade
property_id True integer

A ID exclusiva de uma propriedade de listagem etsy.

Obter a ID do proprietário da loja

Recupera a loja identificada pela ID de usuário do proprietário da loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Usuário
user_id True string

A ID do usuário numérico do usuário proprietário desta loja.

Retornos

Uma loja criada por um usuário do Etsy.

Shop
Shop

Obter a propriedade de uma listagem (Beta)

Recupera a propriedade de uma listagem. O desenvolvimento para esse ponto de extremidade está em andamento. Ele só retornará uma resposta 501.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

ID da Propriedade
property_id True integer

A ID exclusiva de uma propriedade de listagem etsy.

Retornos

Uma representação de valores de dados estruturados.

ListingPropertyValue
ListingPropertyValue

Obter a tradução de uma listagem

Retorna a tradução para uma listagem no idioma especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Linguagem
language True string

A marca de idioma IETF para o idioma dessa tradução. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Retornos

Representa os dados de tradução de uma listagem.

ListingTranslation
ListingTranslation

Obter a transação de uma loja

Recupera a lista de transações associadas a uma loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de recursos de transação de recibo de loja

ShopReceiptTransactions
ShopReceiptTransactions

Obter as propriedades de uma listagem

Retorna uma lista das propriedades de uma listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Retornos

Representa vários valores de propriedade de listagem.

ListingPropertyValues
ListingPropertyValues

Obter atualizações de perfil de envio

Recupera a lista de atualizações de perfil de envio atribuídas a um perfil de envio específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Retornos

Uma lista de opções de atualização de envio.

ShopShippingProfileUpgrades
ShopShippingProfileUpgrades

Obter destinos de perfil enviando perfil

Recupera uma lista de objetos de destino de envio associados a um perfil de envio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Representa uma lista de objetos de destino de envio.

ShopShippingProfileDestinations
ShopShippingProfileDestinations

Obter endereços de usuário

Recupere uma lista de endereços de usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Representa vários registros UserAddress.

UserAddresses
UserAddresses

Obter entradas do razão da conta de pagamento de uma loja

Recupere as entradas do razão da conta de pagamento de uma loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Mínimo criado
min_created True integer

O primeiro carimbo de data/hora unix para quando um registro foi criado.

Máximo criado
max_created True integer

O carimbo de data/hora unix mais recente para quando um registro foi criado.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de recursos de entrada do razão da conta de pagamento

PaymentAccountLedgerEntries
PaymentAccountLedgerEntries

Obter imagens de uma listagem

Recupera todos os recursos de imagem de listagem para uma listagem com uma ID de listagem específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Retornos

Representa uma lista de recursos de imagem de listagem, cada um dos quais contém as URLs de referência e os metadados de uma imagem.

ListingImages
ListingImages

Obter imagens de variação da listagem

Obtém todas as imagens de variação em uma listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Retornos

Representa várias imagens de variação de listagem.

ListingVariationImages
ListingVariationImages

Obter listagens ativas

Uma lista de todas as listagens ativas no Etsy paginadas pela data de criação. Sem listagens de ordem de classificação, as listagens serão retornadas primeiro por padrão.

Parâmetros

Nome Chave Obrigatório Tipo Description
Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Includes
keywords string

Termo ou frase de pesquisa que deve aparecer em todos os resultados.

Classificar em
sort_on string

O valor no qual classificar um resultado de pesquisa de listagens. OBSERVAÇÃO: classificar só funciona quando combinado com uma das opções de pesquisa (palavras-chave, região etc.).

Ordem de Classificação
sort_order string

A ordem crescente(para cima) ou decrescente(para baixo) para classificar as listagens. OBSERVAÇÃO: sort_order só funciona quando combinado com uma das opções de pesquisa (palavras-chave, região etc.).

Preço Mínimo
min_price float

O preço mínimo das listagens a serem retornadas por um resultado de pesquisa.

Preço Máximo
max_price float

O preço máximo das listagens a serem retornadas por um resultado de pesquisa.

ID da taxonomia
taxonomy_id integer

A ID de taxonomia numérica da listagem. O vendedor gerencia a listagem de IDs de taxonomia para sua loja.

Local da Loja
shop_location string

Filtros por local de loja. Se o local não puder ser analisado, o Etsy responderá com um erro.

Retornos

Um conjunto de recursos de listagem de lojas.

ShopListings
ShopListings

Obter listagens ativas por loja

Recupera uma lista de todas as listagens ativas no Etsy em uma loja específica, paginada pela data de criação da listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Includes
keywords string

Termo ou frase de pesquisa que deve aparecer em todos os resultados.

Retornos

Um conjunto de recursos de listagem de lojas.

ShopListings
ShopListings

Obter listagens em destaque por loja

Recupera as listagens associadas a uma loja que são apresentadas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de recursos de listagem de lojas.

ShopListings
ShopListings

Obter listagens por ID

Permite consultar várias IDs de listagem ao mesmo tempo. Limite o máximo de 100 IDs por consulta.

Parâmetros

Nome Chave Obrigatório Tipo Description
Listando IDs
listing_ids True string

A matriz de IDs numéricas para as listagens em uma loja etsy específica.

Includes
includes string

Uma cadeia de caracteres enumerada que anexa uma associação válida.

Retornos

Um conjunto de recursos de listagem de lojas com associações.

ShopListingsWithAssociations
ShopListingsWithAssociations

Obter listagens por ID da seção da loja

Recupera todas as listagens da seção de uma loja específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

IDs de seção de loja
shop_section_ids True string

Uma matriz de IDs numéricas para todas as seções em uma loja etsy específica.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Classificar em
sort_on string

O valor no qual classificar um resultado de pesquisa de listagens.

Ordem de Classificação
sort_order string

A ordem crescente(para cima) ou decrescente(para baixo) para classificar as listagens.

Retornos

Um conjunto de recursos de listagem de lojas.

ShopListings
ShopListings

Obter listagens por loja

Retorna listagens que pertencem a uma Loja. As listagens podem ser filtradas usando o parâmetro de estado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Estado
State string

Uma cadeia de caracteres enumerada de qualquer um dos: ativos ou inativos.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Classificar em
Sort On string

O valor no qual classificar um resultado de pesquisa de listagens.

Ordem de Classificação
Sort Order string

A ordem crescente(para cima) ou decrescente(para baixo) para classificar as listagens.

Retornos

Um conjunto de recursos de listagem de lojas.

ShopListings
ShopListings

Obter listagens por recibo de loja

Obtém todas as listagens associadas a um recibo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica do recibo associado a essa transação.

ID do recibo
receipt_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de recursos de listagem de lojas.

ShopListings
ShopListings

Obter nós de taxonomia do vendedor

Recupera a árvore de hierarquia completa dos nós de taxonomia do vendedor.

Retornos

Uma lista de nós de taxonomia da árvore de taxonomia do vendedor.

SellerTaxonomyNodes
SellerTaxonomyNodes

Obter o endereço do usuário

Recupera o endereço do usuário. O desenvolvimento para esse ponto de extremidade está em andamento. Ele só retornará uma resposta 501.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do endereço do usuário
user_address_id True integer

A ID numérica do endereço do usuário.

Retornos

Representa o endereço de um usuário.

UserAddress
UserAddress

Obter o inventário de uma listagem

Recupera o registro de inventário de uma listagem. As listagens que você não editou usando as ferramentas de inventário Etsy.com não têm registros de inventário. Esse ponto de extremidade retornará dados de SKU se você for o proprietário dos registros de inventário que estão sendo buscados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Includes
includes string

Uma cadeia de caracteres enumerada que anexa uma associação válida.

Retornos

Uma representação do registro de inventário de uma única listagem com associações

ListingInventoryWithAssociations
ListingInventoryWithAssociations

Obter o produto de uma listagem

Recupere um produto de listagem por ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True integer

A listagem para a qual retornar um produto de listagem.

ID do Produto
product_id True integer

A ID numérica de um produto específico comprado de uma listagem.

Retornos

Uma representação de um produto para uma listagem.

ListingInventoryProduct
ListingInventoryProduct

Obter perfis de envio

Recupera uma lista de perfis de envio disponíveis na loja etsy específica identificada pela ID da loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Retornos

Representa um perfil usado para definir as informações de envio de uma listagem. Observe que não é possível criar modelos de envio calculados por meio da API. No entanto, você pode associar perfis de envio calculados criados do Shop Manager a listagens usando a API.

ShopShippingProfile
ShopShippingProfile

Obter propriedades do produto por ID de taxonomia

Recupera uma lista de propriedades do produto, com escalas e valores aplicáveis, com suporte para uma ID de taxonomia de vendedor específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da taxonomia
taxonomy_id True string

A ID numérica exclusiva de um nó de taxonomia etsy, que é uma categoria de metadados para listagens organizadas na árvore de hierarquia de taxonomia do vendedor.

Retornos

Uma lista de definições de propriedade do produto.

TaxonomyNodeProperties
TaxonomyNodeProperties

Obter recibos

Solicita os recibos da loja de uma loja específica, não filtradas ou filtradas pelo intervalo de ID de recibo ou deslocamento, data, pagamento e/ou compras enviadas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Mínimo criado
min_created integer

O primeiro carimbo de data/hora unix para quando um registro foi criado.

Máximo criado
max_created integer

O carimbo de data/hora unix mais recente para quando um registro foi criado.

Última modificação mais antiga
min_last_modified integer

O carimbo de data/hora unix mais antigo para quando um registro foi alterado pela última vez.

Última Modificação
max_last_modified integer

O último carimbo de data/hora unix para quando um registro foi alterado pela última vez.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Foi pago
was_paid boolean

Quando verdadeiro, o vendedor recebeu o pagamento pelo(s) produto(s) neste recibo.

Foi enviado
was_shipped boolean

Quando verdadeiro, o vendedor enviou os produtos neste recibo.

Retornos

Os recibos de uma Loja específica.

ShopReceipts
ShopReceipts

Obter revisões

Recupera as revisões de uma loja dada sua ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de registros de revisão de transações deixados pelos usuários.

TransactionReviews
TransactionReviews

Obter seção de loja

Recupera uma seção de loja, referenciada pela ID da seção e pela ID da loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID da Seção da Loja
shop_section_id True integer

A ID numérica de uma seção em uma loja etsy específica.

Retornos

Uma seção dentro de uma loja, na qual um usuário pode classificar listagens.

ShopSection
ShopSection

Obter seções de loja

Recupera a lista de seções de loja em uma loja específica identificada pela ID da loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Retornos

Todas as seções em uma Loja sprecific.

ShopSections
ShopSections

Obter todos os arquivos de listagem

Recupera todos os arquivos associados à listagem digital fornecida. Solicitar arquivos de uma listagem física retorna um resultado vazio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica da listagem associada a essa transação.

ID de listagem
listing_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Retornos

Representa vários ShopListingFiles.

ShopListingFiles
ShopListingFiles

Obter transportadoras de transporte

Recupera uma lista de transportadoras de transporte disponíveis e as classes de email associadas a elas para um determinado país.

Parâmetros

Nome Chave Obrigatório Tipo Description
ISO do país de origem
origin_country_iso True string

O código ISO do país do qual a listagem é fornecida.

Retornos

Representa vários ShippingCarriers.

ShippingCarriers
ShippingCarriers

Obter um arquivo de uma listagem

Recupera um único arquivo associado à listagem digital fornecida. Solicitar um arquivo de uma listagem física retorna um resultado vazio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Listando A ID do Arquivo
listing_file_id True integer

A ID numérica exclusiva de um arquivo associado a uma listagem digital.

Retornos

Um arquivo associado a uma listagem digital.

ShopListingFile
ShopListingFile

Obter um pagamento de um recibo específico

Recupera um pagamento de um recibo específico, identificado pela ID de recibo, de uma loja específica, identificada pela ID da loja.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do recibo
receipt_id True string

A ID numérica do recibo associado a essa transação.

Retornos

Representa vários pagamentos feitos com pagamentos etsy. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

Payments
Payments

Obter um pagamento de uma ID de entrada do razão da conta de pagamento

Obtenha um pagamento de uma ID de entrada do razão da conta de pagamento, se aplicável.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

IDs de entrada do razão
ledger_entry_ids True string

Matriz de inteiros.

Retornos

Representa vários pagamentos feitos com pagamentos etsy. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

Payments
Payments

Obter um perfil de envio

Recupera um perfil de envio referenciado pela ID do perfil de envio.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do perfil de envio
shipping_profile_id True integer

A ID numérica do perfil de envio associado à listagem.

Obter um recibo

Recupera um recibo, identificado por uma ID de recibo, de uma loja etsy.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do recibo
receipt_id True integer

A ID numérica do recibo associado a essa transação.

Retornos

O registro de uma compra de uma loja. Os recibos da loja exibem valores monetários usando a moeda da loja.

ShopReceipt
ShopReceipt

Obter uma imagem de listagem

Recupera as referências e metadados de uma imagem de listagem com uma ID de imagem específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Listando a ID da imagem
listing_image_id True integer

A ID numérica da imagem de listagem primária para essa transação.

Retornos

Urls de referência e metadados para uma imagem associada a uma listagem específica. O url_fullxfull parâmetro contém a URL do arquivo de imagem binária de tamanho completo.

ListingImage
ListingImage

Obter uma lista de pagamentos

Recupera uma lista de pagamentos de uma loja identificada pela ID da loja. Você também pode filtrar os resultados usando uma lista de IDs de pagamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de pagamento
payment-ids True string

Uma matriz separada por vírgulas de números de IDs de pagamento.

Retornos

Representa vários pagamentos feitos com pagamentos etsy. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

Payments
Payments

Obter uma listagem

Recupera um registro de listagem listando a ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Includes
includes string

Uma cadeia de caracteres enumerada que anexa uma associação válida. As entradas aceitáveis são 'shop', 'images' e 'user'.

Obter uma oferta de listagem

Obtenha uma oferta para uma listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

ID do Produto
product_id True integer

A ID numérica do produto associado a essa transação.

ID da oferta de produto
product_offering_id True integer

A ID numérica da oferta de produto associada a essa transação.

Retornos

Uma representação de uma oferta para uma listagem.

ListingInventoryProductOffering
ListingInventoryProductOffering

Obter uma transação

Recupera uma transação por ID da transação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID da transação
transaction_id True integer

A ID numérica exclusiva de uma transação.

Retornos

Um objeto de transação associado a um recibo de loja. O Etsy gera uma transação por listagem comprada conforme registrado no recibo do pedido.

ShopReceiptTransaction
ShopReceiptTransaction

Obter uma transação de recibo

Recupera a lista de transações associadas a um recibo específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do recibo
receipt_id True integer

A ID numérica do recibo associado a essa transação.

Retornos

Um conjunto de recursos de transação de recibo de loja

ShopReceiptTransactions
ShopReceiptTransactions

Obter usuário

Retorna o perfil de usuário para o usuário identificado por uma ID de usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Usuário
user_id True integer

A ID numérica não zero positiva exclusiva para um usuário.

Retornos

Representa um único usuário do site

Utilizador
User

Pesquisar lojas

Retorna uma lista de lojas com o nome correspondente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome da Loja
shop_name True string

A cadeia de caracteres de nome da loja.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de registros da Loja.

Lojas
Shops

Ping

Verifique se há conectividade com a API etsy com um aplicativo.

Retornos

Uma confirmação de que o aplicativo atual tem acesso à API Open

Pong
Pong

Recuperar transações de uma listagem

Recupera a lista de transações associadas a uma listagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da loja
shop_id True integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID de listagem
listing_id True integer

A ID numérica da listagem associada a essa transação.

Limit
limit integer

O número máximo de resultados a serem retornados.

Offset
offset integer

O número de registros a serem ignoradas antes de selecionar o primeiro resultado.

Retornos

Um conjunto de recursos de transação de recibo de loja

ShopReceiptTransactions
ShopReceiptTransactions

Definições

ShopListing

Uma listagem de uma loja, que contém uma quantidade de produto, título, descrição, preço etc.

Nome Caminho Tipo Description
ID de listagem
listing_id integer

A ID numérica da listagem associada a essa transação.

ID do Usuário
user_id integer

A ID numérica do usuário que está postando a listagem.

ID da loja
shop_id integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

Title
title string

A cadeia de caracteres de título da listagem. As cadeias de caracteres de título válidas contêm apenas letras, números, marcas de pontuação, símbolos matemáticos, caracteres ™ © de espaço em branco e ® . (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) Você só pode usar os caracteres %, :, &e + uma vez cada.

Description
description string

Uma cadeia de caracteres de descrição do produto à venda na listagem.

Estado
state State

Uma cadeia de caracteres enumerada de qualquer um dos: ativos ou inativos. Observação: definir uma listagem de rascunho como ativa também publicará a listagem no etsy.com.

Carimbo de data/hora de criação
creation_timestamp integer

O tempo de criação da listagem, em segundos de época.

Carimbo de data/hora final
ending_timestamp integer

O tempo de expiração da listagem, em segundos de época.

Carimbo de data/hora de criação original
original_creation_timestamp integer

O tempo de criação da listagem, em segundos de época.

Carimbo de data/hora da última modificação
last_modified_timestamp integer

A hora da última atualização para a listagem, em segundos de época.

Carimbo de data/hora da última alteração de estado
state_timestamp integer

A data e a hora da última alteração de estado desta listagem.

Quantidade
quantity integer

O número positivo não zero de produtos disponíveis para compra na listagem. Observação: a quantidade de listagem é a soma das quantidades de oferta disponíveis. Você pode solicitar as quantidades para ofertas individuais do recurso ListingInventory usando o ponto de extremidade de inventário get listing.

ID da Seção da Loja
shop_section_id integer

A ID numérica de uma seção em uma loja etsy específica.

Classificação em destaque
featured_rank integer

A posição numérica positiva diferente de zero nas listagens em destaque da loja, com listagens de classificação 1 aparecendo na posição mais à esquerda na listagem em destaque na home page de uma loja.

URL
url string

A URL completa na página da listagem no Etsy.

Número de favores
num_favorers integer

O número de usuários que marcaram essa listagem como favorito.

Não tributável
non_taxable boolean

Quando verdadeiro, as taxas de imposto de loja aplicáveis não se aplicam a esta listagem no check-out.

É personalizável
is_customizable boolean

Quando verdadeiro, um comprador pode entrar em contato com o vendedor para obter um pedido personalizado. O valor padrão é verdadeiro quando uma loja aceita pedidos personalizados. Não se aplica a lojas que não aceitam pedidos personalizados.

É peronalizável
is_personalizable boolean

Quando verdadeiro, essa listagem é personalizável. O valor padrão é nulo.

A personalização é necessária
personalization_is_required boolean

Quando verdadeiro, essa listagem requer personalização. O valor padrão é nulo.

Contagem máxima de caracteres de personalização
personalization_char_count_max integer

Esse é um valor inteiro que representa o comprimento máximo da mensagem de personalização inserida pelo comprador.

Instruções de personalização
personalization_instructions string

Quando verdadeiro, essa listagem requer personalização. O valor padrão é nulo.

Tipo de listagem
listing_type boolean

Uma cadeia de caracteres de tipo enumerada que indica se a listagem é física ou um download digital.

Etiquetas
tags array of string

Uma lista de cadeias de caracteres de marca para a listagem. As cadeias de caracteres de marca válidas contêm apenas letras, números, caracteres de espaço em branco, -, ', ™ , © e ® . (regex: /[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u) O valor padrão é nulo.

Materials
materials array of string

Uma lista de cadeias de caracteres de material para materiais usados no produto. As cadeias de caracteres de materiais válidos contêm apenas letras, números e caracteres de espaço em branco. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) O valor padrão é nulo.

ID do perfil de envio
shipping_profile_id integer

A ID numérica do perfil de envio associado à listagem.

Dias mínimos de processamento
processing_min integer

O número mínimo de dias necessários para processar essa listagem. O valor padrão é nulo.

Dias máximos de processamento
processing_max integer

O número máximo de dias necessários para processar essa listagem. O valor padrão é nulo.

WhoMade
who_made WhoMade

Uma cadeia de caracteres enumerada inidcatou quem fez o produto. Ajuda os compradores a localizar a listagem sob o título Artesanal. Requer 'is_supply' e 'when_made'.

WhenMade
when_made WhenMade

Uma cadeia de caracteres enumerada para a era em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar a listagem sob o título Vintage. Requer 'is_supply' e 'who_made'.

Fornecer Produto
is_supply boolean

Quando verdadeiro, marca a listagem como um produto de fornecimento, caso contrário, indica que ele é um produto concluído. Ajuda os compradores a localizar a listagem no título Suprimentos. Requer 'who_made' e 'when_made'.

Peso do item
item_weight double

O peso numérico do produto medido em unidades definidas na unidade de peso do item. O valor padrão é nulo. Se definido, o valor deve ser maior que 0.

ItemWeightUnit
item_weight_unit ItemWeightUnit

Uma cadeia de caracteres que define as unidades usadas para medir o peso do produto. O valor padrão é nulo.

Comprimento do item
item_length double

O comprimento numérico do produto medido em unidades definidas na unidade de dimensões do item. O valor padrão é nulo. Se definido, o valor deve ser maior que 0.

Largura do Item
item_width double

A largura numérica do produto medido em unidades definidas na unidade de dimensões do item. O valor padrão é nulo. Se definido, o valor deve ser maior que 0.

Altura do Item
item_height double

O comprimento numérico do produto medido em unidades definidas na unidade de dimensões do item. O valor padrão é nulo. Se definido, o valor deve ser maior que 0.

ItemDimensionsUnit
item_dimensions_unit ItemDimensionsUnit

Uma cadeia de caracteres que define as unidades usadas para medir as dimensões do produto. O valor padrão é nulo.

É privado
is_private boolean

Quando true, esta é uma listagem privada pretendê-lo para um comprador específico e oculto do modo de exibição de loja.

Recipient
recipient Recipient

Uma cadeia de caracteres enumerada que indica uma pessoa para a qual este produto faria um presente apropriado. O valor padrão é nulo.

Ocasião
occasion Occasion

Uma cadeia de caracteres enumerada que indica uma ocasião para a qual este produto faria um presente apropriado. O valor padrão é nulo.

Estilo
style array of string

Uma matriz de cadeias de caracteres de estilo para esta listagem, cada uma delas é uma cadeia de caracteres de texto de forma livre, como Formal ou Steampunk. Uma listagem pode ter até dois estilos. As cadeias de caracteres de estilo válidas contêm apenas letras, números e caracteres de espaço em branco. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) O valor padrão é nulo.

Dados do arquivo
file_data string

Uma cadeia de caracteres que descreve os arquivos anexados a uma listagem digital.

Tem variações
has_variations boolean

Quando true, a listagem tem variações.

Deve renovar automaticamente
should_auto_renew boolean

Quando verdadeiro, renova uma listagem por quatro meses após a expriação. Se definido como true quando anteriormente falso, etsy.com renovará a listagem antes de expirar, mas o período de renovação começará imensualmente em vez de estender a data de validade da listagem. Qualquer tempo não utilizado restante na listagem é perdido. As renovações resultam em encargos na fatura de um usuário.

Linguagem
language string

A marca de idioma IETF para o idioma padrão da listagem. Ex: de, en, es, , fr, , it, ja, nl, , pl, pt, . ru

Money
price Money

Uma representação de uma quantidade de dinheiro.

ID da taxonomia
taxonomy_id integer

A ID de taxonomia numérica da listagem. O vendedor gerencia a listagem de IDs de taxonomia para sua loja. Consulte a taxonomia do vendedor para obter mais informações.

Money

Uma representação de uma quantidade de dinheiro.

Nome Caminho Tipo Description
Quantidade
amount integer

A quantidade representada por esses dados.

Divisor
divisor integer

O divisor para renderizar o valor.

Código de moeda
currency_code string

O código de moeda ISO para esses dados.

ShopListingFile

Um arquivo associado a uma listagem digital.

Nome Caminho Tipo Description
Listando A ID do Arquivo
listing_file_id integer

A ID numérica exclusiva de um arquivo associado a uma listagem digital.

ID de listagem
listing_id integer

A ID numérica da listagem associada a essa transação.

Classificação
rank integer

O índice numérico da posição da ordem de exibição desse arquivo na listagem, começando em 1.

Nome do Arquivo
filename string

A cadeia de caracteres de nome de arquivo para um arquivo associado a uma listagem digital.

Filesize
filesize string

Uma cadeia de caracteres de tamanho de formato legível para o tamanho de um arquivo.

Tamanho em Bytes
size_bytes integer

Um número que indica o tamanho de um arquivo, medido em bytes.

Tipo de arquivo
filetype string

Uma cadeia de caracteres de tipo que indica o tipo MIME de um arquivo.

Criar carimbo de data/hora
create_timestamp integer

O carimbo de data/hora numérico exclusivo de um arquivo associado a uma listagem digital.

ShopListingFiles

Representa vários ShopListingFiles.

Nome Caminho Tipo Description
Contagem
count integer

O número de ShopListingFiles sendo retornados..

Results
results array of ShopListingFile

Uma matriz de recursos ShopListingFile.

ShopListings

Um conjunto de recursos de listagem de lojas.

Nome Caminho Tipo Description
Contagem
count integer

O número de recursos de listagem de lojas encontrados.

Results
results array of ShopListing

Os recursos de listagem da loja encontrados.

Utilizador

Representa um único usuário do site

Nome Caminho Tipo Description
ID do Usuário
user_id integer

A ID numérica de um usuário. Esse número também é uma ID de loja válida para a loja do usuário.

Nome do logon
login_name string

A cadeia de caracteres de nome de logon do usuário.

Email Primário
primary_email string

Uma cadeia de caracteres de endereço de email para o endereço de email principal do usuário.

Primeiro Nome
first_name string

O nome do usuário.

Apelido
last_name string

O sobrenome do usuário.

Carimbo de data/hora criado
create_timestamp integer

A data e a hora em que o usuário criou sua conta, em segundos de época.

Referenciado pela ID do Usuário
referred_by_user_id integer

A ID numérica do usuário que encaminhou esse usuário.

Usar novos pontos de extremidade de inventário
use_new_inventory_endpoints boolean

Preterido. Sempre é verdade.

É Vendedor
is_seller boolean

True se o usuário for vendedor.

Biografia
bio string

A biografia do usuário.

Gênero
gender string

O gênero do usuário.

Mês de nascimento
birth_month string

O mês de nascimento do usuário.

Aniversário
birth_day string

O dia do nascimento do usuário.

Contagem de transações de compra
transaction_buy_count integer

O número de transações em que o usuário comprou.

Contagem de transações vendidas
transaction_sold_count integer

O número de transações em que o usuário vendeu.

Shop

Uma loja criada por um usuário do Etsy.

Nome Caminho Tipo Description
ID da loja
shop_id integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do Usuário
user_id integer

A ID do usuário numérico do usuário proprietário desta loja.

Nome da Loja
shop_name string

A cadeia de caracteres de nome da loja.

Data de criação
create_date integer

A data e a hora em que essa loja foi criada, em segundos de época.

Title
title string

Uma breve cadeia de caracteres de título para a página principal da loja.

Comunicado
announcement string

Uma cadeia de caracteres de anúncio para compradores que é exibida na home page da loja.

Código de moeda
currency_code string

O código ISO (alfabético) da moeda da loja. A loja exibe todos os preços dessa moeda por padrão.

Está de férias
is_vacation boolean

Quando for verdade, esta loja não está aceitando compras.

Mensagem de Férias
vacation_message string

A cadeia de caracteres de mensagem da loja exibida quando is_vacation é verdadeira.

Mensagem de venda
sale_message string

Uma cadeia de caracteres de mensagem enviada aos usuários que concluirem uma compra desta loja.

Mensagem de venda digital
digital_sale_message string

Uma cadeia de caracteres de mensagem enviada aos usuários que compram um item digital desta loja.

Data da atualização
update_date integer

A data e a hora da última atualização para a loja, em segundos de época.

Contagem de Listagem Ativa
listing_active_count integer

O número de listagens ativas na loja.

Contagem de Listagem Digital
digital_listing_count integer

O número de listagens digitais na loja.

Nome do logon
login_name string

A cadeia de caracteres de nome de logon do proprietário da loja.

Aceita solicitações personalizadas
accepts_custom_requests boolean

Quando verdadeiro, a loja aceita solicitações de personalização.

Política de boas-vindas
policy_welcome string

A cadeia de caracteres de boas-vindas da política da loja (pode estar em branco).

Política de Pagamento
policy_payment string

A cadeia de caracteres da política de pagamento da loja (pode estar em branco).

Política de Envio
policy_shipping string

A cadeia de caracteres da política de envio da loja (pode estar em branco).

Política de reembolso
policy_refunds string

A cadeia de caracteres da política de reembolso da loja (pode estar em branco).

Políticas adicionais
policy_additional string

A cadeia de caracteres de políticas adicionais da loja (pode estar em branco).

Informações do Vendedor
policy_seller_info string

A cadeia de informações do vendedor da loja (pode estar em branco).

Data atualizada da política
policy_update_date integer

A data e a hora da última atualização para as políticas da loja, em segundos de época.

Tem política de recebimento privado
policy_has_private_receipt_info boolean

Quando verdadeiro, os recibos da UE exibem informações privadas.

Tem políticas não estruturadas
has_unstructured_policies boolean

Quando true, a loja exibe campos de política não estruturados adicionais.

Política de Privacidade
policy_privacy string

A cadeia de caracteres de política de privacidade da loja (pode estar em branco).

Férias autor profundamente
vacation_autoreply string

A cadeia de caracteres de resposta automática da loja exibida em novas conversas quando is_vacation é verdadeira.

URL
url string

A cadeia de caracteres de URL desta loja.

URL da Imagem de Faixa
image_url_760x100 string

A cadeia de caracteres de URL para a imagem de faixa desta loja.

Número de favores
num_favorers integer

O número de usuários que marcaram essa loja como favorito.

Languages
languages array of string

Uma lista de cadeias de caracteres de idioma para os idiomas registrados da loja.

URL da imagem do ícone
icon_url_fullxfull string

A cadeia de caracteres de URL para a imagem de ícone desta loja.

Está usando políticas estruturadas
is_using_structured_policies boolean

Quando verdadeiro, a loja aceitava usando políticas estruturadas.

Tem políticas estruturadas integradas
has_onboarded_structured_policies boolean

Quando true, a loja aceitou OU recusou depois de exibir políticas estruturadas integrando.

Incluir link de formulário de disputa
include_dispute_form_link boolean

Quando verdadeiro, as políticas desta loja incluem um link para um formulário de disputa online da UE.

Está o check-out direto integrado
is_direct_checkout_onboarded boolean

Quando for verdade, a loja se integrou ao Etsy Payments.

O envio calculado é qualificado
is_calculated_eligible boolean

Quando verdadeiro, a loja é elegível para perfis de envio calculados. (Disponível somente nos EUA e canadá)

É opted in to Buyer Promise
is_opted_in_to_buyer_promise boolean

Quando verdade, a loja optou pela promessa do comprador.

É baseado nos EUA
is_shop_us_based boolean

Quando for verdade, a loja está sediada nos EUA.

Contagem de transações de vendas
transaction_sold_count integer

O número total de transações de vendas para esta loja

Envio de ISO do país
shipping_from_country_iso string

O país é que a loja está enviando.

ISO do Local de Loja
shop_location_country_iso string

O país é onde a loja está localizada.

Contagem de Revisão
review_count integer

Número de revisões de listagens de lojas no ano passado.

Média de Revisão
review_average double

Classificação média com base em revisões de listagens de lojas no ano passado.

ListingImage

Urls de referência e metadados para uma imagem associada a uma listagem específica. O url_fullxfull parâmetro contém a URL do arquivo de imagem binária de tamanho completo.

Nome Caminho Tipo Description
ID de listagem
listing_id integer

A ID numérica da listagem associada a essa transação.

Listando a ID da imagem
listing_image_id integer

A ID numérica da imagem de listagem primária para essa transação.

Código hexadecimal
hex_code string

A cadeia de caracteres webhex para a cor média da imagem, na notação webhex.

Valor Vermelho
red integer

O valor vermelho numérico igual ao valor vermelho médio da imagem, de 0 a 255 (cor RGB).

Valor Verde
green integer

O valor vermelho numérico igual ao valor vermelho médio da imagem, de 0 a 255 (cor RGB).

Valor Azul
blue integer

O valor vermelho numérico igual ao valor vermelho médio da imagem, de 0 a 255 (cor RGB).

Valor de matiz
hue integer

A tonalidade numérica igual à matiz média da imagem, de 0 a 360 (cor HSV).

Valor de saturação
saturation integer

A saturação numérica igual à saturação média da imagem, de 0 a 100 (cor HSV).

Valor de brilho
brightness integer

O brilho numérico é igual ao brilho médio da imagem, de 0 a 100 (cor HSV).

É preto e branco
is_black_and_white boolean

Quando true, a imagem está em preto e branco.

Hora de Criação
creation_tsz integer

O tempo de criação da imagem de listagem, em segundos de época.

Classificação
rank integer

A posição numérica positiva diferente de zero nas imagens exibidas em uma listagem, com imagens de classificação 1 aparecendo na posição mais à esquerda em uma listagem.

URL da imagem 75x75
url_75x75 string

A cadeia de caracteres de URL para uma miniatura de 75 x 75 pixels da imagem.

URL da imagem 170x135
url_170x135 string

A cadeia de caracteres de url para uma miniatura de 170 x 135 pixels da imagem.

URL da imagem 570xN
url_570xN string

A cadeia de caracteres de url para uma miniatura da imagem, não mais do que 570 pixels de largura com altura variável.

URL de imagem em tamanho real
url_fullxfull string

A cadeia de caracteres de URL para a imagem em tamanho real, até 3.000 pixels em cada dimensão.

Altura da imagem em tamanho real
full_height integer

A altura numérica, medida em pixels, da imagem de tamanho completo referenciada em url_fullxfull.

Largura da imagem em tamanho real
full_width integer

A largura numérica, medida em pixels, da imagem de tamanho completo referenciada em url_fullxfull.

ListingImages

Representa uma lista de recursos de imagem de listagem, cada um dos quais contém as URLs de referência e os metadados de uma imagem.

Nome Caminho Tipo Description
Contagem
count integer

O número de resultados.

Results
results array of ListingImage

A lista de recursos solicitados.

ListingInventoryWithAssociations

Uma representação do registro de inventário de uma única listagem com associações

Nome Caminho Tipo Description
Products
products array of ListingInventoryProduct

Uma matriz JSON de produtos disponíveis em uma listagem, mesmo que apenas um produto. Todos os nomes de campo nos blobs JSON são minúsculos.

Preço sobre propriedades
price_on_property array of integer

Uma matriz de inteiros exclusivos de ID de propriedade de listagem para as propriedades que alteram os preços do produto, se houver. Por exemplo, se você cobrar preços específicos por diferentes produtos de tamanho na mesma listagem, essa matriz conterá a ID da propriedade para tamanho.

Quantidade em propriedades
quantity_on_property array of integer

Uma matriz de inteiros exclusivos de ID da propriedade de listagem para as propriedades que alteram a quantidade dos produtos, se houver. Por exemplo, se você estocar quantidades específicas de produtos coloridos diferentes na mesma listagem, essa matriz conterá a ID da propriedade para cor.

SKU em propriedades
sku_on_property array of integer

Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram o SKU do produto, se houver. Por exemplo, se você usar skus específicos para diferentes produtos coloridos na mesma listagem, essa matriz conterá a ID da propriedade para cor.

ShopListing
listing ShopListing

Uma listagem de uma loja, que contém uma quantidade de produto, título, descrição, preço etc.

ListingInventoryProduct

Uma representação de um produto para uma listagem.

Nome Caminho Tipo Description
ID do Produto
product_id integer

A ID numérica de um produto específico comprado de uma listagem.

SKU
sku string

A cadeia de caracteres de SKU para o produto

Está Excluído
is_deleted boolean

Quando verdadeiro, alguém excluiu este produto.

Offerings
offerings array of ListingInventoryProductOffering

Uma lista de entradas de oferta de produto para este produto.

Valores da propriedade
property_values array of ListingPropertyValue

Uma lista de entradas de valor de propriedade para este produto.

ListingInventoryProductOffering

Uma representação de uma oferta para uma listagem.

Nome Caminho Tipo Description
ID da oferta
offering_id integer

A ID da oferta de produto

Quantidade
quantity integer

A quantidade da oferta do produto

Está habilitado
is_enabled boolean

Se a oferta pode ou não ser mostrada aos compradores.

Está Excluído
is_deleted boolean

Se a oferta foi excluída ou não.

Money
price Money

Uma representação de uma quantidade de dinheiro.

ListingPropertyValue

Uma representação de valores de dados estruturados.

Nome Caminho Tipo Description
ID da Propriedade
property_id integer

A ID numérica da propriedade.

Nome
property_name string

O nome da Propriedade.

ID de escala
scale_id integer

A ID numérica da escala (se houver).

Nome da Escala
scale_name string

O rótulo usado para descrever a escala escolhida (se houver).

IDs de valor
value_ids array of integer

As IDs numéricas dos valores da propriedade

Valores
values array of string

Os valores da propriedade

ListingInventory

Uma representação do registro de inventário de uma única listagem.

Nome Caminho Tipo Description
Products
products array of ListingInventoryProduct

Uma matriz JSON de produtos disponíveis em uma listagem, mesmo que apenas um produto. Todos os nomes de campo nos blobs JSON são minúsculos.

Preço sobre propriedades
price_on_property array of integer

Uma matriz de inteiros exclusivos de ID de propriedade de listagem para as propriedades que alteram os preços do produto, se houver. Por exemplo, se você cobrar preços específicos por diferentes produtos de tamanho na mesma listagem, essa matriz conterá a ID da propriedade para tamanho.

Quantidade em propriedades
quantity_on_property array of integer

Uma matriz de inteiros exclusivos de ID da propriedade de listagem para as propriedades que alteram a quantidade dos produtos, se houver. Por exemplo, se você estocar quantidades específicas de produtos coloridos diferentes na mesma listagem, essa matriz conterá a ID da propriedade para cor.

SKU em propriedades
sku_on_property array of integer

Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram o SKU do produto, se houver. Por exemplo, se você usar skus específicos para diferentes produtos coloridos na mesma listagem, essa matriz conterá a ID da propriedade para cor.

ShopListingsWithAssociations

Um conjunto de recursos de listagem de lojas com associações.

Nome Caminho Tipo Description
Contagem
count integer

O número de recursos de listagem de lojas encontrados.

Results
results array of ShopListing

Os recursos de listagem da loja encontrados.

ListingPropertyValues

Representa vários valores de propriedade de listagem.

Nome Caminho Tipo Description
Contagem
count integer

O número de recursos de listagem de lojas encontrados.

Results
results array of ListingPropertyValue

Os recursos de listagem da loja encontrados.

ShopReceiptTransactions

Um conjunto de recursos de transação de recibo de loja

Nome Caminho Tipo Description
Contagem
count integer

O número de recursos de transação de recibo de loja encontrado.

Results
results array of ShopReceiptTransaction

Os recursos de transação de recibo da loja encontrados.

ShopReceiptTransaction

Um objeto de transação associado a um recibo de loja. O Etsy gera uma transação por listagem comprada conforme registrado no recibo do pedido.

Nome Caminho Tipo Description
ID da transação
transaction_id integer

A ID numérica exclusiva de uma transação.

Title
title string

A cadeia de caracteres de título da listagem comprada nesta transação.

Description
description string

A cadeia de caracteres de descrição da listagem comprada nesta transação.

ID do Usuário do Vendedor
seller_user_id integer

A ID do usuário numérico para o vendedor nesta transação.

ID do usuário comprador
buyer_user_id integer

A ID do usuário numérico para o comprador nesta transação.

Carimbo de data/hora criado
create_timestamp integer

Data e hora de criação da transação, em segundos de época.

Carimbo de data/hora pago
paid_timestamp integer

A data e a hora pagas da transação, em segundos de época.

Carimbo de data/hora enviado
shipped_timestamp integer

A data e a hora de envio da transação, em segundos de época.

Quantidade
quantity integer

A quantidade numérica de produtos comprados nessa transação.

Listando a ID da imagem
listing_image_id integer

A ID numérica da imagem de listagem primária para essa transação.

ID do recibo
receipt_id integer

A ID numérica do recibo associado a essa transação.

É Digital
is_digital boolean

Quando verdadeira, a transação registrou a compra de uma listagem digital.

Dados do arquivo
file_data string

Uma cadeia de caracteres que descreve os arquivos comprados nessa transação.

ID de listagem
listing_id integer

A ID numérica da listagem associada a essa transação.

Tipo de Transação
transaction_type string

A cadeia de caracteres de tipo para a transação, geralmente listando

ID do Produto
product_id integer

A ID numérica de um produto específico comprado de uma listagem.

Money
price Money

Uma representação de uma quantidade de dinheiro.

Money
shipping_cost Money

Uma representação de uma quantidade de dinheiro.

ListingTranslation

Representa os dados de tradução de uma listagem.

Nome Caminho Tipo Description
ID de listagem
listing_id integer

A ID numérica da Listagem.

Linguagem
language string

A marca de idioma IETF (por exemplo, 'fr') para o idioma dessa tradução.

Title
title string

O título da Listagem desta Tradução.

Description
description string

A descrição da Listagem desta Tradução.

Etiquetas
tags array of string

As marcas da Listagem desta Tradução.

ListingVariationImages

Representa várias imagens de variação de listagem.

Nome Caminho Tipo Description
Contagem
count integer

A contagem de imagens de variação.

Results
results array of ListingVariationImage

Os resultados das imagens de variação.

ListingVariationImage

Uma representação das associações de variações e imagens em uma listagem.

Nome Caminho Tipo Description
ID da Propriedade
property_id integer

A ID numérica da propriedade.

ID do valor
value_id integer

A ID numérica do valor.

ID da imagem
image_id integer

A ID numérica da imagem.

PaymentAccountLedgerEntries

Um conjunto de recursos de entrada do razão da conta de pagamento

Nome Caminho Tipo Description
Contagem
count integer

O número de recursos de entrada do razão da conta de pagamento encontrado.

Results
results array of PaymentAccountLedgerEntry

Os recursos de entrada do razão da conta de pagamento encontrados.

PaymentAccountLedgerEntry

Representa uma entrada no razão de uma loja.

Nome Caminho Tipo Description
ID de entrada
entry_id integer

A ID numérica da entrada do razão.

ID do razão
ledger_id integer

A ID numérica do razão.

Número da sequência
sequence_number integer

A sequência permite que as entradas do razão sejam classificadas cronologicamente. Quanto maior a sequência, mais recente será a entrada.

Quantidade
amount integer

A quantidade de dinheiro creditada ao razão.

Moeda
currency string

A moeda da entrada no razão.

Description
description string

Detalhes de que tipo de entrada do razão se trata: pagamento, reembolso, reversão de um reembolso com falha, desembolso, desembolso retornado, recuperação, crédito diverso, débito diverso ou pagamento de fatura.

Saldo
balance integer

A quantidade de dinheiro no razão da loja no momento seguinte a esta entrada foi aplicada.

Data de criação
create_date integer

A data e a hora em que a entrada do razão foi criada em segundos de época..

Payments

Representa vários pagamentos feitos com pagamentos etsy. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

Nome Caminho Tipo Description
Contagem
count integer

O número de pagamentos na resposta.

Results
results array of Payment

Uma lista de pagamentos.

Pagamento

Representa um pagamento feito com pagamentos etsy. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

Nome Caminho Tipo Description
ID de pagamento
payment_id integer

Uma ID numérica exclusiva para um pagamento a uma loja etsy específica.

ID do usuário comprador
buyer_user_id integer

A ID numérica do usuário que pagou a compra.

ID da loja
shop_id integer

A ID numérica não zero positiva exclusiva para uma Etsy Shop.

ID do recibo
receipt_id integer

A ID numérica do recibo associado a essa transação.

Money
amount_gross Money

Uma representação de uma quantidade de dinheiro.

Money
amount_fees Money

Uma representação de uma quantidade de dinheiro.

Money
amount_net Money

Uma representação de uma quantidade de dinheiro.

Money
posted_gross Money

Uma representação de uma quantidade de dinheiro.

Money
posted_fees Money

Uma representação de uma quantidade de dinheiro.

Money
posted_net Money

Uma representação de uma quantidade de dinheiro.

Money
adjusted_gross Money

Uma representação de uma quantidade de dinheiro.

Money
adjusted_fees Money

Uma representação de uma quantidade de dinheiro.

Money
adjusted_net Money

Uma representação de uma quantidade de dinheiro.

Moeda
currency string

A cadeia de caracteres de código ISO (alfabética) para a moeda do pagamento.

Moeda da Loja
shop_currency string

O código ISO (alfabético) da moeda da loja. A loja exibe todos os preços dessa moeda por padrão.

Moeda do Comprador
buyer_currency string

A cadeia de caracteres de moeda do comprador.

ID de envio de usuário
shipping_user_id integer

A ID numérica do usuário para o qual o vendedor envia o pedido.

ID do endereço de envio
shipping_address_id integer

A ID numérica que identifica o endereço de envio.

ID do endereço de cobrança
billing_address_id integer

A ID numérica que identifica o endereço de cobrança do comprador.

Situação
status string

Uma cadeia de caracteres que indica o status atual do pagamento, mais comumente liquidado ou autenticado.

Carimbo de data/hora enviado
shipped_timestamp integer

A data e a hora de envio da transação, em segundos de época.

Carimbo de data/hora criado
create_timestamp integer

Data e hora de criação da transação, em segundos de época.

Atualizar carimbo de data/hora
update_timestamp integer

A data e a hora da última alteração no ajuste de pagamento em segundos de época.

Ajustes de pagamento
payment_adjustments array of PaymentAdjustment

Lista de objetos de reembolso em uma transação etsy Payments. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

PaymentAdjustment

Representa um reembolso, que se aplica a um pagamento etsy anterior. Todos os valores monetários estão em centavos de USD, a menos que especificado de outra forma.

Nome Caminho Tipo Description
ID de Ajuste de Pagamento
payment_adjustment_id integer

A ID numérica de um ajuste de pagamento.

ID de pagamento
payment_id integer

Uma ID numérica exclusiva para um pagamento a uma loja etsy específica.

Situação
status string

A cadeia de caracteres de status do ajuste de pagamento.

É êxito
is_success boolean

Quando verdadeiro, o ajuste de pagamento foi ou provavelmente será concluído com êxito.

ID do Usuário
user_id integer

A ID numérica do usuário (vendedor) que está cumprindo a compra.

Código de Motivo
reason_code string

Uma cadeia de caracteres legível pelo ser humano que descreve o motivo do reembolso.

Valor total do ajuste
total_adjustment_amount integer

O valor numérico total do reembolso na moeda de pagamento.

Valor total do ajuste da loja
shop_total_adjustment_amount integer

O valor numérico do reembolso na moeda da loja.

Valor total do ajuste
buyer_total_adjustment_amount integer

O valor numérico do reembolso na moeda do comprador.

Valor total do ajuste de taxa
total_fee_adjustment_amount integer

A quantidade numérica de taxas de processamento de cartão associadas a um ajuste de pagamento.

Carimbo de data/hora criado
create_timestamp integer

Data e hora de criação da transação, em segundos de época.

Atualizar carimbo de data/hora
update_timestamp integer

A data e a hora da última alteração no ajuste de pagamento em segundos de época.

Pong

Uma confirmação de que o aplicativo atual tem acesso à API Open

Nome Caminho Tipo Description
ID do aplicativo
application_id integer

A ID do aplicativo autenticado

ShopReceipt

O registro de uma compra de uma loja. Os recibos da loja exibem valores monetários usando a moeda da loja.

Nome Caminho Tipo Description
ID do recibo
receipt_id integer

A ID numérica do recibo associado a essa transação.

Tipo de recibo
receipt_type integer

O valor numérico para o canal Etsy que a serviçou da compra: 0 para Etsy.com, 1 para uma loja Pattern.

ID do Usuário do Vendedor
seller_user_id integer

A ID numérica do usuário (vendedor) que está cumprindo a compra.

Endereço de email do vendedor
seller_email string

A cadeia de caracteres de endereço de email do vendedor da listagem.

ID do usuário comprador
buyer_user_id integer

A ID numérica do usuário que está fazendo a compra.

Endereço de email do comprador
buyer_email string

A cadeia de caracteres de endereço de email para o comprador da listagem.

Nome
name string

A cadeia de caracteres de nome do destinatário no endereço de envio.

Primeira linha de endereço
first_line string

A primeira cadeia de caracteres de linha de endereço para o destinatário no endereço de envio.

Segunda Linha de Endereço
second_line string

A cadeia de caracteres de segunda linha de endereço opcional para o destinatário no endereço de envio.

City
city string

A cadeia de caracteres da cidade para o destinatário no endereço de envio.

Estado
state string

A cadeia de caracteres de estado do destinatário no endereço de envio.

Código Postal
zip string

A cadeia de caracteres de cep (não necessariamente um número) para o destinatário no endereço de envio.

Endereço formatado
formatted_address string

A cadeia de caracteres de endereço de envio formatada para o destinatário no endereço de envio.

ISO do código do país
country_iso string

A cadeia de caracteres de código de país iso-3166 alfa-2 para o destinatário no endereço de envio.

Método de Pagamento
payment_method string

A cadeia de caracteres do método de pagamento que identifica a forma de pagamento do comprador, que deve ser um dos: 'cc' (cartão de crédito), 'PayPal', 'check', 'mo' (pedido de dinheiro), 'bt' (transferência bancária), 'other', 'ideal', 'sofort', 'apple_pay', 'google', 'android_pay', 'google_pay', 'klarna', 'k_pay_in_4' (klarna) ou 'k_financing' (klarna).

Endereço de email de pagamento
payment_email string

A cadeia de caracteres de endereço de email para o endereço de email para o qual enviar a confirmação de pagamento

Mensagem do Vendedor
message_from_seller string

Uma cadeia de caracteres de mensagem opcional do vendedor.

Mensagem do Comprador
message_from_buyer string

Uma cadeia de caracteres de mensagem opcional do comprador.

Mensagem do Sistema de Pagamento
message_from_payment string

A cadeia de caracteres de confirmação gerada pelo computador do sistema de pagamento.

É Pago
is_paid boolean

Quando for verdade, o comprador pagou por essa compra.

É enviado
is_shipped boolean

Quando verdadeiro, o vendedor enviou os produtos.

Carimbo de data/hora criado
create_timestamp integer

O tempo de criação do recibo, em segundos de época.

Atualizar carimbo de data/hora
update_timestamp integer

A hora da última atualização para o recibo, em segundos de época.

Mensagem de presente
gift_message string

Uma cadeia de caracteres de mensagem de presente que o comprador solicita entregue com o produto.

Money
grandtotal Money

Uma representação de uma quantidade de dinheiro.

Money
subtotal Money

Uma representação de uma quantidade de dinheiro.

Money
total_price Money

Uma representação de uma quantidade de dinheiro.

Money
total_shipping_cost Money

Uma representação de uma quantidade de dinheiro.

Money
total_tax_cost Money

Uma representação de uma quantidade de dinheiro.

Money
total_vat_cost Money

Uma representação de uma quantidade de dinheiro.

Money
discount_amt Money

Uma representação de uma quantidade de dinheiro.

Money
gift_wrap_price Money

Uma representação de uma quantidade de dinheiro.

Transferências
shipments array of ShopReceiptShipment

Uma lista de instruções de remessa para este recibo.

ShopReceiptShipment

O registro de um evento de remessa para um ShopReceipt. Um recibo pode ter muitos registros ShopReceiptShipment.

Nome Caminho Tipo Description
ID de envio de recibos
receipt_shipping_id integer

A ID numérica exclusiva de um registro de remessa de recibo de loja.

Carimbo de data/hora de notificação de remessa
shipment_notification_timestamp integer

O momento em que Etsy notificou o comprador do evento de remessa, em segundos de época.

Nome da transportadora
carrier_name string

A cadeia de caracteres de nome para a transportadora/empresa responsável pela entrega da remessa.

Código de acompanhamento
tracking_code string

A cadeia de caracteres de código de acompanhamento fornecida pela transportadora/empresa para a remessa.

ShopReceipts

Os recibos de uma Loja específica.

Nome Caminho Tipo Description
Contagem
count integer

O número de Recibos de Loja encontrados.

Results
results array of ShopReceipt

Lista de recursos do Recibo de Loja encontrado, com todos os campos do Recibo de Loja para cada recurso.

TransactionReviews

Um conjunto de registros de revisão de transações deixados pelos usuários.

Nome Caminho Tipo Description
Contagem
count integer

O número de recursos TransactionReview encontrados.

Results
results array of TransactionReview

Os recursos TransactionReview encontrados.

TransactionReview

Um registro de revisão de transação deixado por um usuário.

Nome Caminho Tipo Description
ID da loja
shop_id integer

A ID numérica da loja.

ID de listagem
listing_id integer

A ID da listagem da loja à qual o TransactionReview pertence.

ID do usuário comprador
buyer_user_id integer

A ID numérica do usuário que foi o comprador nessa transação. Observação: esse campo pode estar ausente, dependendo das configurações de privacidade do comprador.

Rating
rating integer

Valor de classificação em escala de 1 a 5

Revisar Mensagem
review string

Uma mensagem deixada pelo autor, explicando os comentários.

Linguagem
language string

O idioma do TransactionReview

URL de imagem de tamanho completo
image_url_fullxfull string

A URL de uma foto fornecida com os comentários, dimensões fullxfull. Observação: esse campo pode estar ausente, dependendo das configurações de privacidade do comprador.

Carimbo de data/hora criado
create_timestamp integer

A data e a hora em que o TransactionReview foi criado em segundos de época.

Atualizar carimbo de data/hora
update_timestamp integer

A data e a hora em que o TransactionReview foi atualizado em segundos de época.

SellerTaxonomyNodes

Uma lista de nós de taxonomia da árvore de taxonomia do vendedor.

Nome Caminho Tipo Description
Contagem
count integer

O número de resultados.

Results
results array of SellerTaxonomyNode

A lista de recursos solicitados.

SellerTaxonomyNode

Um nó de taxonomia na árvore de taxonomia do vendedor.

Nome Caminho Tipo Description
ID
id integer

A ID numérica exclusiva de um nó de taxonomia etsy, que é uma categoria de metadados para listagens organizadas na árvore de hierarquia de taxonomia do vendedor. Por exemplo, o nó de taxonomia de calçados (ID: 1429, nível: 1) é maior na hierarquia do que os sapatos femininos (ID: 1440, nível: 2). Os nós de taxonomia atribuídos a uma listagem dão suporte ao acesso a escalas e propriedades específicas de produtos padronizados. Por exemplo, as listagens atribuídas aos sapatos de nós de taxonomia ou sapatos de meninas dão suporte ao acesso à escala de tamanho do sapato da UE com seus nomes de propriedade associados e IDs para tamanhos de calçados da UE, como a propriedade value_id:1394 e name:38.

Level
level integer

A profundidade inteiro desse nó de taxonomia na árvore de taxonomia do vendedor, com raízes no nível 0.

Nome
name string

A cadeia de caracteres de nome para este nó de taxonomia.

ID Principal
parent_id integer

A ID de taxonomia numérica do pai deste nó.

Crianças
children array of SellerTaxonomyNode

Uma matriz de nós de taxonomia para todos os filhos diretos desse nó de taxonomia na árvore de taxanomia do vendedor.

IDs do caminho da taxonomia
full_path_taxonomy_ids array of integer

Uma matriz de IDs de taxonomia, incluindo este nó e todos os seus pais diretos na árvore de taxonomia do vendedor até um nó raiz. Eles são listados em ordem de raiz para folha.

TaxonomyNodeProperties

Uma lista de definições de propriedade do produto.

Nome Caminho Tipo Description
Contagem
count integer

O número de resultados.

Results
results array of TaxonomyNodeProperty

A lista de recursos solicitados.

TaxonomyNodeProperty

Uma definição de propriedade do produto.

Nome Caminho Tipo Description
ID da Propriedade
property_id integer

A ID numérica exclusiva dessa propriedade do produto.

Nome
name string

A cadeia de caracteres de nome para este nó de taxonomia.

Nome de Exibição
display_name string

A cadeia de caracteres de nome da propriedade do produto legível por humanos.

Balança
scales array of TaxonomyPropertyScale

Uma lista de escalas disponíveis.

É necessário
is_required boolean

Quando verdadeiro, as listagens atribuídas a IDs de taxonomia qualificadas exigem essa propriedade.

Dá suporte a atributos
supports_attributes boolean

Quando verdadeiro, você pode usar essa propriedade na listagem de atributos.

Dá suporte a variações
supports_variations boolean

Quando verdadeiro, você pode usar essa propriedade em variações de listagem.

É multivalorizado
is_multivalued boolean

Quando verdadeiro, você pode atribuir vários valores de propriedade a essa propriedade

Valores possíveis
possible_values array of TaxonomyPropertyValue

Uma lista de cadeias de caracteres de valor de propriedade com suporte para essa propriedade.

Valores selecionados
selected_values array of TaxonomyPropertyValue

Uma lista de cadeias de caracteres de valor de propriedade automaticamente e sempre selecionada para a propriedade fornecida.

TaxonomyPropertyScale

Uma escala desativando os incrementos atribuíveis para os valores de propriedade disponíveis para propriedades específicas do produto.

Nome Caminho Tipo Description
ID de escala
scale_id integer

A ID numérica exclusiva de uma escala.

Nome de Exibição
display_name string

A cadeia de caracteres de nome para uma escala.

Description
description string

A cadeia de caracteres de descrição para uma escala.

TaxonomyPropertyValue

Um valor de propriedade para uma propriedade de produto específica, que também pode empregar uma escala específica.

Nome Caminho Tipo Description
ID do valor
value_id integer

A ID numérica desse valor de propriedade.

Nome
name string

A cadeia de caracteres de nome desse valor de propriedade.

ID de escala
scale_id integer

A ID de escala numérica da escala à qual esse valor de propriedade pertence.

Igual a
equal_to array of integer

Uma lista de IDs de valor de propriedade numérica que esse valor de propriedade é igual a (se houver).

ShippingCarriers

Representa vários ShippingCarriers.

Nome Caminho Tipo Description
count
count integer
results
results array of ShippingCarrier

ShippingCarrier

Uma transportadora de transporte com suporte, que é usada para calcular uma Data de Entrega Estimada.

Nome Caminho Tipo Description
ID da transportadora de transporte
shipping_carrier_id integer

A ID numérica dessa transportadora de navegação.

Nome
name string

O nome desta transportadora.

Classes domésticas
domestic_classes array of ShippingCarrierMailClass

Conjunto de classes de email domésticas desta transportadora.

Classes internacionais
international_classes array of ShippingCarrierMailClass

Conjunto de classes de correio internacionais desta transportadora.

ShippingCarrierMailClass

Classe de email de uma transportadora, que é usada para calcular uma Data de Entrega Estimada.

Nome Caminho Tipo Description
ID da classe de email
mail_class_key string

O identificador exclusivo desta classe de email.

Nome
name string

O nome desta classe de email.

Lojas

Um conjunto de registros da Loja.

Nome Caminho Tipo Description
Contagem
count integer

O número total de lojas

Results
results array of Shop

Os recursos da Loja.

ShopSection

Uma seção dentro de uma loja, na qual um usuário pode classificar listagens.

Nome Caminho Tipo Description
ID da Seção da Loja
shop_section_id integer

A ID numérica de uma seção em uma loja etsy específica.

Title
title string

A cadeia de caracteres de título de uma seção de loja.

Classificação
rank integer

A posição numérica positiva diferente de zero desta seção na ordem de exibição da seção para uma loja, com seções de classificação 1 aparecendo primeiro.

ID do Usuário
user_id integer

A ID numérica do usuário proprietário desta seção da loja.

Contagem de Listagem Ativa
active_listing_count integer

O número de listagens ativas em uma seção de uma loja etsy específica.

ShopSections

Todas as seções em uma Loja sprecific.

Nome Caminho Tipo Description
Contagem
count integer

O número de resultados.

Results
results array of ShopSection

A lista de recursos solicitados.

ShopShippingProfile

Representa um perfil usado para definir as informações de envio de uma listagem. Observe que não é possível criar modelos de envio calculados por meio da API. No entanto, você pode associar perfis de envio calculados criados do Shop Manager a listagens usando a API.

Nome Caminho Tipo Description
ID do perfil de envio
shipping_profile_id integer

A ID numérica do perfil de envio.

Title
title string

A cadeia de caracteres de nome deste perfil de envio.

ID do Usuário
user_id integer

A ID numérica para o usuário que possui o perfil de envio.

Dias mínimos de processamento
min_processing_days integer

O número mínimo de dias para processar a listagem.

Dias máximos de processamento
max_processing_days integer

O número máximo de dias para processar a listagem.

Rótulo de Dias de Processamento
processing_days_display_label string

Cadeia de caracteres de rótulo de exibição traduzida para dias de processamento.

ISO do país de origem
origin_country_iso string

O código ISO do país do qual a listagem é fornecida.

Está Excluído
is_deleted boolean

Quando verdadeiro, alguém excluiu esse perfil de envio.

Destinos de perfil de envio
shipping_profile_destinations array of ShopShippingProfileDestination

Uma lista de destinos de perfil de envio disponíveis para esse perfil de envio.

Atualizações de perfil de envio
shipping_profile_upgrades array of ShopShippingProfileUpgrade

Uma lista de atualizações de perfil de envio disponíveis para esse perfil de envio.

Código Postal de Origem
origin_postal_code string

A cadeia de caracteres de código postal (não necessariamente um número) para o local do qual a listagem é fornecida.

TipoDePerfil
profile_type ProfileType

ShopShippingProfileDestination

Representa um destino de envio atribuído a um perfil de envio.

Nome Caminho Tipo Description
ID de destino do perfil de envio
shipping_profile_destination_id integer

A ID numérica do destino do perfil de envio no perfil de envio associado à listagem.

ID do perfil de envio
shipping_profile_id integer

A ID numérica do perfil de envio.

ISO do país de origem
origin_country_iso string

O código ISO do país do qual a listagem é fornecida.

ISO do país de destino
destination_country_iso string

O código ISO do país para o qual a listagem é fornecida. Se for nulo, a solicitação definirá o destino como destination_region

DestinationRegion
destination_region DestinationRegion

O código da região para a qual a listagem é fornecida. Uma região representa um conjunto de países. As regiões com suporte são a União Europeia e a União Não Europeia (países da Europa não estão na UE). Se nenhum, a solicitação definirá o destino como destination_country_iso ou em todos os lugares se destination_country_iso também for nulo

Money
primary_cost Money

Uma representação de uma quantidade de dinheiro.

Money
secondary_cost Money

Uma representação de uma quantidade de dinheiro.

ID da transportadora de transporte
shipping_carrier_id integer

A ID exclusiva de uma transportadora com suporte, que é usada para calcular uma Data de Entrega Estimada.

Classe de email
mail_class string

A cadeia de caracteres de ID exclusiva da classe de email de uma transportadora, que é usada para calcular uma data de entrega estimada.

Dias mínimos de entrega
min_delivery_days integer

O número mínimo de dias úteis que um comprador pode esperar para receber seu item comprado assim que for enviado.

Dias máximos de entrega
max_delivery_days integer

O número máximo de dias úteis que um comprador pode esperar para receber seu item comprado depois de enviado.

ShopShippingProfileUpgrade

Uma representação de uma opção de atualização de perfil de envio.

Nome Caminho Tipo Description
ID do perfil de envio
shipping_profile_id integer

A ID numérica do perfil de envio base.

ID de atualização
upgrade_id integer

A ID numérica associada a uma atualização de envio

Nome da Atualização
upgrade_name string

Nome da atualização de envio mostrada aos compradores no check-out, por exemplo, Prioridade do USPS.

Tipo
type Type

O tipo da atualização de envio. Doméstico (0) ou internacional (1).

Classificação
rank integer

A posição numérica positiva diferente de zero nas imagens exibidas em uma listagem, com imagens de classificação 1 aparecendo na posição mais à esquerda em uma listagem.

Linguagem
language string

A marca de idioma IETF para o idioma do perfil de envio. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Money
price Money

Uma representação de uma quantidade de dinheiro.

Money
secondary_price Money

Uma representação de uma quantidade de dinheiro.

ID da transportadora de transporte
shipping_carrier_id integer

A ID exclusiva de uma transportadora com suporte, que é usada para calcular uma Data de Entrega Estimada.

Classe de email
mail_class string

A cadeia de caracteres de ID exclusiva da classe de email de uma transportadora, que é usada para calcular uma data de entrega estimada.

Dias mínimos de entrega
min_delivery_days integer

O número mínimo de dias úteis que um comprador pode esperar para receber seu item comprado assim que for enviado.

Dias máximos de entrega
max_delivery_days integer

O número máximo de dias úteis que um comprador pode esperar para receber seu item comprado depois de enviado.

ShopShippingProfileDestinations

Representa uma lista de objetos de destino de envio.

Nome Caminho Tipo Description
Contagem
count integer

O número de resultados.

Results
results array of ShopShippingProfileDestination

A lista de recursos solicitados.

ShopShippingProfileUpgrades

Uma lista de opções de atualização de envio.

Nome Caminho Tipo Description
Contagem
count integer

O número de resultados.

Results
results array of ShopShippingProfileUpgrade

A lista de recursos solicitados.

UserAddress

Representa o endereço de um usuário.

Nome Caminho Tipo Description
ID do endereço do usuário
user_address_id integer

A ID numérica do endereço do usuário.

ID do Usuário
user_id integer

A ID numérica do usuário.

Nome
name string

O nome do usuário para este endereço.

Primeira linha de endereço
first_line string

A primeira linha do endereço do usuário.

Segunda Linha de Endereço
second_line string

A segunda linha do endereço do usuário.

City
city string

O campo da cidade do endereço do usuário.

Estado
state string

O campo de estado do endereço do usuário.

Código Postal
zip string

O campo de cep do endereço do usuário.

ISO do código do país
iso_country_code string

O código ISO do país neste endereço.

País
country_name string

O nome do país do usuário.

É o endereço de envio padrão
is_default_shipping_address boolean

Esse é o endereço de envio padrão do usuário.

UserAddresses

Representa vários registros UserAddress.

Nome Caminho Tipo Description
Contagem
count integer

O número de registros UserAddress sendo retornados.

Results
results array of UserAddress

Uma matriz de recursos userAddress.

DestinationRegion

O código da região para a qual a listagem é fornecida. Uma região representa um conjunto de países. As regiões com suporte são a União Europeia e a União Não Europeia (países da Europa não estão na UE). Se nenhum, a solicitação definirá o destino como destination_country_iso ou em todos os lugares se destination_country_iso também for nulo

O código da região para a qual a listagem é fornecida. Uma região representa um conjunto de países. As regiões com suporte são a União Europeia e a União Não Europeia (países da Europa não estão na UE). Se nenhum, a solicitação definirá o destino como destination_country_iso ou em todos os lugares se destination_country_iso também for nulo

DestinationRegion
string

ItemDimensionsUnit

Uma cadeia de caracteres que define as unidades usadas para medir as dimensões do produto. O valor padrão é nulo.

Uma cadeia de caracteres que define as unidades usadas para medir as dimensões do produto. O valor padrão é nulo.

ItemDimensionsUnit
string

ItemWeightUnit

Uma cadeia de caracteres que define as unidades usadas para medir o peso do produto. O valor padrão é nulo.

Uma cadeia de caracteres que define as unidades usadas para medir o peso do produto. O valor padrão é nulo.

ItemWeightUnit
string

Ocasião

Uma cadeia de caracteres enumerada que indica uma ocasião para a qual este produto faria um presente apropriado. O valor padrão é nulo.

Uma cadeia de caracteres enumerada que indica uma ocasião para a qual este produto faria um presente apropriado. O valor padrão é nulo.

Ocasião
string

TipoDePerfil

TipoDePerfil
string

Recipient

Uma cadeia de caracteres enumerada que indica uma pessoa para a qual este produto faria um presente apropriado. O valor padrão é nulo.

Uma cadeia de caracteres enumerada que indica uma pessoa para a qual este produto faria um presente apropriado. O valor padrão é nulo.

Recipient
string

Estado

Uma cadeia de caracteres enumerada de qualquer um dos: ativos ou inativos. Observação: definir uma listagem de rascunho como ativa também publicará a listagem no etsy.com.

Uma cadeia de caracteres enumerada de qualquer um dos: ativos ou inativos. Observação: definir uma listagem de rascunho como ativa também publicará a listagem no etsy.com.

Estado
integer

Tipo

O tipo da atualização de envio. Doméstico (0) ou internacional (1).

O tipo da atualização de envio. Doméstico (0) ou internacional (1).

Tipo
integer

WhenMade

Uma cadeia de caracteres enumerada para a era em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar a listagem sob o título Vintage. Requer 'is_supply' e 'who_made'.

Uma cadeia de caracteres enumerada para a era em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar a listagem sob o título Vintage. Requer 'is_supply' e 'who_made'.

WhenMade
string

WhoMade

Uma cadeia de caracteres enumerada inidcatou quem fez o produto. Ajuda os compradores a localizar a listagem sob o título Artesanal. Requer 'is_supply' e 'when_made'.

Uma cadeia de caracteres enumerada inidcatou quem fez o produto. Ajuda os compradores a localizar a listagem sob o título Artesanal. Requer 'is_supply' e 'when_made'.

WhoMade
string