Etsy (Editora Independente)

Esse conector usa sua chave de API para acessar vários recursos Etsy.com. Ele suporta ações para estoque, ordens de venda e gerenciamento de loja. Todas as ações são baseadas no Etsy Open API v3, que tem pontos de extremidade que ainda estão em beta. Se tais ações usarem a API beta, a ação com incluir Beta no título retornará um código de resposta 501.

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes:      - Regiões do Azure Government      - Regiões do Azure China      - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes:      - Governo dos EUA (CCG)      - Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troia Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Editora	Troy Taylor, Soluções Hitachi
Sítio Web	https://www.etsy.com/
Política de privacidade	https://www.etsy.com/legal/privacy/
Categorias	Commerce

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 esta api	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar as imagens de variação de um anúncio	Cria imagens de variação em um anúncio.
Atualizar o inventário de um anúncio	Atualiza o inventário de um anúncio identificado por um ID de anúncio. A atualização falhará se os valores fornecidos para SKU do produto, quantidade de oferta e/ou preço forem incompatíveis com os valores nos campos de propriedade. Ao definir um preço, atribua um float igual ao valor dividido pelo divisor conforme especificado no recurso monetário.
Atualizar um anúncio	Atualiza um anúncio, identificado por um ID de anúncio, para uma loja específica identificada por um ID de loja.
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 do perfil de envio e atualiza todos os anúncios que usam o perfil de envio.
Atualizar uma loja	Atualize uma loja. Assume que todos os parâmetros de cadeia de caracteres são fornecidos no idioma principal da loja.
Atualizar uma propriedade do anúncio	Atualiza ou preenche a lista de propriedades que define as ofertas de produtos para um anúncio. Cada oferta requer um valor e um ID de valor que são válidos para um ID de escala atribuído à listagem ou que você atribui à listagem com essa solicitação.
Atualizar uma tradução do anúncio	Atualiza uma tradução de listagem por ID e idioma da listagem.
Carregar um ficheiro de anúncio	Carrega um novo ficheiro para um anúncio digital ou associa um ficheiro existente a um anúncio específico. Você deve fornecer o ID do arquivo de listagem de um arquivo existente ou o nome e os dados do arquivo binário para um arquivo a ser carregado. Associar um arquivo existente a uma listagem física converte a listagem física em uma listagem digital, que remove todos os custos de envio e quaisquer variações de produtos e estoques.
Carregar uma imagem do anúncio	Carrega ou atribui uma imagem a um anúncio identificado por um ID de loja com um ID de anúncio. Para carregar uma nova imagem, defina o arquivo de imagem como o valor para o parâmetro image. Você pode atribuir uma imagem excluída anteriormente a um anúncio usando o ID da imagem excluída no parâmetro ID da imagem da 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 envio, que define o custo de envio, a transportadora e a classe de um destino em um perfil de remessa. Isso atribui os custos usando a moeda da loja associada. Defina o destino usando o ISO do país de destino ou a região de destino; A ISO do país de destino e a região de destino excluem-se mutuamente — defina uma ou outra. Definir ambos os gatilhos erro 400. Se a solicitação não definir ISO nem região de destino do país de destino, o destino padrão estará em todos os lugares. Você também deve atribuir um ID de transportadora e classe de correio ou ambos os dias de entrega mínimos e dias de entrega máximos.
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 um ID de transportadora e classe de correio, ou ambos os dias de entrega min e max.
Criar um recibo de remessa	Envia informações de rastreamento para um recibo de loja, o que cria uma entrada de remessa de recibo de loja para o ID de recibo fornecido. Cada vez que você envia informações de rastreamento com sucesso, o Etsy envia um e-mail de notificação para o usuário comprador. Quando o envio do BCC é verdadeiro, o 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 como enviado apenas.
Criar uma atualização de perfil de envio	Cria uma nova atualização de perfil de envio, 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 rascunho físico listando o produto em uma loja no canal Etsy.
Criar uma secção Loja	Cria uma nova seção em uma loja específica.
Criar uma tradução de anúncio	Cria uma tradução de listagem por ID e idioma da listagem.
Eliminar um anúncio	Esta ação exclui uma listagem de loja. Uma listagem só pode ser excluída se o estado for um dos seguintes: SOLD_OUT, RASCUNHO, EXPIRADO, INATIVO, ATIVO e is_available ou ATIVO e tiver bandeiras de vendedor: SUPRIMIDO (congelado), FÉRIAS, CUSTOM_SHOPS (padrão), SELL_ON_FACEBOOK
Eliminar uma imagem do anúncio	Exclui uma imagem do anúncio. Uma cópia do ficheiro permanece nos nossos servidores e, portanto, uma imagem eliminada pode ser novamente associada ao anúncio sem voltar a carregar a imagem original.
Excluir um arquivo da listagem	Quando elimina o ficheiro final de um anúncio digital, o anúncio é convertido num anúncio físico. 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 todos os anúncios que usam o perfil de remessa 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 final de envio de um perfil de envio, você deve excluir todo o perfil de envio.
Excluir um perfil de envio	Exclui um perfil de envio por ID determinado.
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 todas as listagens que usam o perfil de remessa associado.
Excluir uma propriedade do anúncio	Exclui uma propriedade de um anúncio.
Obter a propriedade de um anúncio (Beta)	Recupera a propriedade de um anúncio. O desenvolvimento para este endpoint está em andamento. Ele só retornará uma resposta 501.
Obter a tradução de um anúncio	Retorna a tradução de uma listagem no idioma determinado.
Obter a transação de uma loja	Recupera a lista de transações associadas a uma loja.
Obter anúncios ativos	Uma lista de todas as listagens ativas no Etsy paginadas por sua data de criação. Sem ordem de classificação, as listagens serão retornadas mais recentes primeiro por padrão.
Obter anúncios ativos por loja	Recupera uma lista de todos os anúncios ativos no Etsy em uma loja específica, paginada pela data de criação do anúncio.
Obter anúncios em destaque por loja	Recupera listagens associadas a uma loja que são apresentadas.
Obter anúncios por ID	Permite consultar vários IDs de listagem ao mesmo tempo. Limite máximo de 100 IDs por consulta.
Obter anúncios por ID da secção da loja	Recupera todos os anúncios da seção de uma loja específica.
Obter anúncios por loja	Devolve anúncios que pertencem a uma Loja. As listagens podem ser filtradas usando o parâmetro state.
Obter anúncios por recibo de loja	Obtém todas as listagens associadas a um recibo.
Obter atualizações de perfil de envio	Recupera a lista de atualizações de perfil de remessa atribuídas a um perfil de remessa específico.
Obter destinos de perfil por perfil de envio	Recupera uma lista de objetos de destino de remessa associados a um perfil de remessa.
Obter endereços de usuário	Recupere uma lista de endereços de usuário.
Obter entradas do livro razão da conta de pagamento de uma loja	Recupere as entradas do livro razão da conta de pagamento de uma loja.
Obter imagens de um anúncio	Recupera todos os recursos de imagem do anúncio para um anúncio com um ID de anúncio específico.
Obter imagens de variação do anúncio	Obtém todas as imagens de variação em um anúncio.
Obter loja por ID de proprietário	Recupera a loja identificada pelo ID de usuário do proprietário da loja.
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 este endpoint está em andamento. Ele só retornará uma resposta 501.
Obter o inventário de um anúncio	Recupera o registro de inventário de uma listagem. Os anúncios 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 retorna dados de SKU se você for o proprietário dos registros de inventário que estão sendo buscados.
Obter o produto de um anúncio	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 pelo ID da loja.
Obter propriedades de um anúncio	Retorna uma lista das propriedades de um anúncio.
Obter propriedades do produto por ID de taxonomia	Recupera uma lista de propriedades do produto, com escalas e valores aplicáveis, suportados para um ID de taxonomia de vendedor específico.
Obter recibos	Solicita os recibos da loja de uma loja específica, não filtrados ou filtrados por intervalo de ID de recibo ou compensação, data, compras pagas e/ou enviadas.
Obter secção Loja	Recupera uma seção de loja, referenciada por ID de seção e ID de loja.
Obter secções de lojas	Recupera a lista de seções de loja em uma loja específica identificada pelo ID da loja.
Obter todos os ficheiros de listagem	Recupera todos os arquivos associados à listagem digital fornecida. Solicitar arquivos de uma listagem física retorna um resultado vazio.
Obter transportadoras	Recupera uma lista de transportadoras disponíveis e as classes de correio associadas a elas para um determinado país.
Obter um anúncio	Recupera um registro de listagem por ID de listagem.
Obter um ficheiro de um anúncio	Recupera um único arquivo associado à listagem digital fornecida. Solicitar um arquivo de uma listagem física retorna um resultado vazio.
Obter um pagamento a partir de um ID de entrada do livro razão da conta de pagamento	Obtenha um pagamento a partir de um ID de entrada do razão da conta de pagamento, se aplicável.
Obter um pagamento a partir de um recibo específico	Recupera um pagamento de um recibo específico, identificado pelo ID do recibo, de uma loja específica, identificado pelo ID da loja.
Obter um perfil de envio	Recupera um perfil de remessa referenciado pelo ID do perfil de remessa.
Obter um recibo	Recupera um recibo, identificado por um ID de recibo, de uma loja Etsy.
Obter uma imagem do anúncio	Recupera as referências e metadados de uma imagem de listagem com um ID de imagem específico.
Obter uma lista de pagamentos	Recupera uma lista de pagamentos de uma loja identificada pelo ID da loja. Você também pode filtrar os resultados usando uma lista de IDs de pagamento.
Obter uma oferta de anúncio	Obtenha uma oferta para um anúncio.
Obter uma transação	Recupera uma transação por ID de transação.
Obter uma transação de recibo	Recupera a lista de transações associadas a um recibo específico.
Obter utilizador	Retorna o perfil de usuário para o usuário identificado por um ID de usuário.
Pesquisar lojas	Retorna uma lista de lojas com o nome correspondente.
Ping	Verifique para confirmar a conectividade com a API do Etsy com um aplicativo.
Receba avaliações	Recupera as avaliações de uma loja com seu ID.
Recuperar as transações de um anúncio	Recupera a lista de transações associadas a uma listagem.

Atualizar as imagens de variação de um anúncio

ID da Operação:

ListingUpdateVariation

Cria imagens de variação em um anúncio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Imagens de variação	variation_images	True	string	Uma matriz de dados de imagem de variação.

Devoluções

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

ListagemVariaçãoImagens

ListingVariationImages

Atualizar o inventário de um anúncio

ID da Operação:

ListingUpdateInventory

Atualiza o inventário de um anúncio identificado por um ID de anúncio. A atualização falhará se os valores fornecidos para SKU do produto, quantidade de oferta e/ou preço forem incompatíveis com os valores nos campos de propriedade. Ao definir um preço, atribua um float igual ao valor dividido pelo divisor conforme especificado no recurso monetário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	listing_id	True	string	O ID numérico da listagem associada a esta 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 do Imóvel	price_on_property		string	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram os preços dos produtos, se houver. Por exemplo, se você cobrar preços específicos para produtos de tamanhos diferentes na mesma listagem, essa matriz conterá o ID da propriedade para o tamanho.
Quantidade na Propriedade	quantity_on_property		string	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram a quantidade dos produtos, se houver. Por exemplo, se você armazenar quantidades específicas de produtos coloridos diferentes na mesma listagem, essa matriz conterá a ID da propriedade para a cor.
SKU na propriedade	sku_on_property		string	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram a SKU do produto, se houver. Por exemplo, se você usar skus específicos para produtos coloridos diferentes na mesma listagem, essa matriz conterá o ID da propriedade para a cor.

Devoluções

Uma representação do registro de inventário de um único anúncio.

ListagemInventário

ListingInventory

Atualizar um anúncio

ID da Operação:

ListingUpdate

Atualiza um anúncio, identificado por um ID de anúncio, para uma loja específica identificada por um ID de loja.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Quantidade	quantity		integer	O número positivo diferente de 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, sinais 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 sequência de descrição do produto à venda na listagem.
Preço	price		float	O preço positivo diferente de zero do produto. (As listas de produtos vendidos são privadas) Nota: O preço é o preço mínimo possível.
Quem fez	who_made		string	Uma string iniciou quem fez o produto. Ajuda os compradores a localizar o anúncio sob o título Handmade. Requer 'is_supply' e 'when_made'.
Quando feito	when_made		string	Uma string para a época em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar o anúncio sob o título Vintage. Requer 'is_supply' e 'who_made'.
ID da taxonomia	taxonomy_id		integer	O ID de taxonomia numérica da listagem. O vendedor gere os IDs de taxonomia de listagem para a sua loja.
ID do perfil de envio	shipping_profile_id		integer	O ID numérico do perfil de envio associado ao anúncio.
Materials	materials		string	Uma matriz de cordas 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 Secção da Loja	shop_section_id		integer	O ID numérico da secção Loja para este anúncio.
Processamento Mínimo	processing_min		integer	O número mínimo de dias necessários para processar esta listagem.
Máximo de processamento	processing_max		integer	O número máximo de dias necessários para processar esta listagem.
Etiquetas	tags		string	Uma matriz de cadeias de caracteres de tag para a listagem. As cadeias de caracteres de tags 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 string que indica uma pessoa para quem este produto faria um presente apropriado.
Ocasião	occasion		string	Uma string que indica uma ocasião para a qual este produto faria um presente apropriado.
Estilos	styles		string	Uma matriz de cadeias de caracteres de estilo para esta listagem, cada uma das quais é cadeia de texto de forma livre, como Formal ou Steampunk. Um anúncio pode ter até dois estilos. As cadeias 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 artigo	item_weight		float	O peso numérico do produto medido em unidades definidas em 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, medida em unidades, definida em «unidade de dimensões do artigo».
Altura do artigo	item_height		float	A altura numérica do produto, medida em unidades, definida em «unidade de dimensões do artigo».
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 de Dimensões do 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, este anúncio é 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.
É Oferta	is_supply		boolean	Quando verdadeiro, marca a listagem como um produto de fornecimento, caso contrário, indica que é um produto acabado. Ajuda os compradores a localizar o anúncio sob o título Suprimentos. Requer 'quem fez' e 'quando fez'.
É personalizável	is_customizable		boolean	Quando verdadeiro, um comprador pode entrar em contato com o vendedor para um pedido personalizado. O valor padrão é true quando uma loja aceita pedidos personalizados. Não se aplica a lojas que não aceitam encomendas personalizadas.
É tributável	is_taxable		boolean	Quando verdadeiro, as taxas de imposto da loja aplicáveis aplicam-se a este anúncio no checkout.
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 página inicial de uma loja.
Deve renovar automaticamente	should_auto_renew		boolean	Quando verdadeiro, renova uma listagem por quatro meses após a exprição. Se definido como true quando anteriormente falso, etsy.com renova o anúncio antes que ele expire, mas o período de renovação começa imediatamente, em vez de estender a data de expiração do anúncio. Qualquer tempo não utilizado restante no anúncio é perdido. As renovações resultam em cobranças na conta do usuário.
Tipo	type		string	Indica se o anúncio é físico ou um download digital.
Channels	channels		string	Uma matriz de cadeias de caracteres de ID de canal enumeradas. Um canal é um local para os vendedores alcançarem os compradores a fim de fazer vendas.

Devoluções

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

Listagem de lojas

ShopListing

Atualizar um destino de perfil de envio

ID da Operação:

ShippingUpdateProfileDestination

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

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	string	O ID numérico do perfil de envio associado ao anúncio.
ID de destino do perfil de envio	shipping_profile_destination_id	True	string	A ID numérica do destino do perfil de remessaassociado à 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

Devoluções

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

LojaEnvioPerfilDestino

ShopShippingProfileDestination

Atualizar um perfil de envio

ID da Operação:

ShippingUpdateProfile

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
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 a partir do qual a lista é enviada.
Tempo Mínimo de Processamento	min_processing_time		integer	O tempo mínimo necessário para processar listagens de envio com este perfil de envio.
Tempo máximo de processamento	max_processing_time		integer	O tempo máximo de processamento que o anúncio precisa para ser enviado.
Unidade de Tempo de Processamento	processing_time_unit		string	A unidade usada para representar quanto tempo é um tempo de processamento. Uma semana equivale 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 do código postal (não necessariamente um número) para o local a partir do qual a listagem é enviada.

Devoluções

Representa um perfil usado para definir as informações de envio de um anúncio. Por favor, note que não é possível criar modelos de envio calculados através da API. No entanto, você pode associar perfis de frete calculados criados a partir do Shop Manager a listagens usando a API.

ShopShippingPerfil

ShopShippingProfile

Atualizar uma atualização de perfil de envio

ID da Operação:

ShippingUpdateProfileUpgrade

Atualiza uma atualização do perfil de envio e atualiza todos os anúncios que usam o perfil de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
ID de atualização	upgrade_id	True	integer	A ID numérica associada a uma atualização de remessa
Tipo	type		string	O tipo de atualização de envio. Doméstica (0) ou internacional (1).
Nome da atualização	upgrade_name		string	Nome da atualização de envio mostrada aos compradores no checkout, por exemplo, USPS Priority.
Preço	price		float	Custo adicional de adicionar o upgrade de envio.
Preço Secundário	secondary_price		float	Custo adicional de adicionar o upgrade de envio para cada item adicional.
ID da transportadora	shipping_carrier_id		integer	O ID exclusivo de uma transportadora suportada, que é usado para calcular uma Data de Entrega Estimada.
Classe Mail	mail_class		string	A cadeia de caracteres de ID exclusiva da classe de correio 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 o item comprado depois de enviado.

Devoluções

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

ShopShippingProfileUpgrade

ShopShippingProfileUpgrade

Atualizar uma loja

ID da Operação:

ShopUpdate

Atualize uma loja. Assume que todos os parâmetros de cadeia de caracteres são fornecidos no idioma principal da loja.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Title	title		string	Uma breve sequência de cabeçalho para a página principal da loja.
Anúncio	announcement		string	Uma sequência de anúncios para os compradores que é exibida na página inicial da loja.
Mensagem de Venda	sale_message		string	Uma cadeia de caracteres de mensagem enviada aos usuários que concluem uma compra nesta loja.
Mensagem de venda digital	digital_sale_message		string	Uma cadeia de caracteres de mensagem enviada aos usuários que compram um item digital nesta loja.

Devoluções

Uma loja criada por um utilizador Etsy.

Loja

Shop

Atualizar uma propriedade do anúncio

ID da Operação:

ListingUpdateProperty

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID da Propriedade	property_id	True	integer	O ID exclusivo de uma propriedade de anúncio do Etsy.
IDs de valor	value_ids	True	integer	A ID numérica de uma única escala de medição Etsy.com.
Valores	values	True	string	Uma matriz de cadeias de caracteres de valor para vários valores de propriedade de listagem do Etsy.
ID da escala	scale_id		integer	A ID numérica de uma única escala de medição Etsy.com.

Devoluções

Uma representação de valores de dados estruturados.

ListingPropertyValue

ListingPropertyValue

Atualizar uma tradução do anúncio

ID da Operação:

ListingUpdateTranslation

Atualiza uma tradução de listagem por ID e idioma da listagem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Linguagem	language	True	string	A marca de idioma IETF para o idioma desta 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 tags da Listagem desta Tradução.

Devoluções

Representa os dados de tradução de um anúncio.

ListagemTradução

ListingTranslation

Carregar um ficheiro de anúncio

ID da Operação:

ListingUpload

Carrega um novo ficheiro para um anúncio digital ou associa um ficheiro existente a um anúncio específico. Você deve fornecer o ID do arquivo de listagem de um arquivo existente ou o nome e os dados do arquivo binário para um arquivo a ser carregado. Associar um arquivo existente a uma listagem física converte a listagem física em uma listagem digital, que remove todos os custos de envio e quaisquer variações de produtos e estoques.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID do arquivo de listagem	listing_file_id		integer	A ID numérica exclusiva de um arquivo associado a uma listagem digital.
Ficheiro	file	True	string	Um ficheiro binário para carregar.
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.

Devoluções

Um arquivo associado a uma listagem digital.

ShopListingFile

ShopListingFile

Carregar uma imagem do anúncio

ID da Operação:

ListingUploadImage

Carrega ou atribui uma imagem a um anúncio identificado por um ID de loja com um ID de anúncio. Para carregar uma nova imagem, defina o arquivo de imagem como o valor para o parâmetro image. Você pode atribuir uma imagem excluída anteriormente a um anúncio usando o ID da imagem excluída no parâmetro ID da imagem da 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

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Imagem	image		string	A cadeia de caracteres de nome de arquivo de um arquivo a ser carregado.
ID da imagem do anúncio	listing_image_id		integer	A ID numérica da imagem de listagem principal para esta 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.
Substituir	overwrite		boolean	Quando verdadeiro, essa solicitação substitui a imagem existente em uma determinada classificação.
Tem marca d'água	is_watermarked		boolean	Quando verdadeiro, indica que a imagem carregada tem uma marca d'água.

Devoluções

Referenciar urls e metadados para uma imagem associada a uma listagem específica. O url_fullxfull parâmetro contém a URL para o arquivo de imagem binária de tamanho normal.

ListagemImagem

ListingImage

Criar um destino de perfil de envio

ID da Operação:

ShippingCreateDestination

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
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

Devoluções

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

LojaEnvioPerfilDestino

ShopShippingProfileDestination

Criar um perfil de envio

ID da Operação:

ShippingCreateProfile

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 um ID de transportadora e classe de correio, ou ambos os dias de entrega min e max.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
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 a partir do qual a lista é enviada.
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 listagens de envio com este perfil de envio.
Tempo máximo de processamento	max_processing_time	True	integer	O tempo máximo de processamento que o anúncio precisa para ser enviado.
Unidade de Tempo de Processamento	processing_time_unit		string	A unidade usada para representar quanto tempo é um tempo de processamento. Uma semana equivale 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 lista é enviada. Se null, request define 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 é enviada. Uma região representa um conjunto de países. As regiões apoiadas são a União Europeia e a União Não Europeia (países da Europa que não pertencem à UE). Se nenhum, a solicitação define o destino para o país de destino ISO ou em qualquer lugar se o país de destino ISO também for nulo.
Código Postal de Origem	origin_postal_code		string	A cadeia de caracteres do código postal (não necessariamente um número) para o local a partir do qual a listagem é enviada.
ID da transportadora	shipping_carrier_id		integer	O ID exclusivo de uma transportadora suportada, que é usado para calcular uma data de entrega estimada.
Classe Mail	mail_class		string	A cadeia de caracteres de ID exclusiva da classe de correio 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 o item comprado depois de 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 o item comprado depois de enviado.

Devoluções

Representa um perfil usado para definir as informações de envio de um anúncio. Por favor, note que não é possível criar modelos de envio calculados através da API. No entanto, você pode associar perfis de frete calculados criados a partir do Shop Manager a listagens usando a API.

ShopShippingPerfil

ShopShippingProfile

Criar um recibo de remessa

ID da Operação:

ReceiptCreateShipment

Envia informações de rastreamento para um recibo de loja, o que cria uma entrada de remessa de recibo de loja para o ID de recibo fornecido. Cada vez que você envia informações de rastreamento com sucesso, o Etsy envia um e-mail de notificação para o usuário comprador. Quando o envio do BCC é verdadeiro, o 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 como enviado apenas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do recibo	receipt_id	True	integer	O recibo para enviar rastreamento.
Código de rastreamento	tracking_code		string	O código de acompanhamento para este recibo.
Nome da transportadora	carrier_name		string	O nome da transportadora para este recibo.
Enviar BCC	send_bcc		boolean	Se for verdadeira, a notificação de envio também será enviada ao vendedor

Devoluções

O registro de uma compra em 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

ID da Operação:

ShippingCreateUpgrade

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
Tipo	type	True	string	O tipo de atualização de envio. Doméstica (0) ou internacional (1).
Nome da atualização	upgrade_name	True	string	Nome da atualização de envio mostrada aos compradores no checkout, por exemplo, USPS Priority.
Preço	price	True	float	Custo adicional de adicionar o upgrade de envio.
Preço Secundário	secondary_price	True	float	Custo adicional de adicionar o upgrade de envio para cada item adicional.
ID da transportadora	shipping_carrier_id		integer	O ID exclusivo de uma transportadora suportada, que é usado para calcular uma Data de Entrega Estimada.
Classe Mail	mail_class		string	A cadeia de caracteres de ID exclusiva da classe de correio 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 o item comprado depois de enviado.

Devoluções

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

ShopShippingProfileUpgrade

ShopShippingProfileUpgrade

Criar uma listagem de rascunho

ID da Operação:

ListingCreate

Cria um rascunho físico listando o produto em uma loja no canal Etsy.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Quantidade	quantity	True	integer	O número positivo diferente de 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, sinais 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 sequência de descrição do produto à venda na listagem.
Preço	price	True	float	O preço positivo diferente de zero do produto. (As listas de produtos vendidos são privadas) Nota: O preço é o preço mínimo possível.
Quem fez	who_made	True	string	Uma string iniciou quem fez o produto. Ajuda os compradores a localizar o anúncio sob o título Handmade. Requer 'is_supply' e 'when_made'.
Quando feito	when_made		string	Uma string para a época em que o fabricante fez o produto nesta listagem. Ajuda os compradores a localizar o anúncio sob o título Vintage. Requer 'is_supply' e 'who_made'.
ID da taxonomia	taxonomy_id	True	integer	O ID de taxonomia numérica da listagem. O vendedor gere os IDs de taxonomia de listagem para a sua loja.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
Materials	materials		string	Uma matriz de cordas 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 Secção da Loja	shop_section_id		integer	O ID numérico da secção Loja para este anúncio.
Processamento Mínimo	processing_min		integer	O número mínimo de dias necessários para processar esta listagem.
Máximo de processamento	processing_max		integer	O número máximo de dias necessários para processar esta listagem.
Etiquetas	tags		string	Uma matriz de cadeias de caracteres de tag para a listagem. As cadeias de caracteres de tags 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 string que indica uma pessoa para quem este produto faria um presente apropriado.
Ocasião	occasion		string	Uma string que indica uma ocasião para a qual este produto faria um presente apropriado.
Estilos	styles		string	Uma matriz de cadeias de caracteres de estilo para esta listagem, cada uma das quais é cadeia de texto de forma livre, como Formal ou Steampunk. Um anúncio pode ter até dois estilos. As cadeias 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 artigo	item_weight		float	O peso numérico do produto medido em unidades definidas em 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, medida em unidades, definida em «unidade de dimensões do artigo».
Altura do artigo	item_height		float	A altura numérica do produto, medida em unidades, definida em «unidade de dimensões do artigo».
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 de Dimensões do 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, este anúncio é 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.
É Oferta	is_supply		boolean	Quando verdadeiro, marca a listagem como um produto de fornecimento, caso contrário, indica que é um produto acabado. Ajuda os compradores a localizar o anúncio sob o título Suprimentos. Requer 'quem fez' e 'quando fez'.
É personalizável	is_customizable		boolean	Quando verdadeiro, um comprador pode entrar em contato com o vendedor para um pedido personalizado. O valor padrão é true quando uma loja aceita pedidos personalizados. Não se aplica a lojas que não aceitam encomendas personalizadas.
É tributável	is_taxable		boolean	Quando verdadeiro, as taxas de imposto da loja aplicáveis aplicam-se a este anúncio no checkout.

Devoluções

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

Listagem de lojas

ShopListing

Criar uma secção Loja

ID da Operação:

ShopCreateSection

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Title	title	True	string	A cadeia de caracteres de título de uma seção de loja.

Devoluções

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

ShopSection

ShopSection

Criar uma tradução de anúncio

ID da Operação:

ListingCreateTranslation

Cria uma tradução de listagem por ID e idioma da listagem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Linguagem	language	True	string	A marca de idioma IETF para o idioma desta 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 tags da Listagem desta Tradução.

Devoluções

Representa os dados de tradução de um anúncio.

ListagemTradução

ListingTranslation

Eliminar um anúncio

ID da Operação:

ListingDelete

Esta ação exclui uma listagem de loja. Uma listagem só pode ser excluída se o estado for um dos seguintes: SOLD_OUT, RASCUNHO, EXPIRADO, INATIVO, ATIVO e is_available ou ATIVO e tiver bandeiras de vendedor: SUPRIMIDO (congelado), FÉRIAS, CUSTOM_SHOPS (padrão), SELL_ON_FACEBOOK

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.

Eliminar uma imagem do anúncio

ID da Operação:

ListingDeleteImage

Exclui uma imagem do anúncio. Uma cópia do ficheiro permanece nos nossos servidores e, portanto, uma imagem eliminada pode ser novamente associada ao anúncio sem voltar a carregar a imagem original.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID da imagem do anúncio	listing_image_id	True	integer	A ID numérica da imagem de listagem principal para esta transação.

Excluir um arquivo da listagem

ID da Operação:

ListingDeleteFile

Quando elimina o ficheiro final de um anúncio digital, o anúncio é convertido num anúncio físico. A resposta a uma solicitação de exclusão retorna uma lista dos registros de arquivo restantes associados à listagem fornecida.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID do arquivo de listagem	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

ID da Operação:

ShippingDeleteProfileDestination

Exclui um destino de envio e remove a opção de destino de todos os anúncios que usam o perfil de remessa 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 final de envio de um perfil de envio, você deve excluir todo o perfil de envio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
ID de destino do perfil de envio	shipping_profile_destination_id	True	integer	O ID numérico do destino do perfil de envio no perfil de envio associado ao anúncio.

Excluir um perfil de envio

ID da Operação:

ShippingDeleteProfile

Exclui um perfil de envio por ID determinado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.

Devoluções

Representa um perfil usado para definir as informações de envio de um anúncio. Por favor, note que não é possível criar modelos de envio calculados através da API. No entanto, você pode associar perfis de frete calculados criados a partir do Shop Manager a listagens usando a API.

ShopShippingPerfil

ShopShippingProfile

Excluir uma atualização de perfil de envio

ID da Operação:

ShippingDeleteProfileUpgrade

Exclui uma atualização de perfil de envio e remove a opção de atualização de todas as listagens que usam o perfil de remessa associado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio.
ID de atualização	upgrade_id	True	integer	A ID numérica associada a uma atualização de remessa

Excluir uma propriedade do anúncio

ID da Operação:

ListingDeleteProperty

Exclui uma propriedade de um anúncio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID da Propriedade	property_id	True	integer	O ID exclusivo de uma propriedade de anúncio do Etsy.

Obter a propriedade de um anúncio (Beta)

ID da Operação:

ListingGetProperty

Recupera a propriedade de um anúncio. O desenvolvimento para este endpoint está em andamento. Ele só retornará uma resposta 501.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID da Propriedade	property_id	True	integer	O ID exclusivo de uma propriedade de anúncio do Etsy.

Devoluções

Uma representação de valores de dados estruturados.

ListingPropertyValue

ListingPropertyValue

Obter a tradução de um anúncio

ID da Operação:

ListingGetTranslation

Retorna a tradução de uma listagem no idioma determinado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Linguagem	language	True	string	A marca de idioma IETF para o idioma desta tradução. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru.

Devoluções

Representa os dados de tradução de um anúncio.

ListagemTradução

ListingTranslation

Obter a transação de uma loja

ID da Operação:

TransactionGetShop

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

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

ShopReceiptTransactions

ShopReceiptTransactions

Obter anúncios ativos

ID da Operação:

ListingGetActive

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.
Includes	keywords		string	Termo ou frase de pesquisa que deve aparecer em todos os resultados.
Ordenar em	sort_on		string	O valor para classificar um resultado de pesquisa de listagens. NOTA: ordenar em 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 ascendente (para cima) ou descendente (para baixo) para classificar as listagens por. NOTA: 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 dos anúncios a serem retornados por um resultado de pesquisa.
Preço Máximo	max_price		float	O preço máximo dos anúncios a serem retornados por um resultado de pesquisa.
ID da taxonomia	taxonomy_id		integer	O ID de taxonomia numérica da listagem. O vendedor gere os IDs de taxonomia de listagem para a sua loja.
Localização da Loja	shop_location		string	Filtra por localização da loja. Se a localização não puder ser analisada, o Etsy responderá com um erro.

Devoluções

Um conjunto de recursos de listagem de lojas.

Listas de compras

ShopListings

Obter anúncios ativos por loja

ID da Operação:

ListingGetActiveByShop

Recupera uma lista de todos os anúncios ativos no Etsy em uma loja específica, paginada pela data de criação do anúncio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.
Includes	keywords		string	Termo ou frase de pesquisa que deve aparecer em todos os resultados.

Devoluções

Um conjunto de recursos de listagem de lojas.

Listas de compras

ShopListings

Obter anúncios em destaque por loja

ID da Operação:

ListingGetFeatured

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

Um conjunto de recursos de listagem de lojas.

Listas de compras

ShopListings

Obter anúncios por ID

ID da Operação:

ListingGetByID

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
IDs do anúncio	listing_ids	True	string	A matriz de IDs numéricos para os anúncios em uma loja Etsy específica.
Includes	includes		string	Uma cadeia de caracteres enumerada que anexa uma associação válida.

Devoluções

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

ShopListingsComAssociações

ShopListingsWithAssociations

Obter anúncios por ID da secção da loja

ID da Operação:

ListingGetBySectionID

Recupera todos os anúncios da seção de uma loja específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
IDs da Secção Loja	shop_section_ids	True	string	Uma matriz de IDs numéricos para todas as seções em uma loja Etsy específica.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.
Ordenar em	sort_on		string	O valor para classificar um resultado de pesquisa de listagens.
Ordem de classificação	sort_order		string	A ordem ascendente (para cima) ou descendente (para baixo) para classificar as listagens por.

Devoluções

Um conjunto de recursos de listagem de lojas.

Listas de compras

ShopListings

Obter anúncios por loja

ID da Operação:

ListingGetShop

Devolve anúncios que pertencem a uma Loja. As listagens podem ser filtradas usando o parâmetro state.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Estado	State		string	Uma cadeia de caracteres enumerada de qualquer um: ativo ou inativo.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.
Ordenar em	Sort On		string	O valor para classificar um resultado de pesquisa de listagens.
Ordem de classificação	Sort Order		string	A ordem ascendente (para cima) ou descendente (para baixo) para classificar as listagens por.

Devoluções

Um conjunto de recursos de listagem de lojas.

Listas de compras

ShopListings

Obter anúncios por recibo de loja

ID da Operação:

ListingGetByReceipt

Obtém todas as listagens associadas a um recibo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	A ID numérica do recibo associado a esta transação.
ID do recibo	receipt_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

Um conjunto de recursos de listagem de lojas.

Listas de compras

ShopListings

Obter atualizações de perfil de envio

ID da Operação:

ShippingGetProfileUpgrades

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.

Devoluções

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

ShopShippingProfileUpgrades

ShopShippingProfileUpgrades

Obter destinos de perfil por perfil de envio

ID da Operação:

ShippingGetDestinations

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

Representa uma lista de objetos de destino de remessa.

LojaEnvioPerfilDestinos

ShopShippingProfileDestinations

Obter endereços de usuário

ID da Operação:

UserGetAddresses

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

Representa vários registros UserAddress.

Endereços de usuário

UserAddresses

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

ID da Operação:

PaymentLedgerEntries

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
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.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

Um conjunto de recursos de entrada contábil de contas de pagamento

PaymentAccountLedgerEntries

PaymentAccountLedgerEntries

Obter imagens de um anúncio

ID da Operação:

ListingGetImages

Recupera todos os recursos de imagem do anúncio para um anúncio com um ID de anúncio específico.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.

Devoluções

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

ListagemImagens

ListingImages

Obter imagens de variação do anúncio

ID da Operação:

ListingGetVariation

Obtém todas as imagens de variação em um anúncio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.

Devoluções

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

ListagemVariaçãoImagens

ListingVariationImages

Obter loja por ID de proprietário

ID da Operação:

ShopGetByOwnerID

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	user_id	True	string	O ID de utilizador numérico do utilizador proprietário desta loja.

Devoluções

Uma loja criada por um utilizador Etsy.

Loja

Shop

Obter nós de taxonomia do vendedor

ID da Operação:

ListingGetTaxonomyNodes

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

Devoluções

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

VendedorTaxonomiaNós

SellerTaxonomyNodes

Obter o endereço do usuário

ID da Operação:

UserGetAddress

Recupera o endereço do usuário. O desenvolvimento para este endpoint está em andamento. Ele só retornará uma resposta 501.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Endereço do Utilizador	user_address_id	True	integer	O ID numérico do endereço do usuário.

Devoluções

Representa o endereço de um usuário.

Endereço do usuário

UserAddress

Obter o inventário de um anúncio

ID da Operação:

ListingGetInventory

Recupera o registro de inventário de uma listagem. Os anúncios 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 retorna dados de SKU se você for o proprietário dos registros de inventário que estão sendo buscados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Includes	includes		string	Uma cadeia de caracteres enumerada que anexa uma associação válida.

Devoluções

Uma representação do registro de inventário de um único anúncio com associações

ListagemInventárioComAssociações

ListingInventoryWithAssociations

Obter o produto de um anúncio

ID da Operação:

ListingGetProduct

Recupere um produto de listagem por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	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 um anúncio.

Devoluções

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

ListagemInventárioProduto

ListingInventoryProduct

Obter perfis de envio

ID da Operação:

ShippingProfiles

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.

Devoluções

Representa um perfil usado para definir as informações de envio de um anúncio. Por favor, note que não é possível criar modelos de envio calculados através da API. No entanto, você pode associar perfis de frete calculados criados a partir do Shop Manager a listagens usando a API.

ShopShippingPerfil

ShopShippingProfile

Obter propriedades de um anúncio

ID da Operação:

ListingGetProperties

Retorna uma lista das propriedades de um anúncio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.

Devoluções

Representa vários valores de propriedade de listagem.

ListingPropertyValues

ListingPropertyValues

Obter propriedades do produto por ID de taxonomia

ID da Operação:

ListingGetPropertiesByTaxonomy

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

Parâmetros

Name	Chave	Necessá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.

Devoluções

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

TaxonomyNodeProperties

TaxonomyNodeProperties

Obter recibos

ID da Operação:

ReceiptsGet

Solicita os recibos da loja de uma loja específica, não filtrados ou filtrados por intervalo de ID de recibo ou compensação, data, compras pagas e/ou enviadas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
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 primeiro carimbo de data/hora unix para quando um registro foi alterado pela última vez.
Última modificação	max_last_modified		integer	O carimbo de data/hora unix mais recente para quando um registro foi alterado pela última vez.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.
Foi pago	was_paid		boolean	Quando verdadeiro, o vendedor recebeu o pagamento do(s) produto(s) neste recibo.
foi enviado	was_shipped		boolean	Quando verdadeiro, o vendedor enviou o(s) produto(s) neste recibo.

Devoluções

Os recibos de uma Loja específica.

ShopReceipts

ShopReceipts

Obter secção Loja

ID da Operação:

ShopGetSection

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID da Secção da Loja	shop_section_id	True	integer	O ID numérico de uma seção em uma loja Etsy específica.

Devoluções

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

ShopSection

ShopSection

Obter secções de lojas

ID da Operação:

ShopGetSections

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.

Devoluções

Todas as seções em uma loja precific.

ShopSections

ShopSections

Obter todos os ficheiros de listagem

ID da Operação:

ListingGetFiles

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico da listagem associada a esta transação.
ID do anúncio	listing_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.

Devoluções

Representa vários ShopListingFiles.

ShopListingArquivos

ShopListingFiles

Obter transportadoras

ID da Operação:

ShippingCarriers

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ISO do país de origem	origin_country_iso	True	string	O código ISO do país a partir do qual a lista é enviada.

Devoluções

Representa vários ShippingCarriers.

TransportadoresTransportadores

ShippingCarriers

Obter um anúncio

ID da Operação:

ListingGet

Recupera um registro de listagem por ID de listagem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Includes	includes		string	Uma cadeia de caracteres enumerada que anexa uma associação válida. Os inputs aceitáveis são 'loja', 'imagens' e 'utilizador'.

Obter um ficheiro de um anúncio

ID da Operação:

ListingGetFile

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID do arquivo de listagem	listing_file_id	True	integer	A ID numérica exclusiva de um arquivo associado a uma listagem digital.

Devoluções

Um arquivo associado a uma listagem digital.

ShopListingFile

ShopListingFile

Obter um pagamento a partir de um ID de entrada do livro razão da conta de pagamento

ID da Operação:

PaymentGetEntryID

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
IDs de entrada contábil	ledger_entry_ids	True	string	Matriz de inteiros.

Devoluções

Representa vários pagamentos feitos com Etsy Payments. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

Payments

Payments

Obter um pagamento a partir de um recibo específico

ID da Operação:

PaymentGetReceipt

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do recibo	receipt_id	True	string	A ID numérica do recibo associado a esta transação.

Devoluções

Representa vários pagamentos feitos com Etsy Payments. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

Payments

Payments

Obter um perfil de envio

ID da Operação:

ShippingGetProfile

Recupera um perfil de remessa referenciado pelo ID do perfil de remessa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do perfil de envio	shipping_profile_id	True	integer	O ID numérico do perfil de envio associado ao anúncio.

Obter um recibo

ID da Operação:

ReceiptGet

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do recibo	receipt_id	True	integer	A ID numérica do recibo associado a esta transação.

Devoluções

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

ShopReceipt

ShopReceipt

Obter uma imagem do anúncio

ID da Operação:

ListingGetImage

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID da imagem do anúncio	listing_image_id	True	integer	A ID numérica da imagem de listagem principal para esta transação.

Devoluções

Referenciar urls e metadados para uma imagem associada a uma listagem específica. O url_fullxfull parâmetro contém a URL para o arquivo de imagem binária de tamanho normal.

ListagemImagem

ListingImage

Obter uma lista de pagamentos

ID da Operação:

PaymentsGet

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID de pagamento	payment-ids	True	string	Uma matriz separada por vírgulas de números de IDs de pagamento.

Devoluções

Representa vários pagamentos feitos com Etsy Payments. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

Payments

Payments

Obter uma oferta de anúncio

ID da Operação:

ListingGetOffering

Obtenha uma oferta para um anúncio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
ID do produto	product_id	True	integer	A ID numérica do produto associado a esta transação.
ID da oferta do produto	product_offering_id	True	integer	O ID numérico da oferta de produto associada a esta transação.

Devoluções

Uma representação de uma oferta para um anúncio.

ListagemInventárioProdutoOferta

ListingInventoryProductOffering

Obter uma transação

ID da Operação:

TransactionGet

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID da transação	transaction_id	True	integer	O ID numérico exclusivo para uma transação.

Devoluções

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

ID da Operação:

TransactionReceipt

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do recibo	receipt_id	True	integer	A ID numérica do recibo associado a esta transação.

Devoluções

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

ShopReceiptTransactions

ShopReceiptTransactions

Obter utilizador

ID da Operação:

UserGet

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador	user_id	True	integer	O ID numérico positivo exclusivo diferente de zero para um usuário.

Devoluções

Representa um único usuário do site

User

User

Pesquisar lojas

ID da Operação:

ShopSearch

Retorna uma lista de lojas com o nome correspondente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da loja	shop_name	True	string	A cadeia de caracteres do nome da loja.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

Um conjunto de registos da loja.

Lojas

Shops

Ping

ID da Operação:

Ping

Verifique para confirmar a conectividade com a API do Etsy com um aplicativo.

Devoluções

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

Pong

Pong

Receba avaliações

ID da Operação:

ReviewsGet

Recupera as avaliações de uma loja com seu ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

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

TransactionReviews

TransactionReviews

Recuperar as transações de um anúncio

ID da Operação:

TransactionsListing

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da loja	shop_id	True	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do anúncio	listing_id	True	integer	O ID numérico da listagem associada a esta transação.
Limite	limit		integer	O número máximo de resultados a serem retornados.
Compensação	offset		integer	O número de registros a serem ignorados antes de selecionar o primeiro resultado.

Devoluções

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

ShopReceiptTransactions

ShopReceiptTransactions

Definições

Listagem de lojas

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

Name	Caminho	Tipo	Description
ID do anúncio	listing_id	integer	O ID numérico da listagem associada a esta transação.
ID de utilizador	user_id	integer	O ID numérico do usuário que publica a listagem.
ID da loja	shop_id	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
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, sinais 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 sequência de descrição do produto à venda na listagem.
Estado	state	State	Uma cadeia de caracteres enumerada de qualquer um: ativo ou inativo. Nota: Definir um rascunho de listagem como ativo também publicará o anúncio no etsy.com.
Carimbo de data/hora de criação	creation_timestamp	integer	O tempo de criação do anúncio, em segundos de época.
Carimbo de data/hora final	ending_timestamp	integer	O tempo de expiração do anúncio, em segundos de época.
Carimbo de data/hora da criação original	original_creation_timestamp	integer	O tempo de criação do anúncio, em segundos de época.
Carimbo de data/hora da última modificação	last_modified_timestamp	integer	A hora da última atualização da 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 diferente de zero de produtos disponíveis para compra na listagem. Nota: A quantidade de listagem é a soma das quantidades de oferta disponíveis. Você pode solicitar as quantidades para ofertas individuais no recurso ListingInventory usando o ponto de extremidade de inventário obter listagem.
ID da Secção da Loja	shop_section_id	integer	O ID numérico 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 as listagens de classificação 1 aparecendo na posição mais à esquerda na listagem em destaque na página inicial de uma loja.
URL	url	string	O URL completo para a página do anúncio no Etsy.
Número de Favorecidos	num_favorers	integer	O número de utilizadores que marcaram esta listagem como favorita.
Não tributável	non_taxable	boolean	Quando verdadeiro, as taxas de imposto da loja aplicáveis não se aplicam a este anúncio no checkout.
É personalizável	is_customizable	boolean	Quando verdadeiro, um comprador pode entrar em contato com o vendedor para um pedido personalizado. O valor padrão é true quando uma loja aceita pedidos personalizados. Não se aplica a lojas que não aceitam encomendas personalizadas.
É peronalizable	is_personalizable	boolean	Quando verdadeiro, este anúncio é personalizável. O valor padrão é null.
A personalização é necessária	personalization_is_required	boolean	Quando verdadeira, esta listagem requer personalização. O valor padrão é null.
Contagem máxima de caracteres de personalização	personalization_char_count_max	integer	Este é um valor inteiro que representa o comprimento máximo para a mensagem de personalização inserida pelo comprador.
Instruções de personalização	personalization_instructions	string	Quando verdadeira, esta listagem requer personalização. O valor padrão é null.
Tipo de anúncio	listing_type	boolean	Uma cadeia de caracteres de tipo enumerado que indica se a listagem é física ou um download digital.
Etiquetas	tags	array of string	Uma lista de cadeias de caracteres de tag para a listagem. As cadeias de caracteres de tags 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 é null.
Materials	materials	array of string	Uma lista de cordas 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 é null.
ID do perfil de envio	shipping_profile_id	integer	O ID numérico do perfil de envio associado ao anúncio.
Dias Mínimos de Processamento	processing_min	integer	O número mínimo de dias necessários para processar esta listagem. O valor padrão é null.
Dias máximos de processamento	processing_max	integer	O número máximo de dias necessários para processar esta listagem. O valor padrão é null.
Quem Fez	who_made	WhoMade	Uma cadeia de caracteres enumerada iniciou quem criou o produto. Ajuda os compradores a localizar o anúncio sob o título Handmade. Requer 'is_supply' e 'when_made'.
QuandoMade	when_made	WhenMade	Uma cadeia de caracteres enumerada para a era em que o fabricante criou o produto nesta listagem. Ajuda os compradores a localizar o anúncio sob o título Vintage. Requer 'is_supply' e 'who_made'.
Fornecimento de Produto	is_supply	boolean	Quando verdadeiro, marca a listagem como um produto de fornecimento, caso contrário, indica que é um produto acabado. Ajuda os compradores a localizar o anúncio sob o título Suprimentos. Requer 'who_made' e 'when_made'.
Peso do artigo	item_weight	double	O peso numérico do produto medido em unidades definidas em unidade de peso do item. O valor padrão é null. 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 é null.
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 é null. Se definido, o valor deve ser maior que 0.
Largura do item	item_width	double	A largura numérica do produto medida em unidades definidas na unidade de dimensões do item. O valor padrão é null. Se definido, o valor deve ser maior que 0.
Altura do artigo	item_height	double	O comprimento numérico do produto medido em unidades definidas na unidade de dimensões do item. O valor padrão é null. 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 é null.
É privado	is_private	boolean	Quando verdadeiro, este é um anúncio privado destinado a um comprador específico e escondido da visualização da loja.
Recipient	recipient	Recipient	Uma cadeia de caracteres enumerada indicando uma pessoa para quem este produto faria um presente apropriado. O valor padrão é null.
Ocasião	occasion	Occasion	Uma cadeia de caracteres enumerada indicando uma ocasião para a qual este produto faria um presente apropriado. O valor padrão é null.
Estilo	style	array of string	Uma matriz de cadeias de caracteres de estilo para esta listagem, cada uma das quais é cadeia de texto de forma livre, como Formal ou Steampunk. Um anúncio pode ter até dois estilos. As cadeias 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 é null.
Dados de arquivo	file_data	string	Uma cadeia de caracteres que descreve os arquivos anexados a uma listagem digital.
Tem variações	has_variations	boolean	Quando verdadeiro, o anúncio tem variações.
Deve renovar automaticamente	should_auto_renew	boolean	Quando verdadeiro, renova uma listagem por quatro meses após a exprição. Se definido como true quando anteriormente falso, etsy.com renova o anúncio antes que ele expire, mas o período de renovação começa imediatamente, em vez de estender a data de expiração do anúncio. Qualquer tempo não utilizado restante no anúncio é perdido. As renovações resultam em cobranças na conta do usuário.
Linguagem	language	string	A marca de idioma IETF para o idioma padrão da listagem. Ex: de, en, , es, fr, jait, nl, , ptpl, ru.
Dinheiro	price	Money	Uma representação de uma quantia de dinheiro.
ID da taxonomia	taxonomy_id	integer	O ID de taxonomia numérica da listagem. O vendedor gere os IDs de taxonomia de listagem para a sua loja. Consulte a taxonomia do vendedor para obter mais informações.

Dinheiro

Uma representação de uma quantia de dinheiro.

Name	Caminho	Tipo	Description
Montante	amount	integer	A quantidade de representado por esses dados.
Divisor	divisor	integer	O divisor para renderizar o montante.
Código de Moeda	currency_code	string	O código de moeda ISO para esses dados.

ShopListingFile

Um arquivo associado a uma listagem digital.

Name	Caminho	Tipo	Description
ID do arquivo de listagem	listing_file_id	integer	A ID numérica exclusiva de um arquivo associado a uma listagem digital.
ID do anúncio	listing_id	integer	O ID numérico da listagem associada a esta transação.
Classificação	rank	integer	O índice numérico da posição da ordem de exibição deste arquivo na listagem, começando em 1.
Nome do ficheiro	filename	string	A cadeia de caracteres de nome de arquivo para um arquivo associado a uma listagem digital.
Tamanho do ficheiro	filesize	string	Uma cadeia de caracteres de tamanho de formato legível por humanos para o tamanho de um arquivo.
Tamanho em bytes	size_bytes	integer	Um número que indica o tamanho de um ficheiro, medido em bytes.
Tipo de ficheiro	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.

ShopListingArquivos

Representa vários ShopListingFiles.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de ShopListingFiles que estão sendo retornados..
Results	results	array of ShopListingFile	Uma matriz de recursos ShopListingFile.

Listas de compras

Um conjunto de recursos de listagem de lojas.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de recursos de listagem de lojas encontrados.
Results	results	array of ShopListing	Os recursos de listagem de lojas encontrados.

User

Representa um único usuário do site

Name	Caminho	Tipo	Description
ID de utilizador	user_id	integer	A ID numérica de um usuário. Este número é também um ID de loja válido para a loja do utilizador.
Nome de login	login_name	string	A cadeia de caracteres do nome de login do usuário.
E-mail Principal	primary_email	string	Uma cadeia de caracteres de endereço de e-mail para o endereço de e-mail principal do usuário.
Nome Próprio	first_name	string	O primeiro nome do usuário.
Apelido	last_name	string	O sobrenome do usuário.
Carimbo de data/hora criado	create_timestamp	integer	A data e hora em que o utilizador criou a sua conta, em segundos de época.
Referenciado por ID de Utilizador	referred_by_user_id	integer	O ID numérico do usuário que encaminhou esse usuário.
Usar novos pontos de extremidade de inventário	use_new_inventory_endpoints	boolean	Deprecated. Sempre verdade.
É vendedor	is_seller	boolean	True se o usuário for vendedor.
Biografia	bio	string	A biografia do utilizador.
Sexo	gender	string	O sexo do utilizador.
Mês de Nascimento	birth_month	string	O mês de nascimento do utilizador.
Data de Nascimento	birth_day	string	O dia de 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.

Loja

Uma loja criada por um utilizador Etsy.

Name	Caminho	Tipo	Description
ID da loja	shop_id	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID de utilizador	user_id	integer	O ID de utilizador numérico do utilizador proprietário desta loja.
Nome da loja	shop_name	string	A cadeia de caracteres do nome da loja.
Data de criação	create_date	integer	A data e hora em que esta loja foi criada, em segundos de época.
Title	title	string	Uma breve sequência de cabeçalho para a página principal da loja.
Anúncio	announcement	string	Uma sequência de anúncios para os compradores que é exibida na página inicial da loja.
Código de Moeda	currency_code	string	O código ISO (alfabético) para a moeda da loja. A loja exibe todos os preços nesta moeda por padrão.
Está de férias	is_vacation	boolean	Quando verdadeiro, 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 concluem uma compra nesta loja.
Mensagem de venda digital	digital_sale_message	string	Uma cadeia de caracteres de mensagem enviada aos usuários que compram um item digital nesta loja.
Data de atualização	update_date	integer	A data e hora da última atualização da loja, em segundos de época.
Contagem de anúncios ativos	listing_active_count	integer	O número de anúncios ativos na loja.
Contagem de anúncios digitais	digital_listing_count	integer	O número de anúncios digitais na loja.
Nome de login	login_name	string	A cadeia de caracteres do nome de login do proprietário da loja.
Aceita Pedidos Personalizados	accepts_custom_requests	boolean	Quando verdadeiro, a loja aceita pedidos de personalização.
Política de Boas Vindas	policy_welcome	string	A string 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 de atualização da política	policy_update_date	integer	A data e hora da última atualização das políticas da loja, em segundos de época.
Tem Política de Recebimento Privado	policy_has_private_receipt_info	boolean	Quando verdadeiros, os recibos da UE exibem informações privadas.
Tem políticas não estruturadas	has_unstructured_policies	boolean	Quando verdadeiro, a loja exibe campos de política não estruturados adicionais.
Política de Privacidade	policy_privacy	string	A cadeia de caracteres da política de privacidade da loja (pode estar em branco).
Resposta automática de férias	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 para esta loja.
URL da imagem do banner	image_url_760x100	string	A cadeia de caracteres de URL para a imagem de banner desta loja.
Número de Favorecidos	num_favorers	integer	O número de usuários que marcaram esta loja como favorito.
Languages	languages	array of string	Uma lista de cadeias de caracteres de idioma para os idiomas inscritos na loja.
URL da imagem do ícone	icon_url_fullxfull	string	A cadeia de caracteres de URL para a imagem do ícone desta loja.
Está usando políticas estruturadas	is_using_structured_policies	boolean	Quando verdadeiro, a loja aceitou usando políticas estruturadas.
Integrou políticas estruturadas	has_onboarded_structured_policies	boolean	Quando verdadeiro, a loja aceitou OU recusou depois de visualizar as políticas estruturadas de integração.
Incluir link do formulário de disputa	include_dispute_form_link	boolean	Quando verdadeiras, as políticas desta loja incluem uma ligação para um formulário de litígio em linha da UE.
É checkout direto a bordo	is_direct_checkout_onboarded	boolean	Quando for verdade, a loja integrou a Etsy Payments.
O envio calculado é elegível	is_calculated_eligible	boolean	Quando verdadeiro, a loja é elegível para perfis de envio calculados. (Disponível apenas nos EUA e Canadá)
É Optado pela Promessa do Comprador	is_opted_in_to_buyer_promise	boolean	Quando verdadeiro, a loja optou pela promessa do comprador.
Está sediado nos EUA	is_shop_us_based	boolean	Quando é 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 a partir da ISO do país	shipping_from_country_iso	string	O país iso a loja está enviando de.
Localização da Loja ISO	shop_location_country_iso	string	O país iso onde a loja está localizada.
Contagem de avaliações	review_count	integer	Número de avaliações de anúncios de lojas no ano passado.
Média de avaliações	review_average	double	Avaliação média com base nas avaliações dos anúncios de lojas no ano passado.

ListagemImagem

Referenciar urls e metadados para uma imagem associada a uma listagem específica. O url_fullxfull parâmetro contém a URL para o arquivo de imagem binária de tamanho normal.

Name	Caminho	Tipo	Description
ID do anúncio	listing_id	integer	O ID numérico da listagem associada a esta transação.
ID da imagem do anúncio	listing_image_id	integer	A ID numérica da imagem de listagem principal para esta transação.
Código hexadecimal	hex_code	string	A string webhex para a cor média da imagem, em notação webhex.
Valor vermelho	red	integer	O valor numérico vermelho igual ao valor vermelho médio da imagem, de 0-255 (cor RGB).
Valor Verde	green	integer	O valor numérico vermelho igual ao valor vermelho médio da imagem, de 0-255 (cor RGB).
Valor azul	blue	integer	O valor numérico vermelho igual ao valor vermelho médio da imagem, de 0-255 (cor RGB).
Valor de matiz	hue	integer	A tonalidade numérica igual à tonalidade média da imagem, de 0-360 (cor HSV).
Valor de saturação	saturation	integer	A saturação numérica é igual à saturação média da imagem, de 0-100 (cor HSV).
Valor de brilho	brightness	integer	O brilho numérico igual ao brilho médio da imagem, de 0-100 (cor HSV).
É preto e branco	is_black_and_white	boolean	Quando verdadeira, a imagem está em preto ou branco.
Tempo de Criação	creation_tsz	integer	O tempo de criação da imagem do anúncio, 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 url para uma miniatura de 75x75 pixels da imagem.
URL da imagem 170x135	url_170x135	string	A cadeia de caracteres url para uma miniatura de 170x135 pixels da imagem.
URL da imagem 570xN	url_570xN	string	A cadeia de caracteres url para uma miniatura da imagem, não mais de 570 pixels de largura com altura variável.
URL da imagem em tamanho normal	url_fullxfull	string	A cadeia de caracteres url para a imagem em tamanho normal, até 3000 pixels em cada dimensão.
Altura da imagem em tamanho normal	full_height	integer	A altura numérica, medida em pixels, da imagem em tamanho real referenciada em url_fullxfull.
Largura da imagem em tamanho real	full_width	integer	A largura numérica, medida em pixels, da imagem em tamanho real referenciada em url_fullxfull.

ListagemImagens

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

Name	Caminho	Tipo	Description
Contar	count	integer	O número de resultados.
Results	results	array of ListingImage	A lista de recursos solicitados.

ListagemInventárioComAssociações

Uma representação do registro de inventário de um único anúncio com associações

Name	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 de ID de propriedade de listagem exclusivos para as propriedades que alteram os preços dos produtos, se houver. Por exemplo, se você cobrar preços específicos para produtos de tamanhos diferentes na mesma listagem, essa matriz conterá o ID da propriedade para o tamanho.
Quantidade em propriedades	quantity_on_property	array of integer	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram a quantidade dos produtos, se houver. Por exemplo, se você armazenar quantidades específicas de produtos coloridos diferentes na mesma listagem, essa matriz conterá a ID da propriedade para a cor.
Propriedades de SKU On	sku_on_property	array of integer	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram a SKU do produto, se houver. Por exemplo, se você usar skus específicos para produtos coloridos diferentes na mesma listagem, essa matriz conterá o ID da propriedade para a cor.
Listagem de lojas	listing	ShopListing	Uma listagem de uma loja, que contém uma quantidade de produto, título, descrição, preço, etc.

ListagemInventárioProduto

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

Name	Caminho	Tipo	Description
ID do produto	product_id	integer	A ID numérica de um produto específico comprado de um anúncio.
SKU	sku	string	A cadeia de caracteres SKU para o produto
É suprimido	is_deleted	boolean	Quando verdadeiro, alguém excluiu este produto.
Offerings	offerings	array of ListingInventoryProductOffering	Uma lista de entradas de oferta de produtos para este produto.
Valores de propriedade	property_values	array of ListingPropertyValue	Uma lista de entradas de valor de propriedade para este produto.

ListagemInventárioProdutoOferta

Uma representação de uma oferta para um anúncio.

Name	Caminho	Tipo	Description
ID da oferta	offering_id	integer	O ID da oferta de produto
Quantidade	quantity	integer	A quantidade que o produto oferece
Está ativado	is_enabled	boolean	Se a oferta pode ou não ser mostrada aos compradores.
É suprimido	is_deleted	boolean	Se a oferta foi ou não excluída.
Dinheiro	price	Money	Uma representação de uma quantia de dinheiro.

ListingPropertyValue

Uma representação de valores de dados estruturados.

Name	Caminho	Tipo	Description
ID da Propriedade	property_id	integer	A ID numérica da propriedade.
Nome	property_name	string	O nome da propriedade.
ID da escala	scale_id	integer	O ID numérico da escala (se houver).
Nome da escala	scale_name	string	O rótulo utilizado para descrever a escala escolhida (se for caso disso).
IDs de valor	value_ids	array of integer	As IDs numéricas dos valores de propriedade
Valores	values	array of string	Os valores da propriedade

ListagemInventário

Uma representação do registro de inventário de um único anúncio.

Name	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 de ID de propriedade de listagem exclusivos para as propriedades que alteram os preços dos produtos, se houver. Por exemplo, se você cobrar preços específicos para produtos de tamanhos diferentes na mesma listagem, essa matriz conterá o ID da propriedade para o tamanho.
Quantidade em propriedades	quantity_on_property	array of integer	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram a quantidade dos produtos, se houver. Por exemplo, se você armazenar quantidades específicas de produtos coloridos diferentes na mesma listagem, essa matriz conterá a ID da propriedade para a cor.
Propriedades de SKU On	sku_on_property	array of integer	Uma matriz de inteiros de ID de propriedade de listagem exclusivos para as propriedades que alteram a SKU do produto, se houver. Por exemplo, se você usar skus específicos para produtos coloridos diferentes na mesma listagem, essa matriz conterá o ID da propriedade para a cor.

ShopListingsComAssociações

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

Name	Caminho	Tipo	Description
Contar	count	integer	O número de recursos de listagem de lojas encontrados.
Results	results	array of ShopListing	Os recursos de listagem de lojas encontrados.

ListingPropertyValues

Representa vários valores de propriedade de listagem.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de recursos de listagem de lojas encontrados.
Results	results	array of ListingPropertyValue	Os recursos de listagem de lojas encontrados.

ShopReceiptTransactions

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

Name	Caminho	Tipo	Description
Contar	count	integer	O número de recursos de transação de recibo de loja encontrados.
Results	results	array of ShopReceiptTransaction	Os recursos de transação de recibo de 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.

Name	Caminho	Tipo	Description
ID da transação	transaction_id	integer	O ID numérico exclusivo para 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 de utilizador do vendedor	seller_user_id	integer	O ID de utilizador numérico do vendedor nesta transação.
ID de utilizador do comprador	buyer_user_id	integer	O ID de 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	Data e hora de pagamento da transação, em segundos de época.
Carimbo de data/hora enviado	shipped_timestamp	integer	Data e hora de envio da transação, em segundos de época.
Quantidade	quantity	integer	A quantidade numérica de produtos comprados nesta transação.
ID da imagem do anúncio	listing_image_id	integer	A ID numérica da imagem de listagem principal para esta transação.
ID do recibo	receipt_id	integer	A ID numérica do recibo associado a esta transação.
É digital	is_digital	boolean	Quando verdadeira, a transação registrava a compra de uma listagem digital.
Dados de arquivo	file_data	string	Uma cadeia de caracteres que descreve os arquivos comprados nesta transação.
ID do anúncio	listing_id	integer	O ID numérico da listagem associada a esta transação.
Tipo de Operaçã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 um anúncio.
Dinheiro	price	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	shipping_cost	Money	Uma representação de uma quantia de dinheiro.

ListagemTradução

Representa os dados de tradução de um anúncio.

Name	Caminho	Tipo	Description
ID do anúncio	listing_id	integer	O ID numérico do anúncio.
Linguagem	language	string	A marca de idioma IETF (por exemplo, 'fr') para o idioma desta 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 tags da Listagem desta Tradução.

ListagemVariaçãoImagens

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

Name	Caminho	Tipo	Description
Contar	count	integer	A contagem de imagens de variação.
Results	results	array of ListingVariationImage	Os resultados das imagens de variação.

ListagemVariaçãoImagem

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

Name	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 contábil de contas de pagamento

Name	Caminho	Tipo	Description
Contar	count	integer	O número de recursos de entrada no razão da conta de pagamento encontrados.
Results	results	array of PaymentAccountLedgerEntry	Os recursos de entrada no razão da conta de pagamento encontrados.

PaymentAccountLedgerEntry

Representa uma entrada no livro razão de uma loja.

Name	Caminho	Tipo	Description
ID de entrada	entry_id	integer	A ID numérica da entrada contábil.
ID do livro-razão	ledger_id	integer	ID numérico do livro-razão.
Número de sequência	sequence_number	integer	A sequência permite que as entradas do livro razão sejam ordenadas cronologicamente. Quanto maior a sequência, mais recente a entrada.
Montante	amount	integer	A quantidade de dinheiro creditada no livro-razão.
Moeda	currency	string	A moeda da entrada no livro-razão.
Description	description	string	Detalha que tipo de entrada contábil é: um pagamento, reembolso, reversão de um reembolso falhado, desembolso, desembolso devolvido, recuperação, crédito diverso, débito diverso ou pagamento de fatura.
Equilíbrio	balance	integer	A quantidade de dinheiro no livro razão da loja no momento após esta entrada foi aplicada.
Data de criação	create_date	integer	A data e a hora em que a entrada contábil foi criada em segundos de época.

Payments

Representa vários pagamentos feitos com Etsy Payments. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de pagamentos na resposta.
Results	results	array of Payment	Uma lista de pagamentos.

Pagamento

Representa um pagamento feito com o Etsy Payments. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

Name	Caminho	Tipo	Description
ID de pagamento	payment_id	integer	Um ID numérico exclusivo para um pagamento a uma loja Etsy específica.
ID de utilizador do comprador	buyer_user_id	integer	O ID numérico do usuário que pagou a compra.
ID da loja	shop_id	integer	O ID numérico positivo único diferente de zero para uma Loja Etsy.
ID do recibo	receipt_id	integer	A ID numérica do recibo associado a esta transação.
Dinheiro	amount_gross	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	amount_fees	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	amount_net	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	posted_gross	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	posted_fees	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	posted_net	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	adjusted_gross	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	adjusted_fees	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	adjusted_net	Money	Uma representação de uma quantia de dinheiro.
Moeda	currency	string	A cadeia de código ISO (alfabética) para a moeda do pagamento.
Comprar moeda	shop_currency	string	O código ISO (alfabético) para a moeda da loja. A loja exibe todos os preços nesta moeda por padrão.
Moeda do comprador	buyer_currency	string	A cadeia de moedas do comprador.
ID de envio do usuário	shipping_user_id	integer	O ID numérico do utilizador para o qual o vendedor envia a encomenda.
ID da morada de envio	shipping_address_id	integer	O ID numérico que identifica o endereço de entrega.
ID do Endereço de Faturação	billing_address_id	integer	O ID numérico 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	Data e 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 ao ajuste de pagamento em segundos de época.
Ajustes de Pagamento	payment_adjustments	array of PaymentAdjustment	Lista de objetos de reembolso em uma transação do Etsy Payments. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

PaymentAdjustment

Representa um reembolso, que se aplica a um pagamento Etsy anterior. Todos os montantes monetários são expressos em tostões de USD, salvo indicação em contrário.

Name	Caminho	Tipo	Description
ID de Ajuste de Pagamento	payment_adjustment_id	integer	O ID numérico para um ajuste de pagamento.
ID de pagamento	payment_id	integer	Um ID numérico exclusivo para um pagamento a uma loja Etsy específica.
Situação	status	string	A cadeia de status do ajuste de pagamento.
É sucesso	is_success	boolean	Quando verdadeiro, o ajuste de pagamento foi ou é provável que seja concluído com sucesso.
ID de utilizador	user_id	integer	O ID numérico do usuário (vendedor) que realiza a compra.
Código da razão	reason_code	string	Uma string legível por humanos descrevendo o motivo do reembolso.
Montante total do ajustamento	total_adjustment_amount	integer	O valor numérico total do reembolso na moeda de pagamento.
Valor total de ajuste da loja	shop_total_adjustment_amount	integer	O valor numérico do reembolso na moeda da loja.
Montante total do ajustamento	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	O valor numérico das 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 ao ajuste de pagamento em segundos de época.

Pong

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

Name	Caminho	Tipo	Description
ID da aplicação	application_id	integer	ID do aplicativo autenticado

ShopReceipt

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

Name	Caminho	Tipo	Description
ID do recibo	receipt_id	integer	A ID numérica do recibo associado a esta transação.
Tipo de recibo	receipt_type	integer	O valor numérico para o canal Etsy que atendeu a compra: 0 para Etsy.com, 1 para uma loja Pattern.
ID de utilizador do vendedor	seller_user_id	integer	O ID numérico do usuário (vendedor) que realiza a compra.
Endereço de e-mail do vendedor	seller_email	string	A cadeia de caracteres de endereço de e-mail do vendedor do anúncio.
ID de utilizador do comprador	buyer_user_id	integer	O ID numérico do usuário que faz a compra.
Endereço de e-mail do comprador	buyer_email	string	A cadeia de caracteres de endereço de e-mail para o comprador do anúncio.
Nome	name	string	A cadeia de caracteres de nome do destinatário no endereço de entrega.
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 entrega.
Segunda linha de endereço	second_line	string	A segunda cadeia de caracteres de linha de endereço opcional para o destinatário no endereço de entrega.
City	city	string	A cadeia de caracteres de cidade para o destinatário no endereço de entrega.
Estado	state	string	A cadeia de caracteres de estado para o destinatário no endereço de entrega.
Código Postal	zip	string	A string do código postal (não necessariamente um número) para o destinatário no endereço de entrega.
Endereço formatado	formatted_address	string	A cadeia de caracteres de endereço de entrega formatada para o destinatário no endereço de entrega.
Código do país ISO	country_iso	string	A cadeia de código de país ISO-3166 alpha-2 para o destinatário no endereço de entrega.
Método de Pagamento	payment_method	string	A cadeia de caracteres do método de pagamento que identifica o método de pagamento do comprador, que deve ser um dos seguintes: 'cc' (cartão de crédito), 'PayPal', 'cheque', 'mo' (ordem de pagamento), 'bt' (transferência bancária), 'outro', 'ideal', 'sofort', 'apple_pay', 'google', 'android_pay', 'google_pay', 'klarna', 'k_pay_in_4' (klarna) ou 'k_financing' (klarna).
Endereço de e-mail de pagamento	payment_email	string	A cadeia de caracteres de endereço de e-mail para o endereço de e-mail 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 pela máquina do sistema de pagamento.
É pago	is_paid	boolean	Quando verdadeiro, o comprador pagou por esta 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 do recibo, em segundos de época.
Mensagem de presente	gift_message	string	Uma sequência de mensagens de presente que o comprador solicita entregue com o produto.
Dinheiro	grandtotal	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	subtotal	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	total_price	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	total_shipping_cost	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	total_tax_cost	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	total_vat_cost	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	discount_amt	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	gift_wrap_price	Money	Uma representação de uma quantia de dinheiro.
Envios	shipments	array of ShopReceiptShipment	Uma lista de declarações de envio para este recibo.

ShopReceiptRemessa

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

Name	Caminho	Tipo	Description
ID de envio do recibo	receipt_shipping_id	integer	O ID numérico exclusivo de um registro de remessa de recebimento de loja.
Carimbo de data/hora da notificação de remessa	shipment_notification_timestamp	integer	O momento em que a Etsy notificou o comprador do evento de envio, em segundos de época.
Nome da transportadora	carrier_name	string	A cadeia de caracteres do nome da transportadora/empresa responsável pela entrega da remessa.
Código de rastreamento	tracking_code	string	A cadeia de caracteres do código de rastreamento fornecida pela transportadora/empresa para a remessa.

ShopReceipts

Os recibos de uma Loja específica.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de Recibos de Loja encontrados.
Results	results	array of ShopReceipt	Lista de recursos de Recibo de Loja encontrados, com todos os campos de Recibo de Loja para cada recurso.

TransactionReviews

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

Name	Caminho	Tipo	Description
Contar	count	integer	O número de recursos TransactionReview encontrados.
Results	results	array of TransactionReview	Os recursos TransactionReview encontrados.

Revisão de transações

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

Name	Caminho	Tipo	Description
ID da loja	shop_id	integer	ID numérico da loja.
ID do anúncio	listing_id	integer	O ID da listagem da loja à qual o TransactionReview pertence.
ID de utilizador do comprador	buyer_user_id	integer	O ID numérico do usuário que foi o comprador nesta transação. Nota: Este campo pode estar ausente, dependendo das configurações de privacidade do comprador.
Rating	rating	integer	Valor da classificação na escala de 1 a 5
Mensagem de revisão	review	string	Uma mensagem deixada pelo autor, explicando o feedback.
Linguagem	language	string	O idioma do TransactionReview
URL da imagem em tamanho real	image_url_fullxfull	string	O url para uma foto fornecida com o feedback, dimensões fullxfull. Nota: Este 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.

VendedorTaxonomiaNós

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

Name	Caminho	Tipo	Description
Contar	count	integer	O número de resultados.
Results	results	array of SellerTaxonomyNode	A lista de recursos solicitados.

VendedorTaxonomyNode

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

Name	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 sapatos (ID: 1429, nível: 1) é mais alto na hierarquia do que os sapatos de meninas (ID: 1440, nível: 2). Os nós de taxonomia atribuídos a uma listagem suportam o acesso a escalas e propriedades de produtos padronizados específicos. Por exemplo, as listagens atribuídas aos nós de taxonomia sapatos ou sapatos femininos suportam o acesso à escala de tamanhos de sapatos da UE com seus nomes de propriedade associados e IDs para tamanhos de sapatos da UE, como propriedade value_id:1394 e name:38.
Nível	level	integer	A profundidade inteira deste 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 do pai	parent_id	integer	A ID de taxonomia numérica do pai deste nó.
Subordinados	children	array of SellerTaxonomyNode	Uma matriz de nós de taxonomia para todos os filhos diretos deste nó de taxonomia na árvore de taxanomia do vendedor.
IDs de caminho de 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 da raiz para a folha.

TaxonomyNodeProperties

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

Name	Caminho	Tipo	Description
Contar	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.

Name	Caminho	Tipo	Description
ID da Propriedade	property_id	integer	A ID numérica exclusiva desta 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 de propriedade do produto legível por humanos.
Balanças	scales	array of TaxonomyPropertyScale	Uma lista de escalas disponíveis.
é obrigatório	is_required	boolean	Quando verdadeiro, as listagens atribuídas a IDs de taxonomia elegíveis exigem essa propriedade.
Suporta atributos	supports_attributes	boolean	Quando true, você pode usar essa propriedade na listagem de atributos.
Suporta variações	supports_variations	boolean	Quando verdadeiro, você pode usar essa propriedade em variações de listagem.
É multivalorado	is_multivalued	boolean	Quando true, 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 suportadas para esta propriedade.
Valores Selecionados	selected_values	array of TaxonomyPropertyValue	Uma lista de cadeias de caracteres de valor de propriedade automaticamente e sempre selecionadas para determinada propriedade.

TaxonomiaPropertyScale

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

Name	Caminho	Tipo	Description
ID da 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.

TaxonomiaPropertyValue

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

Name	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 da escala	scale_id	integer	O ID da 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 esse valor de propriedade é igual a (se houver).

TransportadoresTransportadores

Representa vários ShippingCarriers.

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

TransportadoraTransportadora

Uma transportadora suportada, que é usada para calcular uma Data de Entrega Estimada.

Name	Caminho	Tipo	Description
ID da transportadora	shipping_carrier_id	integer	O ID numérico desta transportadora.
Nome	name	string	O nome desta transportadora.
Aulas Domésticas	domestic_classes	array of ShippingCarrierMailClass	Conjunto de classes de correio doméstico desta transportadora.
Aulas Internacionais	international_classes	array of ShippingCarrierMailClass	Conjunto de classes de correio internacional desta transportadora.

ShippingCarrierMailClass

A classe de correio de uma transportadora, que é usada para calcular uma Data de Entrega Estimada.

Name	Caminho	Tipo	Description
ID da classe de correio	mail_class_key	string	O identificador exclusivo desta classe de email.
Nome	name	string	O nome desta classe de email.

Lojas

Um conjunto de registos da loja.

Name	Caminho	Tipo	Description
Contar	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.

Name	Caminho	Tipo	Description
ID da Secção da Loja	shop_section_id	integer	O ID numérico 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 seção exibe a ordem de uma loja, com as seções de classificação 1 aparecendo em primeiro lugar.
ID de utilizador	user_id	integer	O ID numérico do usuário que possui esta seção da loja.
Contagem de anúncios ativos	active_listing_count	integer	O número de anúncios ativos em uma seção de uma loja Etsy específica.

ShopSections

Todas as seções em uma loja precific.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de resultados.
Results	results	array of ShopSection	A lista de recursos solicitados.

ShopShippingPerfil

Representa um perfil usado para definir as informações de envio de um anúncio. Por favor, note que não é possível criar modelos de envio calculados através da API. No entanto, você pode associar perfis de frete calculados criados a partir do Shop Manager a listagens usando a API.

Name	Caminho	Tipo	Description
ID do perfil de envio	shipping_profile_id	integer	O ID numérico do perfil de envio.
Title	title	string	A cadeia de caracteres de nome deste perfil de envio.
ID de utilizador	user_id	integer	A ID numérica do 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 o anúncio.
Dias máximos de processamento	max_processing_days	integer	O número máximo de dias para processar o anúncio.
Etiqueta dos Dias de Processamento	processing_days_display_label	string	Cadeia de caracteres de etiqueta 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 a partir do qual a lista é enviada.
É suprimido	is_deleted	boolean	Quando verdadeiro, alguém excluiu esse perfil de envio.
Destinos do Perfil de Envio	shipping_profile_destinations	array of ShopShippingProfileDestination	Uma lista de destinos de perfil de envio disponíveis para este 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 este perfil de envio.
Código Postal de Origem	origin_postal_code	string	A cadeia de caracteres do código postal (não necessariamente um número) para o local a partir do qual a listagem é enviada.
Tipo de perfil	profile_type	ProfileType

LojaEnvioPerfilDestino

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

Name	Caminho	Tipo	Description
ID de destino do perfil de envio	shipping_profile_destination_id	integer	O ID numérico do destino do perfil de envio no perfil de envio associado ao anúncio.
ID do perfil de envio	shipping_profile_id	integer	O ID numérico do perfil de envio.
ISO do país de origem	origin_country_iso	string	O código ISO do país a partir do qual a lista é enviada.
ISO do país de destino	destination_country_iso	string	O código ISO do país para o qual a lista é enviada. Se nulo, a solicitação define o destino como destination_region
DestinoRegião	destination_region	DestinationRegion	O código da região para a qual a listagem é enviada. Uma região representa um conjunto de países. As regiões apoiadas são a União Europeia e a União Não Europeia (países da Europa que não pertencem à UE). Se nenhum, a solicitação define o destino como destination_country_iso ou em qualquer lugar se destination_country_iso também for nulo
Dinheiro	primary_cost	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	secondary_cost	Money	Uma representação de uma quantia de dinheiro.
ID da transportadora	shipping_carrier_id	integer	O ID exclusivo de uma transportadora suportada, que é usado para calcular uma Data de Entrega Estimada.
Classe Mail	mail_class	string	A cadeia de caracteres de ID exclusiva da classe de correio 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 o item comprado depois de 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 o item comprado depois de enviado.

ShopShippingProfileUpgrade

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

Name	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 remessa
Nome da atualização	upgrade_name	string	Nome da atualização de envio mostrada aos compradores no checkout, por exemplo, USPS Priority.
Tipo	type	Type	O tipo de atualização de envio. Doméstica (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.
Dinheiro	price	Money	Uma representação de uma quantia de dinheiro.
Dinheiro	secondary_price	Money	Uma representação de uma quantia de dinheiro.
ID da transportadora	shipping_carrier_id	integer	O ID exclusivo de uma transportadora suportada, que é usado para calcular uma Data de Entrega Estimada.
Classe Mail	mail_class	string	A cadeia de caracteres de ID exclusiva da classe de correio 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 o item comprado depois de 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 o item comprado depois de enviado.

LojaEnvioPerfilDestinos

Representa uma lista de objetos de destino de remessa.

Name	Caminho	Tipo	Description
Contar	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.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de resultados.
Results	results	array of ShopShippingProfileUpgrade	A lista de recursos solicitados.

Endereço do usuário

Representa o endereço de um usuário.

Name	Caminho	Tipo	Description
ID do Endereço do Utilizador	user_address_id	integer	O ID numérico do endereço do usuário.
ID de utilizador	user_id	integer	O ID numérico 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 código postal do endereço do usuário.
Código do país ISO	iso_country_code	string	O código ISO do país neste endereço.
Country	country_name	string	O nome do país do usuário.
É o endereço de envio padrão	is_default_shipping_address	boolean	Este é o endereço de envio padrão do usuário.

Endereços de usuário

Representa vários registros UserAddress.

Name	Caminho	Tipo	Description
Contar	count	integer	O número de registros UserAddress que estão sendo retornados.
Results	results	array of UserAddress	Uma matriz de recursos UserAddress.

DestinoRegião

O código da região para a qual a listagem é enviada. Uma região representa um conjunto de países. As regiões apoiadas são a União Europeia e a União Não Europeia (países da Europa que não pertencem à UE). Se nenhum, a solicitação define o destino como destination_country_iso ou em qualquer lugar se destination_country_iso também for nulo

O código da região para a qual a listagem é enviada. Uma região representa um conjunto de países. As regiões apoiadas são a União Europeia e a União Não Europeia (países da Europa que não pertencem à UE). Se nenhum, a solicitação define o destino como destination_country_iso ou em qualquer lugar se destination_country_iso também for nulo

DestinoRegião

string

ItemDimensionsUnit

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

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

ItemDimensionsUnit

string

ItemWeightUnit

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

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

ItemWeightUnit

string

Ocasião

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

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

Ocasião

string

Tipo de perfil

Tipo de perfil

string

Recipient

Uma cadeia de caracteres enumerada indicando uma pessoa para quem este produto faria um presente apropriado. O valor padrão é null.

Uma cadeia de caracteres enumerada indicando uma pessoa para quem este produto faria um presente apropriado. O valor padrão é null.

Recipient

string

Estado

Uma cadeia de caracteres enumerada de qualquer um: ativo ou inativo. Nota: Definir um rascunho de listagem como ativo também publicará o anúncio no etsy.com.

Uma cadeia de caracteres enumerada de qualquer um: ativo ou inativo. Nota: Definir um rascunho de listagem como ativo também publicará o anúncio no etsy.com.

Estado

integer

Tipo

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

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

Tipo

integer

QuandoMade

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

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

QuandoMade

string

Quem Fez

Uma cadeia de caracteres enumerada iniciou quem criou o produto. Ajuda os compradores a localizar o anúncio sob o título Handmade. Requer 'is_supply' e 'when_made'.

Uma cadeia de caracteres enumerada iniciou quem criou o produto. Ajuda os compradores a localizar o anúncio sob o título Handmade. Requer 'is_supply' e 'when_made'.

Quem Fez

string