Ir para o conteúdo

Detalhes da Conexão do Ebay

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8257 do conector.

Começando

Suporte à versão do eBay

O conector permite uma visualização relacional de entidades das APIs Trading, FileTransfer, BulkData, Feedback e Merchandising.

Estabelecendo uma Conexão

Conectando-se às APIs do Ebay

Por padrão, o conector se conecta a ambientes de produção. Definir UseSandbox para true para usar uma conta sandbox do eBay.

Autenticação no Ebay

O eBay usa o padrão de autenticação OAuth 2.0 e o Auth'n'Auth, a autenticação tradicional usada pelas APIs do eBay. Para autenticar usando OAuth ou Auth'n'Auth, dependendo de como seu aplicativo está configurado, você precisará criar um aplicativo para obter o OAuthClientId, OAuthClientSecret, DevID, e CallbackURL propriedades de conexão. Consulte Usando autenticação OAuth para obter um guia de autenticação.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o eBay usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Personalizadas

Você precisará registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Personalizadas

Autenticação de Área de Trabalho com Seu Aplicativo OAuth

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha um Token de Acesso OAuth

Depois de definir o seguinte, você está pronto para se conectar:

  • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
  • CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
  • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken..

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

  1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
  2. Obtém um novo token de acesso quando o antigo expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Usando OAuth em uma Máquina Sem Cabeça

Para criar fontes de dados do eBay em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa se autenticar em outra máquina. A autenticação é um processo de duas etapas.

  1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
  2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um aplicativo OAuth personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

  • InitiateOAuth: Defina como DESLIGADO.
  • OAuthClientId: Defina isso como o ID do aplicativo nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o Segredo do aplicativo nas configurações do aplicativo.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

  1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
  2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
  3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
  • OAuthVerifier: Defina isso para o código do verificador.
  • OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
  • InitiateOAuth: Configure para ATUALIZAR.

Conecte-se aos dados

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

  • OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
  • InitiateOAuth: Configure para ATUALIZAR.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

  • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
  • InitiateOAuth: Defina como GETANDREFRESH.
  • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
  • CallbackURL: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

  • InitiateOAuth: Configure para ATUALIZAR.
  • OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Criando um Aplicativo OAuth Personalizado

Existem dois métodos de autenticação disponíveis para se conectar ao eBay: Usando um token gerado para acessar apenas dados pessoais ou usando tokens que permitem que outros usuários acessem seus próprios dados. Ambos os métodos exigem que você participe do Programa de Desenvolvedores do eBay.

Registre-se e Obtenha Suas Chaves

Depois de ingressar no Programa de Desenvolvedores do eBay, você pode obter os seguintes valores na página Chaves do aplicativo (Minha conta -> Chaves de acesso ao aplicativo).

  1. OAuthClientId (ID do aplicativo)
  2. DevID
  3. OAuthClientSecret (ID do certificado)
Usando um Token Pessoal

Se você estiver trabalhando com sua própria conta, siga as etapas abaixo para gerar um token:

  1. Acesse o Painel da sua conta de desenvolvedor e abra a página Chaves do aplicativo.

  2. Na linha App ID (Client ID) para o conjunto de chaves que você deseja usar, clique em User Tokens.

    Use as chaves de produção se estiver procurando por itens reais ou listando itens reais no site do eBay ao vivo. Use as chaves do sandbox se estiver criando listagens de teste no sandbox.

  3. Clique em Obter um token de usuário aqui e faça login com credenciais para sua caixa de proteção ou conta de produção do eBay. Certifique-se também de definir 'Sua URL aceita de autenticação' como sua URL de retorno de chamada preferida. Como o eBay requer um URI de redirecionamento seguro (https), para aplicativos de desktop, você pode definir isso para: https://localhost:33333 ou para https://oauth.cdata.com/oauth/ para aplicativos da Web.

Observação: Para ativar a autenticação OAuth 2.0, você deve marcar a caixa de seleção 'OAuth ativado' na aba aberta 'Suas configurações de login do eBay '. Se não estiver ativado, apenas o método de autenticação Auth'N'Auth será suportado.

Você pode então definir as seguintes propriedades de conexão e conectar:

  • DevID: Defina isso como o ID do desenvolvedor do seu conjunto de chaves.
  • OAuthClientId: Defina isso para o ID do aplicativo (ID do cliente) do seu conjunto de chaves.
  • OAuthClientSecret: Defina isso como o ID do certificado (segredo do cliente) do seu conjunto de chaves.
  • SiteID: Defina isso para o ID do site do eBay. Por padrão, é 0 (o site dos EUA).
  • OAuthAccessToken: Defina isso para o token pessoal que você gerou no painel da sua conta de desenvolvedor.
  • UseSandbox: Defina como verdadeiro se estiver usando uma conta de sandbox.
  • AuthScheme: Defina como "OAuth" se desejar usar OAuth 2.0 como método de autenticação. Se for definido como "AuthNAuth" ou se não for especificado, Auth'n'Auth será usado para autenticar.
  • CallbackURL: Defina para http://localhost:33333 ou outra porta de sua escolha. (Se você não configurou o https://oauth.cdata.com/oauth/ URL de redirecionamento, verifique se você está usando a mesma porta que a URL de redirecionamento configurada em seu aplicativo do eBay )
Obtendo Tokens para Aplicativos com Vários Usuários

O eBay implementa o padrão de autenticação OAuth, que você pode usar para permitir que outros usuários acessem seus próprios dados.

OAuth requer que o usuário autenticado interaja com o eBay usando o navegador. O conector facilita isso de várias maneiras, conforme descrito nas seções a seguir.

Configurar um Aplicativo OAuth

Siga as etapas abaixo para configurar o fluxo de consentimento do usuário:

  1. Acesse o Painel da sua conta de desenvolvedor e abra a página Chaves do aplicativo.
  2. Na linha ID do aplicativo (ID do cliente) do seu aplicativo, clique em Tokens do usuário.
  3. Clique em Obter um token de usuário aqui e faça login com credenciais para sua caixa de proteção ou conta de produção do eBay. Certifique-se também de definir 'Sua URL aceita de autenticação' como sua URL de retorno de chamada preferida. Como o eBay requer um URI de redirecionamento seguro (https), para aplicativos de desktop, você pode definir isso para: https://localhost:33333 ou para https://oauth.cdata.com/oauth/ para aplicativos da Web.

Observação: Para ativar a autenticação OAuth 2.0, você deve marcar a caixa de seleção 'OAuth ativado' na aba aberta 'Suas configurações de login do eBay '. Se não estiver ativado, apenas o método de autenticação Auth'N'Auth será suportado.

Autenticar no Ebay a Partir de um Aplicativo de Desktop

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

  • DevID: Defina isso como o ID do desenvolvedor do seu conjunto de chaves.
  • OAuthClientId: Defina isso para o ID do aplicativo (ID do cliente) do seu conjunto de chaves.
  • OAuthClientSecret: Defina isso como o ID do certificado (segredo do cliente) do seu conjunto de chaves.
  • RuName: Defina isso como o nome da URL de redirecionamento no Token do eBay por meio da seção Aplicativo da página Tokens do usuário.
  • SiteID: Defina isso para o ID do site do eBay. Por padrão, é 0 (o site dos EUA).
  • CallbackURL: Defina para http://localhost:33333 ou outra porta de sua escolha. (Se você não configurou o https://oauth.cdata.com/oauth/ URL de redirecionamento, verifique se você está usando a mesma porta que a URL de redirecionamento configurada em seu aplicativo do eBay )
  • InitiateOAuth: Defina como GETANDREFRESH.
  • UseSandbox: Defina como verdadeiro se estiver usando uma conta de sandbox.
  • AuthScheme: Defina como "OAuth" se desejar usar OAuth 2.0 como método de autenticação. Se for definido como "AuthNAuth" ou se não for especificado, Auth'n'Auth será usado para autenticar.

Quando você se conecta, o conector abre o endpoint OAuth ou Auth and Auth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo de autenticação:

  1. Extrai o token e autentica as solicitações.
  2. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.
Autenticar no Ebay a Partir de um Aplicativo da Web

Para obter o token de acesso, defina as seguintes propriedades de conexão:

  • DevID: Defina isso como o ID do desenvolvedor em seu conjunto de chaves.
  • OAuthClientId: Defina isso para o ID do aplicativo (ID do cliente) em seu conjunto de chaves.
  • OAuthClientSecret: Defina isso como o ID do certificado (segredo do cliente) em seu conjunto de chaves.
  • SiteID: Defina isso para o ID do site do eBay. Por padrão, é 0, (EUA)
  • RuName: Defina isso como o nome da URL de redirecionamento no Token do eBay por meio da seção Aplicativo da página Tokens do usuário.
  • UseSandbox: Defina como verdadeiro se estiver usando uma conta de sandbox.
  • AuthScheme: Defina como "OAuth" se desejar usar OAuth 2.0 como método de autenticação. Se for definido como "AuthNAuth" ou se não for especificado, Auth'n'Auth será usado para autenticar.

Ao conectar por meio de um aplicativo da Web, ou se o conector não estiver autorizado a abrir uma janela do navegador, você precisará trocar um ID de sessão (se estiver usando Auth e Auth como método de autenticação) ou um código verificador (se estiver usando OAuth 2.0) para OAuthAccessToken:

  1. Defina o UseSandbox propriedade de conexão como true se você estiver usando uma conta de sandbox.
  2. Defina o AuthScheme propriedade de conexão para "OAuth" se você quiser usar a autenticação OAuth, ou definir como "AuthNAuth" para usar o Auth'n'Auth para autenticação.
  3. Chame GetOAuthAuthorizationURL. O procedimento armazenado* retorna a URL para o endpoint OAuth.
  4. Faça login e autorize o aplicativo. Você é redirecionado de volta para o URL de retorno de chamada.
  5. Chame GetOAuthAccessToken. Defina o parâmetro AuthMode como "WEB". Se você estiver usando OAuth para autenticar, defina o valor do Verifier para o valor do código retornado na etapa anterior. Caso contrário, se você estiver usando Auth e Auth, defina o parâmetro SessionId para o parâmetro SessionId retornado na string de consultar da URL de retorno de chamada da etapa anterior.

Para fazer solicitações ao eBay, defina o OAuthAccessToken retornado além das propriedades de conexão anteriores. Definir InitiateOAuth para REFRESH para atualizar automaticamente o token de acesso quando ele expirar.

Anotações Importantes

Procedimentos Armazenados

  • Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
  • Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.

Arquivos de Configuração e Seus Caminhos

  • Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector eBay.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for eBay permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

  • Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
  • declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

  • Cada elemento raiz define o nome de uma visualização.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM ItemListing WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Jitterbit Connector for eBay modela entidades na API do eBay como tabelas, exibições e procedimentos armazenados. Eles são definidos em arquivos de esquema, que são arquivos de configuração simples baseados em texto.

As limitações e requisitos da API estão documentados nesta seção; você pode usar o SupportEnhancedSQL recurso, definido por padrão, para contornar a maioria dessas limitações.

Mesas

O Conector Jitterbit para eBay modela Listagens de itens em tabelas para que possam ser facilmente consultadas, atualizadas e excluídas. Você pode listar itens em sua loja eBay chamando o procedimento armazenado AddItem.

Visualizações

Visualizações são tabelas que não podem ser modificadas. Normalmente, os dados somente leitura são mostrados como exibições.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para a fonte de dados. Eles podem ser usados para pesquisar, atualizar e modificar informações na fonte de dados.

Tabelas

O conector modela os dados no eBay em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas do eBay é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas do Ebay

Nome Descrição
ItemListing Atualize, exclua e consultar Listagens de itens para vendedores.
ItemVariations Variações de itens são vários itens semelhantes (mas não idênticos) em uma única listagem de preço fixo. Por exemplo, uma listagem de camisetas pode conter vários itens da mesma marca que variam de cor e tamanho; cada variação especificaria uma combinação de uma dessas cores e tamanhos. Cada variação pode ter uma quantidade e preço diferentes. Você pode comprar vários itens de uma variação ao mesmo tempo. (Ou seja, um item de linha de pedido pode conter vários itens de uma única variação.)
Tasks Recupera todas as tarefas para o mercado especificado usando o parâmetro de consultar MarketplaceId.

Listagem de Itens

Atualize, exclua e consultar Listagens de itens para vendedores.

Informações Específicas da Tabela
Selecione

A consultar a seguir recupera itens do vendedor. Por padrão, essa consultar retorna itens que foram adicionados nos últimos 100 dias.

SELECT * FROM ItemListing

ItemListing é a única tabela que suporta ORDER BY. Apenas duas colunas podem ser usadas para ordenação: StartTime e EndTime. A consultar a seguir recupera itens que terminam entre o horário especificado, ordenados pelo item que termina antes.

SELECT * FROM ItemListing WHERE EndTimeFrom='2016-01-25' AND EndTimeTo='2016-02-05' ORDER BY EndTime
Inserir

O AddItem procedimento armazenado* fornece a funcionalidade para adicionar um novo item.

Atualizar

As entradas necessárias para uma atualização dependem do tipo de item e sua categoria. Pelo menos o ItemId e uma propriedade do item devem ser fornecidos em uma atualização.

UPDATE ItemListing SET Title='My Awesome Item' WHERE ItemId='123456789'

Após a venda de um item em uma listagem de várias quantidades, os vendedores não podem alterar os valores nos campos Título, Categoria principal, Categoria secundária, Duração da listagem e Tipo de listagem. No entanto, todos os outros campos ainda são editáveis.

Excluir

O ItemId e EndingReason devem ser especificados para excluir um item.

DELETE FROM ItemListing WHERE ItemId='123456789' AND  EndingReason='LostOrBroken'
Colunas
Nome Tipo Somente leitura Descrição
ItemId [KEY] String Falso O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
Title String Falso Nome do item conforme aparece na listagem ou nos resultados da pesquisa.
AutoPay Boolean Falso Se verdadeiro, o vendedor solicita o pagamento imediato do item.
BuyerProtection String Falso Sinalizador para indicar a qualificação de um item para o programa de proteção ao comprador do PayPal.
BuyItNowPrice Decimal Falso Este campo é aplicável apenas para listagens de leilões. Ao especificar um preço Compre agora, um vendedor está permitindo que compradores em potencial tenham a oportunidade de comprar o item no leilão por esse preço imediatamente.
ConditionDescription String Falso Este campo de string é usado pelo vendedor para descrever mais claramente a condição dos itens que não são novos.
Country String Falso Define o código de país ISO 3166 de 2 letras.
Currency String Falso Moeda associada às informações de preço do item. Código de moeda ISO 4217 de 3 letras.
Description String Falso A descrição do item pelo vendedor. Nas solicitações de listagem, você pode usar tags CDATA para enviar sua descrição se desejar usar caracteres HTML ou XML reservados na descrição.
HideFromSearch Boolean Falso Se a listagem está oculta de todas as pesquisas que ocorrem no eBay.
HitCount Integer Falso O número de visualizações de página do item.
Adult Boolean Falso Se verdadeiro, o item está listado na categoria Adulto.
BestOfferAutoAcceptPrice Decimal Falso O preço pelo qual as Melhores Ofertas são automaticamente aceitas. Semelhante em uso a MinimumBestOfferPrice.
CheckoutEnabled Boolean Falso Este sinalizador indica se a preferência Checkout ativado do vendedor está ou não ativada (no nível da conta ou no nível da listagem).
StartTime Datetime Falso O StartTime para quando o item foi listado.
EndTime Datetime Falso Carimbo de data/hora (em GMT) quando a listagem está programada para terminar (calculada com base nos valores de StartTime e ListingDuration) ou a hora de término real se o item tiver terminado.
MinimumBestOfferPrice Decimal Falso Especifica o preço mínimo aceitável da Melhor Oferta. Se um comprador enviar uma Melhor Oferta abaixo desse valor, a oferta será automaticamente recusada pelo vendedor.
ViewItemURL String Falso A URL da página da Web em que um usuário pode exibir a listagem. No site dos EUA, isso é chamado de página Exibir item.
ViewItemURLForNaturalSearch String Falso Essa URL leva você à mesma página Exibir item que ViewItemURL, mas essa URL é otimizada para oferecer suporte à pesquisa natural. Ou seja, esse URL é projetado para facilitar a localização de itens no eBay por meio de mecanismos de pesquisa populares na Internet.
ListingDuration String Falso Descreve o número de dias que o vendedor deseja que o anúncio fique ativo (disponível para licitação/compra).
ListingType String Falso O formato da listagem que o vendedor deseja usar, como leilão chinês ou preço fixo.
Location String Falso Indica a localização geográfica do item (juntamente com o País). Ao revisar uma listagem, você pode adicionar ou alterar esse valor somente se a listagem não tiver lances (ou nenhum item tiver sido vendido) e não terminar em 12 horas.
CategoryId String Falso ID da categoria para a primeira (ou única) categoria na qual o item está listado (ou será listado, se o item for novo).
CategoryName String Falso Esse valor de string é o nome de exibição da categoria primária do eBay, como apareceria no site do eBay.
PrivateListing Boolean Falso Se verdadeiro, designa a listagem como privada.
Quantity Integer Falso O significado desse valor depende do contexto.
QuantityAvailableHint String Falso Indica o tipo de mensagem que será retornada descrevendo a quantidade disponível para o item.
QuantityThreshold Integer Falso O limite de quantidade acima do qual o vendedor prefere não mostrar a quantidade real disponível.
ReservePrice Decimal Falso O menor preço pelo qual o vendedor está disposto a vender o item.
Refund String Falso String de exibição que os aplicativos do comprador podem usar para apresentar RefundOption em um formato mais amigável para os compradores.
RefundOption String Falso Indica como o vendedor compensará o comprador por um item devolvido.
ReturnsAccepted String Falso String de exibição que os aplicativos do comprador podem usar para apresentar ReturnsAcceptedOption em um formato mais amigável para os compradores.
ReturnsAcceptedOption String Falso Indica se o vendedor permite que o comprador devolva o item. Um dos seguintes valores: ReturnsAccepted ou ReturnsNotAccepted. Se você especificar ReturnsNotAccepted, a página Exibir item indicará que as devoluções não são aceitas.
ReturnsWithin String Falso String de exibição que os aplicativos do comprador podem usar para apresentar ReturnsWithinOption em um formato mais amigável para os compradores.
ReturnsWithinOption String Falso O comprador pode devolver o item dentro desse período de tempo a partir do dia em que receber o item.
ShippingCostPaidBy String Falso String de exibição que os aplicativos do comprador podem usar para apresentar ShippingCostPaidByOption em um formato mais amigável para os compradores.
ShippingCostPaidByOption String Falso A parte que paga o custo de envio de um item devolvido.
WarrantyDuration String Falso String de exibição que os aplicativos do comprador podem usar para apresentar WarrantyDurationOption em um formato mais amigável para os compradores.
WarrantyDurationOption String Falso O período de garantia.
WarrantyOffered String Falso String de exibição que os aplicativos do comprador podem usar para apresentar WarrantyOfferedOption em um formato mais amigável para os compradores.
WarrantyOfferedOption String Falso Indica se uma garantia é oferecida para o item.
WarrantyType String Falso String de exibição que os aplicativos do comprador podem usar para apresentar WarrantyTypeOption em um formato mais amigável para os compradores.
WarrantyTypeOption String Falso Indica a origem ou tipo de garantia, se houver.
ItemRevised Boolean Falso Este campo é retornado como verdadeiro se a listagem original tiver sido revisada.
SellerName String Falso O nome do vendedor. Este campo é usado como parte do endereço.
CurrentPrice Decimal Falso O preço atual do item na moeda original da listagem.
ListingStatus String Falso Especifica um status de listagem ativo ou encerrado no workflow de processamento.
PromotionalEndTime Datetime Falso Horário de término de um desconto para um item cujo preço foi reduzido por um vendedor com o recurso Exibição de preço promocional.
PromotionalOriginalPrice Decimal Falso Preço original de um item cujo preço foi reduzido por um vendedor com o recurso Exibição de preço promocional.
PromotionalStartTime Datetime Falso Horário de início de um desconto para um item cujo preço foi reduzido por um vendedor com o recurso Exibição de preço promocional.
QuantitySold Integer Falso O número total de itens comprados até o momento durante o tempo de vida da listagem. Subtraia isso de Quantidade para determinar a quantidade disponível.
ReserveMet Boolean Falso Indica se o preço de reserva foi atingido para a listagem. Retorna true se o preço de reserva foi atingido ou nenhum preço de reserva foi especificado.
SecondChanceEligible Boolean Falso Parte do recurso Oferta de segunda chance, que indica se o vendedor pode estender uma oferta de segunda chance para o item.
Site String Falso O nome do site no qual o item está listado.
SKU String Falso Um SKU (unidade de manutenção de estoque) é um identificador definido por um vendedor.
StartPrice Decimal Falso O preço original do item no momento da listagem ou relistagem. Se esse valor mudar quando o item for revisado, o novo valor se tornará o preço original.
TimeLeft String Falso Tempo restante antes do término da listagem. A duração é representada no formato de duração ISO 8601 (PnYnMnDTnHnMnS).
TotalQuestionCount Integer Falso O número de perguntas feitas sobre este item. Aplica-se apenas a aplicativos do eBay Motors Pro.
WatchCount Integer Falso O número de relógios colocados neste item das contas My eBay dos compradores.
StoreCategoryId Long Falso Identificador exclusivo de uma categoria personalizada principal na qual listar o item.
StoreCategoryId2 Long Falso Identificador exclusivo para a categoria personalizada secundária na qual listar o item.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
AdminEndedItemsOnly String Especifica se deve retornar apenas itens que foram encerrados administrativamente com base em uma violação de política.
EndTimeFrom Datetime Especifica a data mais antiga (mais antiga) a ser usada em um filtro de intervalo de datas com base na hora de término do item. Especifique um intervalo de horário de término ou um filtro de intervalo de horário de início. Cada um dos intervalos de tempo deve ser um valor inferior a 120 dias.
EndTimeTo Datetime Especifica a data mais recente (mais recente) a ser usada em um filtro de intervalo de datas com base na hora de término do item. Especifique um intervalo de horário de término ou um filtro de intervalo de horário de início. Cada um dos intervalos de tempo deve ser um valor inferior a 120 dias.
GranularityLevel String Especifica o subconjunto de campos de item e usuário a serem retornados.
StartTimeFrom Datetime Especifica a data mais antiga (mais antiga) a ser usada em um filtro de intervalo de datas com base na hora de início do item.
StartTimeTo Datetime Especifica a data mais recente (mais recente) a ser usada em um filtro de intervalo de datas com base na hora de início do item. Deve ser especificado se StartTimeFrom for especificado.
UserId String Especifica o vendedor cujos itens serão devolvidos. UserId é uma entrada opcional. Se não for especificado, recupera as listagens do usuário identificado pelo token de autenticação transmitido na solicitação.
DetailLevel String Níveis de detalhe são instruções que definem subconjuntos padrão de dados a serem retornados para tabelas específicas. Os valores permitidos são ReturnAll.
EndingReason String Indica o motivo pelo qual o vendedor encerrou a listagem antecipadamente.

Variações de Itens

Variações de itens são vários itens semelhantes (mas não idênticos) em uma única listagem de preço fixo. Por exemplo, uma listagem de camisetas pode conter vários itens da mesma marca que variam de cor e tamanho; cada variação especificaria uma combinação de uma dessas cores e tamanhos. Cada variação pode ter uma quantidade e preço diferentes. Você pode comprar vários itens de uma variação ao mesmo tempo. (Ou seja, um item de linha de pedido pode conter vários itens de uma única variação.)

Informações Específicas da Tabela
Selecione

Um ID de item deve ser especificado para obter variações para o item que esse ID representa.

SELECT * FROM ItemVariations WHERE ItemId = '110187147205'
Inserir

Os campos obrigatórios para inserção são ItemId, VariationSpecificsAggregate, StartPrice e Quantity. VariationSpecificsAggregate deve conter especificações de variação estruturadas no formato XML. Por exemplo, o seguinte VariationSpecificsAggregate adiciona um grande item azul:

<NameValueList>
  <Name>Color</Name>
  <Value>Blue</Value>
</NameValueList>
<NameValueList>
  <Name>Size</Name>
  <Value>L</Value>
</NameValueList>

A consultar a seguir adiciona uma variação de um grande item azul com um StartPrice de 15 e uma Quantity de 100.

INSERT INTO ItemVariations (ItemId,VariationSpecificsAggregate,Quantity,StartPrice) values ('110188946596','<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>','100','15')
Atualizar

ItemId e VariationSpecificsAggregate são necessários para atualizar uma variação. Opcionalmente, outros detalhes podem ser fornecidos para variações, como StartPrice e Quantity. VariationSpecificsAggregate deve estar no formato XML e deve conter todas as especificações que identificam uma variação.

UPDATE ItemVariations SET Quantity='5' WHERE ItemId='110188946596' AND VariationSpecificsAggregate='<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>'
Excluir

ItemId e VariationSpecificsAggregate são necessários para excluir uma variação.

DELETE FROM ItemVariations WHERE ItemId='110188946596' AND VariationSpecificsAggregate='<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>'
Colunas
Nome Tipo Somente leitura Descrição
ItemId [KEY] String Falso O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
VariationSpecificsAggregate [KEY] String Falso Uma lista de pares de nome/valor que identificam exclusivamente a variação dentro da listagem. Todas as variações devem especificar o mesmo conjunto de nomes. Por exemplo, se os itens variam por cor e tamanho, cada variação deve especificar Cor e Tamanho como nomes, e duas variações não podem especificar a mesma combinação de valores de cor e tamanho.
StartPrice Decimal Falso O preço do item no momento da listagem ou relistagem. Se esse valor mudar quando o item for revisado, o novo valor se tornará esse preço.
Currency String Falso Moeda associada às informações de preço do item. Código de moeda ISO 4217 de 3 letras.
Quantity Integer Falso Este valor indica a quantidade de itens na variação específica que estão disponíveis para compra.
QuantitySold Integer Falso O número total de itens comprados até agora. Subtraia isso de Quantidade para determinar a quantidade disponível.
SKU String Falso Um SKU (unidade de manutenção de estoque) é um identificador definido por um vendedor. Destina-se apenas ao uso do vendedor (não para compradores).
EAN String Falso Este campo é usado se o vendedor deseja identificar cada variação de produto dentro de uma listagem multivariada por um valor EAN (European Article Number).
ISBN String Falso Este campo é usado se o vendedor deseja identificar cada variação do produto dentro de uma listagem multivariada por um valor ISBN (International Standard Book Number).
UPC String Falso Este campo é usado se o vendedor deseja identificar cada variação de produto dentro de uma listagem multivariada por um valor UPC (Universal Product Code).
ListingStatus String Falso Especifica uma listagem com status ativo ou encerrado no workflow de processamento do eBay.

Tarefas

Recupera todas as tarefas para o mercado especificado usando o parâmetro de consultar MarketplaceId.

Selecione

FeedType é um filtro obrigatório na consultar Selecionar. Você pode seguir a consultar abaixo para obter os valores necessários através do SQL:

SELECT * FROM [Tarefas] WHERE FeedType = 'LMS_ADD_ITEM'

Alguns dos campos são nomeados com o sufixo Aggr. Esses campos exibem o conteúdo da tag JSON com o mesmo nome que é retornado do endpoint da API.

Inserir

FeedType, MarketplaceID e SchemaVersion são obrigatórios na consultar Insert. Você pode seguir a consultar abaixo para obter os valores necessários através do SQL:

INSERT INTO [Tarefas] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')
Colunas
Nome Tipo Somente leitura Descrição
TaskId [KEY] String Verdadeiro A ID da tarefa que foi enviada na solicitação.
Status String Verdadeiro O valor de enumeração que indica o estado da tarefa que foi enviada na solicitação.
FeedType String Falso O tipo de feed associado à tarefa.
CreationDate Datetime Verdadeiro A data em que a tarefa foi criada.
UploadSummaryAggr String Verdadeiro Este contêiner fornece informações resumidas sobre um feed de upload (não aplicável para tipos de feed de download).
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
MarketplaceID String MarketplaceID da sua conta Ebay.
SchemaVersion String O número da versão do esquema associado à tarefa.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Visualizações do Ebay

Nome Descrição
Bidders Consulte os usuários do eBay que fazem lances em uma listagem especificada, independentemente de a listagem ter terminado.
Categories Consulte as categorias do eBay.
CategoryFeatures Consulte as configurações suportadas pelas categorias do eBay.
CategorySpecifics Consultar Lista de Compatibilidade de Itens para vendedores.
Countries Lista o código do país e o nome associado dos países suportados pelo sistema eBay, independentemente do site especificado na solicitação.
Currencies Consulte as moedas suportadas no eBay.
DSRSummary Consultar informações de classificação de relatórios de resumo DSR.
FulfillmentPolicies Recupera todas as políticas de atendimento configuradas para o mercado especificado usando o parâmetro de consultar MarketplaceId.
HighestBidder Consulte o lance mais alto dos usuários do eBay que deram lances em uma listagem especificada, independentemente de a listagem ter terminado.
ItemCompatibilityList Consulte categorias de compatibilidade e possíveis valores de compatibilidade para um item específico.
ItemShipping Detalhes da consulta pertinentes a um ou mais itens para os quais o frete calculado foi oferecido pelo vendedor, como dimensão da embalagem, peso e custos de embalagem/manuseio.
ItemSpecifics Consultar itens específicos para um item específico.
ItemTransactions Consulte as informações do item de linha do pedido (transação) para uma listagem especificada. Para listagens de leilão, os itens de linha de pedido não são criados até que o leilão termine com um licitante vencedor ou se o recurso Comprar agora estiver ativado para a listagem e usado pelo comprador para comprar o item. Para listagens de preço fixo, os itens de linha do pedido são criados depois que um comprador se compromete a comprar o(s) item(ns).
MostWatchedItems Consulte os itens com as contagens de exibição mais altas para todo o site ou para uma categoria específica. Os itens principais são determinados pelos totais de Watch Count do dia anterior. A classificação dos itens mais assistidos é calculada com as informações mais recentes da contagem de exibição.
OrderPayments Consultar todos os pagamentos dos pedidos, em que o usuário autenticado seja o comprador ou o vendedor. Por defeito, são devolvidos apenas os dados de pagamento das encomendas realizadas nos últimos 90 dias. Detalhes de pagamento de pedidos com mais de 90 dias podem ser recuperados especificando OrderId.
Orders Consultar todos os pedidos em que o usuário autenticado seja o comprador ou o vendedor. Por padrão, apenas os pedidos feitos nos últimos 90 dias são devolvidos. Pedidos com mais de 90 dias podem ser recuperados especificando OrderId.
OrderShipping Consulte os detalhes de envio dos pedidos em que o usuário autenticado seja o comprador ou o vendedor. Por defeito, são devolvidos apenas os dados de envio das encomendas efetuadas nos últimos 90 dias. Detalhes de envio de pedidos com mais de 90 dias podem ser recuperados especificando OrderId.
PaymentPolicies Recupera todas as políticas de pagamento configuradas para o mercado especificado usando o parâmetro de consultar MarketplaceId.
ReturnPolicies Recupera todas as políticas de devolução configuradas para o mercado especificado usando o parâmetro de consultar MarketplaceId.
ShippingCarriers Consultar transportadoras suportadas pelo site especificado.
ShippingCategories Uma categoria de serviço de frete compatível com o site.
ShippingLocations Lista as regiões e locais suportados pelos serviços de remessa do eBay. Retorna todos os locais de envio suportados pelo eBay, independentemente do site especificado na solicitação.
ShippingServices Consulte os serviços de remessa suportados pelo site eBay especificado.
Sites Lista todos os sites eBay disponíveis e seus números de SiteID associados.
TopSellingProducts Consulte seus produtos mais vendidos no eBay.
TransactionPayments Consultar todos os pagamentos das transações em que o usuário autenticado seja o comprador ou o vendedor. Por padrão, são devolvidos apenas os pagamentos das transações realizadas nos últimos 90 dias. Os pagamentos das transações em pedidos com mais de 90 dias podem ser recuperados especificando OrderIds.
Transactions Consulte todas as transações nas quais o usuário autenticado é o comprador ou o vendedor. Por padrão, são retornadas apenas as transações de pedidos feitos nos últimos 90 dias. As transações de pedidos com mais de 90 dias podem ser recuperadas especificando OrderId.
TransactionShipping Consulte os detalhes de envio das transações em que o usuário autenticado é o comprador ou o vendedor. Por defeito, são devolvidos apenas os dados de envio das transacções efectuadas nos últimos 90 dias. Os detalhes de envio das transações em pedidos com mais de 90 dias podem ser recuperados especificando OrderIds.

Licitantes

Consulte os usuários do eBay que fazem lances em uma listagem especificada, independentemente de a listagem ter terminado.

Informações Específicas da Tabela
Selecione

As únicas colunas com suporte para filtragem são ItemId e ListMode. Um ItemId deve ser especificado para recuperar dados desta exibição.

Select * FROM Bidders WHERE ItemId = '1234567'
Select * FROM Bidders WHERE ItemId = '1234567' And ListMode = 'EndedListing'
Colunas
Nome Tipo Descrição
Action String Indica o tipo de oferta que está sendo feita na listagem especificada.
MaxBid Decimal Valor da oferta colocada. Para listas de leilões, o valor do lance no item (sujeito a lances superados por outros compradores). Para listagens de preço fixo, o preço de venda fixo pelo qual o item é comprado. Para listas de leilões com uma opção ativa do Compre agora, esse valor será o preço do Compre agora para compra ou o valor de um lance, dependendo do tipo de oferta.
Currency String O código de moeda de três dígitos para o lance máximo.
ConvertedPrice Decimal O preço na moeda especificada.
ConvertedPriceCurrency String O ID da moeda de três dígitos do preço convertido.
HighestBid Decimal Valor que o licitante de maior lance deu no item. Aplicável apenas a listagens de leilões em que há lance progressivo e os licitantes vencedores são determinados com base no lance mais alto.
HighestBidCurrency String O código de moeda de três dígitos para o lance mais alto.
Quantity Integer Especifica o número de itens que o usuário que oferece a oferta pretende comprar, licitar ou fazer uma Melhor Oferta.
SecondChanceEnabled Boolean Indica se o usuário está disposto a receber ofertas de segunda chance.
SiteCurrency String ID exclusivo que identifica a moeda na qual os valores das ofertas localizadas são expressos.
TimeBid Datetime Data e hora em que a oferta ou lance foi feito.
UserId String ID de usuário exclusivo do eBay para o usuário.
UserCountry String O código de dois dígitos que representa o país do usuário.
UserFeedbackScore Integer A pontuação de feedback agregada para um usuário. Uma pontuação de feedback para um usuário é o feedback positivo líquido menos o feedback negativo líquido deixado para o usuário.
ItemId String O ID do item. Os licitantes que licitam neste item são devolvidos.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ListMode String Especifica quais informações do proponente devem ser retornadas. EndedListing retorna todos os licitantes não vencedores apenas para listagens encerradas. Ele pode ser usado apenas por um vendedor. SecondChanceEligibleEndedListing retorna todos os licitantes não vencedores de uma listagem encerrada que ainda não receberam uma oferta de segunda chance e demonstraram interesse em receber uma oferta de segunda chance. Ele pode ser usado apenas por um vendedor. ViewAll retorna todos os proponentes de uma listagem encerrada ou ainda ativa. Pode ser usado por qualquer usuário. Os valores permitidos são EndedListing, SecondChanceEligibleEndedListing, ViewAll.

Categorias

Consulte as categorias do eBay.

Informações Específicas da Tabela
Selecione

As únicas colunas com suporte para filtragem são CategorySiteId, LevelLimit e CategoryParentId.

SELECT * FROM Categories.

Você pode retornar mais informações sobre uma categoria específica e suas subcategorias com a seguinte consultar:

SELECT * FROM Categories WHERE LevelLimit = '2' AND CategoryParent = '267'
Colunas
Nome Tipo Descrição
CategoryId [KEY] String Esse valor de string é o identificador exclusivo de uma categoria do eBay.
AutoPayEnabled Boolean Especifica que a categoria correspondente suporta pagamento imediato para listagens.
B2BVATEnabled Boolean Especifica que a categoria correspondente suporta listagens de IVA business-to-business (B2B). Este recurso é aplicável apenas aos sites eBay Alemanha (DE), Áustria (AT) e Suíça (CH).
BestOfferEnabled Boolean Especifica que a categoria correspondente suporta as melhores ofertas.
CategoryLevel Integer Esse valor inteiro indica o nível em que a categoria se encaixa na hierarquia de categorias do site eBay. Por exemplo, se este campo tiver o valor 2, a categoria estará dois níveis abaixo da categoria raiz.
CategoryName String Esse valor de string é o nome de exibição da categoria primária do eBay, como apareceria no site do eBay.
CategoryParentId String Esse valor de sequência é o ID da categoria da categoria pai da categoria primária indicada no campo CategoryId.
Expired Boolean Especifica que a categoria correspondente não é mais uma categoria válida do eBay no site e os itens podem não estar listados nesta categoria.
LeafCategory Boolean Especifica que a categoria correspondente é uma categoria folha do eBay, uma categoria na qual os itens podem ser listados.
LSD Boolean Tamanho do lote desativado. Especifica que a categoria correspondente não suporta listagens de lotes. Uma listagem de lote é uma listagem que apresenta vários itens relacionados que devem ser comprados por um comprador em uma transação.
ORPA Boolean Substituir preço de reserva permitido: especifica que a categoria correspondente é uma exceção à política de preço de reserva padrão em listas de leilões para o site eBay.
ORRA Boolean Substituir Reduzir Reserva Permitida: Especifica que a categoria correspondente é uma exceção à política padrão de Reduzir Preço de Reserva (na listagem de leilão ativo).
Virtual Boolean Especifica que a categoria correspondente é uma categoria virtual do eBay, uma categoria na qual os itens não podem ser listados.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CategorySiteId String O ID do site eBay dos EUA para a categoria.
LevelLimit String Especifica a profundidade máxima da hierarquia de categoria a ser recuperada, onde as categorias de nível superior (metacategorias) estão no nível 1. Se não for especificado, as categorias serão recuperadas em todos os níveis aplicáveis.
ViewAllNodes String Esse valor controla se todas as categorias do eBay ou apenas as categorias folha que atendem a quaisquer restrições da cláusula WHERE são retornadas. Você só pode listar itens em categorias de folha. O valor padrão é verdadeiro.
DetailLevel String Níveis de detalhe são instruções que definem subconjuntos de dados a serem retornados para tabelas específicas. Valores possíveis: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll, ReturnHeaders, ReturnMessages e ReturnSummary.

CategoriaCaracterísticas

Consulte as configurações suportadas pelas categorias do eBay.

Informações Específicas da Tabela
Selecione

As únicas colunas com suporte para filtragem são CategoryId, LevelLimit, AllFeaturesForCategory e FeatureId. Se nenhum CategoryId for especificado, todos os recursos para categorias de nível superior serão retornados.

SELECT * FROM CategoryFeatures                          
SELECT * FROM CategoryFeatures WHERE LevelLimit='2' And CategoryId='277'
Colunas
Nome Tipo Descrição
CategoryId String O identificador exclusivo da categoria à qual a configuração pertence.
BestOfferAutoAcceptEnabled Boolean Indica se a categoria oferece suporte ao recurso Aceitação Automática de Melhor Oferta para listagens de preço fixo.
BestOfferAutoDeclineEnabled Boolean Indica se a categoria oferece suporte ao recurso Recusar automaticamente a melhor oferta.
BestOfferCounterEnabled Boolean Indica se a categoria suporta vendedores que oferecem uma contra-oferta contra a Melhor Oferta de um comprador ou um comprador que oferece uma contra-oferta contra a contra-oferta do vendedor. Este campo só é aplicável a listagens de preço fixo.
BestOfferEnabled Boolean Indica se a categoria oferece suporte ao recurso Melhor oferta para listagens de preço fixo.
BrandMPNIdentifierEnabled Boolean Indica se a categoria suporta a capacidade de identificar um produto usando a combinação de número de peça de marca/fabricante.
ConditionEnabled String Indica se a categoria suporta (ou requer) condições a serem especificadas.
ConditionValuesAggregate String Os IDs de condição válidos para esta categoria.
EANEnabled String Indica se os números de artigos europeus (EANs) podem ou não ser usados para ajudar a criar uma listagem.
FreeGalleryPlusEnabled Boolean Indica se a categoria oferece suporte a atualizações automáticas gratuitas para o Gallery Plus, que aprimora as imagens nos resultados da pesquisa.
FreePicturePackEnabled Boolean Indica se a categoria oferece suporte a atualizações automáticas e gratuitas para o Picture Pack, um pacote de desconto que inclui superdimensionamento de fotos.
GlobalShippingEnabled Boolean Especifica se a categoria correspondente suporta ou não o Global Shipping Program (GSP).
Group1MaxFlatShippingCost Double Retorna o máximo aplicável. limite por custo de frete para o grupo de serviços de frete 1.
Group2MaxFlatShippingCost Double Retorna o máximo aplicável. limite por custo de envio para o grupo de serviços de envio 2.
Group3MaxFlatShippingCost Double Retorna o máximo aplicável. limite por custo de envio para o grupo de serviços de envio 3.
HandlingTimeEnabled Boolean Se falso, as listagens nesta categoria exigem um tempo em separação quando o frete fixo ou calculado é especificado. Não é necessário um tempo em separação para retirada no local ou para envio de frete. consulte DispatchTimeMax em AddItem.
HomePageFeaturedEnabled Boolean Indica se é ou não possível aprimorar uma listagem colocando-a em rotação para exibição em uma área especial da página inicial do eBay. O suporte para esse recurso varia de acordo com o site. Restrições de itens ou comentários podem ser aplicadas.
INEscrowWorkflowTimeline String Indica a versão do workflow de garantia que se aplica à categoria no site da Índia: Workflow padrão, Workflow A ou Workflow B.
ISBNEnabled String Indica se os International Standard Book Numbers (ISBNs) podem ou não ser usados para ajudar a criar uma listagem.
ItemCompatibilityEnabled String Indica se a categoria suporta compatibilidade de peças por aplicativo (ByApplication), por especificação (BySpecification) ou não (Desativado).
ItemSpecificsEnabled String Indica se a categoria oferece suporte a especificações de itens personalizados.
ListingDurations String Os tipos de listagem e durações de listagem em dias que são suportados para a categoria.
MaxFlatShippingCost Double O custo máximo que o vendedor pode cobrar pelo primeiro serviço de frete fixo doméstico. O custo total de envio é o custo de envio de taxa fixa base mais o custo do seguro, se o seguro for necessário. Mutuamente exclusivo com GroupNMaxFlatShippingCost.
MaxGranularFitmentCount Integer Indica a contagem máxima de acessórios.
MaxItemCompatibility Integer Especifica o número máximo de compatibilidades de peças.
MinimumReservePrice Double Indica se um Preço Mínimo de Reserva está habilitado para esta categoria. Nos sites da Alemanha, Áustria, Bélgica francesa e Bélgica holandesa, o Preço mínimo de reserva é compatível com as categorias Arte e antiguidades, Relógios e joias e Motos.
MinItemCompatibility Integer Este campo especifica o número mínimo de compatibilidades de peças para listar itens.
NonSubscription String O valor neste campo indica se a categoria suporta listagens do Mercado Local de Motores se o vendedor não tiver uma assinatura de veículo.
PaisaPayFullEscrowEnabled Boolean Indica se a categoria suporta o método de pagamento PaisaPayEscrow. Este recurso é aplicável apenas ao site da Índia.
PaymentMethods String Indica os métodos de pagamento aceitáveis que podem ser usados ao adicionar, revisar ou relistar um item na categoria correspondente.
PaymentProfileCategoryGroup String Indica o grupo de categorias de Políticas de Negócios que podem ser usadas para perfis de Pagamento. Retornado apenas quando este valor (ou a configuração desta categoria) substitui o valor herdado da categoria pai.
PayPalBuyerProtectionEnabled Boolean Se a proteção ao comprador é permitida para esta categoria.
PayPalRequired Boolean Indica se a categoria requer PayPal como forma de pagamento.
PickupDropOffEnabled Boolean Um valor verdadeiro neste campo indica que os itens listados na categoria podem ser ativados com o recurso Click and Collect. Com o recurso Click and Collect, um comprador pode comprar determinados itens no eBay e retirá-los em uma loja local. Os compradores são notificados pelo eBay assim que seus itens estiverem disponíveis.
PremiumSubscription String O valor neste campo indica se a categoria oferece suporte às listagens do Mercado Local de Motores se o vendedor tiver uma assinatura de veículo Premium.
ProductCreationEnabled String Indica se uma categoria suporta (ou requer) a criação de produtos em listagens. Use isso para determinar se é obrigatório especificar o ID do produto ao adicionar, revisar ou relistar.
ProPackEnabled Boolean Indica se a categoria é compatível com a atualização da lista Pro Pack Bundle.
ReturnPolicyEnabled Boolean Retornado apenas quando este valor (ou a configuração desta categoria) substitui o valor herdado do pai da categoria.
ReturnPolicyProfileCategoryGroup String Indica o grupo de categorias de Políticas de Negócios que pode ser usado para perfis de Política de Devolução. Retornado apenas quando este valor (ou a configuração desta categoria) substitui o valor herdado do pai da categoria.
RevisePriceAllowed Boolean Indica se a categoria permite que o vendedor revise o preço de uma listagem de preço fixo.
ReviseQuantityAllowed Boolean Indica se a categoria permite que o vendedor revise a quantidade de uma listagem ativa de várias quantidades.
SafePaymentRequired Boolean Indica se os anúncios nesta categoria precisam ter um método de pagamento seguro.
SellerContactDetailsEnabled Boolean Indica se esta categoria oferece suporte a informações de contato no nível do vendedor para listagens de anúncios classificados.
SellerProvidedTitleSupported Boolean Este campo booleano indica se uma categoria oferece suporte a títulos fornecidos pelo vendedor em listagens.
ShippingProfileCategoryGroup String Indica o grupo de categorias de Políticas Comerciais que podem ser usadas para perfis de Remessa. Retornado apenas quando este valor (ou a configuração desta categoria) substitui o valor herdado do pai da categoria.
ShippingTermsRequired Boolean Indica se a categoria exige que os vendedores especifiquem detalhes de envio no momento da listagem.
SpecialitySubscription String O valor neste campo indica se a categoria oferece suporte às listagens do Mercado Local de Motores se o vendedor tiver uma assinatura de veículos especiais.
ListingDurationsAggregate String Fornece durações de listagens adicionais que estão disponíveis para proprietários de lojas do eBay. As durações de listagem estendidas fornecidas aqui neste elemento devem ser mescladas com as durações de listagem de linha de base fornecidas na coluna ListingDurations. Aplica-se a Listagens de preço fixo.
TransactionConfirmationRequestEnabled Boolean Define se as solicitações de confirmação de transação estão habilitadas em uma determinada categoria.
UPCEnabled String Indica se os Códigos Universais de Produto (UPCs) podem ou não ser usados para ajudar a criar uma listagem.
UserConsentRequired Boolean Indica se um licitante deve consentir com o lance confirmando que leu e concorda com os termos da política de privacidade do eBay.
ValueCategory Boolean Alguns sites do eBay podem selecionar algumas categorias e designá-las como categorias de valor. Normalmente, eles são selecionados em categorias nas quais os compradores podem encontrar ótimos negócios. Esta designação pode mudar ao longo do tempo.
ValuePackEnabled Boolean Indica se a categoria suporta a atualização da listagem do pacote Value Pack.
VariationsEnabled Boolean Se verdadeiro, você pode criar listagens de variação múltipla ao listar um item de preço fixo nesta categoria.
VINSupported Boolean Indica se a categoria suporta o uso do campo VIN (Vehicle Identification Number) para identificar um veículo motorizado e criar uma listagem. Os VINs são suportados nos sites dos EUA, Canadá, Canadá-Francês e Austrália.
VRMSupported Boolean Indica se a categoria oferece suporte ao uso do campo VRM (Vehicle Registration Mark) para identificar um veículo motorizado e criar uma listagem. Os VRMs são suportados apenas no site do Reino Unido.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
AllFeaturesForCategory String Use esta chave para visualizar todas as configurações de recursos para uma categoria específica. Todas as configurações de recursos são retornadas, independentemente das configurações padrão do site. Este elemento funciona em conjunto com CategoryId--consulte as notas desse elemento para obter mais detalhes. Se você também definir FeatureId, o eBay retornará o status dos recursos especificados apenas para a categoria especificada. Padrão: falso.
FeatureId String Use este campo se quiser saber se recursos específicos estão ativados no site ou no nível da categoria raiz. Vários elementos FeatureId podem ser usados na solicitação.
LevelLimit String Um nível de profundidade na hierarquia da categoria. Recupera todos os nós de categoria com um CategoryLevel menor ou igual ao valor LevelLimit. A categoria raiz é 0. Os valores permitidos são 1.
ViewAllNodes String Se definido, o eBay retorna os padrões do site junto com todas as categorias que substituem as configurações de recursos herdadas. Ou seja, esta coluna contém apenas os recursos que a categoria substituiu de sua categoria pai.
DetailLevel String Níveis de detalhe são instruções que definem subconjuntos de dados a serem retornados para tabelas específicas. Valores possíveis: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll, ReturnHeaders, ReturnMessages e ReturnSummary.

Específicos da Categoria

Consultar Lista de Compatibilidade de Itens para vendedores.

Colunas
Nome Tipo Descrição
CategoryId [KEY] String O ID que identifica exclusivamente a categoria. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
Name String Nome do item conforme aparece na listagem ou nos resultados da pesquisa.
PotentialValues String Valores potenciais da categoria específica.
ValueType String O tipo dos valores.
MaxValues String Valores máximos que podem ser especificados para a categoria específica.
SelectionMode String Modo de seleção.
AspectUsage String Uso de aspecto.
UsageConstraint String Restrições da categoria específica.
VariationSpecifics String Especificações da variação.

Países

Lista o código do país e o nome associado dos países suportados pelo sistema eBay, independentemente do site especificado na solicitação.

Colunas
Nome Tipo Descrição
Country String Código de duas letras que representa um país. Esses códigos de duas letras são normalmente usados em chamadas Adicionar/Revisar/Relistar ao se referir a um país.
Description String Nome completo do país para fins de exibição. Pode ser semelhante (mas não necessariamente idêntico a) CountryName em endereços (por exemplo, User.RegistrationAddress.CountryName em GetUser).
DetailVersion String Retorna o número da versão mais recente para este campo. A versão pode ser usada para determinar se e quando atualizar os dados do cliente em cache.
UpdateTime Datetime Fornece a hora em GMT em que os sinalizadores de recursos para os detalhes foram atualizados pela última vez. Esse carimbo de data/hora pode ser usado para determinar se e quando atualizar os dados do cliente em cache.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Uma designação de que tipo de informação você deseja retornar para o site eBay especificado. Os valores permitidos são CountryDetails.

Moedas

Consulte as moedas suportadas no eBay.

Informações Específicas da Tabela
Selecione

Retorna todas as moedas suportadas. Nenhuma coluna é suportada para filtragem.

SELECT * FROM Currencies 
Colunas
Nome Tipo Descrição
Currency String O código de moeda de três dígitos conforme definido na ISO 4217.
Description String Nome completo da moeda para fins de exibição.
DetailVersion String Retorna o número da versão mais recente para este campo.
UpdateTime Datetime Fornece a hora em GMT em que os campos de recursos para os detalhes foram atualizados pela última vez.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Se definido como um valor de CurrencyDetails, detalhes adicionais da moeda serão retornados. Os valores permitidos são CurrencyDetails.

DSRSummary

Consultar informações de classificação de relatórios de resumo DSR.

Informações Específicas da Tabela
Selecione

A coluna JobId deve ser especificada para recuperar dados desta exibição.

SELECT * FROM DSRSummary WHERE JobId = '123456' 
Colunas
Nome Tipo Descrição
JobId String JobId que você pode usar para baixar o relatório.
1StarRatings Integer O número total de classificações de 1 estrela recebidas por um vendedor para uma determinada área DSR.
2StarsRatings Integer O número total de classificações de 2 estrelas recebidas por um vendedor para uma determinada área de DSR.
3StarsRatings Integer O número total de classificações de 3 estrelas recebidas por um vendedor para uma determinada área DSR.
4StarsRatings Integer O número total de classificações de 4 estrelas recebidas por um vendedor para uma determinada área DSR.
5StarsRatings Integer O número total de classificações de 5 estrelas recebidas por um vendedor para uma determinada área de DSR.

Políticas de Cumprimento

Recupera todas as políticas de atendimento configuradas para o mercado especificado usando o parâmetro de consultar MarketplaceId.

Selecione

MarketplaceId é um filtro obrigatório na consultar Selecionar. Você pode seguir a consultar abaixo para obter os valores necessários através do SQL:

SELECT * FROM FulfillmentPolicies WHERE MarketplaceId='EBAY_US'

Alguns dos campos são nomeados com o sufixo Aggr. Esses campos exibem o conteúdo da tag JSON com o mesmo nome que é retornado do endpoint da API.

Colunas
Nome Tipo Descrição
FulfillmentPolicyId [KEY] String Um ID exclusivo atribuído pelo eBay para a política de atendimento. Esse ID é gerado quando a política é criada.
Name String Um nome definido pelo usuário para esta política de atendimento. Os nomes devem ser exclusivos para políticas atribuídas ao mesmo mercado.
Description String Uma descrição opcional definida pelo vendedor da política de atendimento para uso interno (esse valor não é exibido para usuários finais).
CategoryTypesAggr String O valor CategoryTypeEnum ao qual esta política se aplica. Usado para diferenciar contas que vendem veículos motorizados daquelas que não vendem. (Atualmente, cada política pode ser definida para apenas um valor categoryTypes por vez.)
MarketplaceId String A ID do mercado do eBay ao qual esta política de atendimento se aplica.
FreightShipping Boolean Se definido como verdadeiro, o vendedor oferece frete. O envio de frete pode ser usado para itens grandes acima de 150 lbs.
GlobalShipping Boolean Indica se o vendedor optou por participar do Programa de remessa global do eBay e se usa esse serviço para suas remessas internacionais.
HandlingTimeValue Integer O número máximo de dias úteis que o vendedor se compromete a preparar e enviar um pedido após receber um pagamento compensado pelo pedido.
HandlingTimeUnit String Uma unidade de medição de tempo que especifica um período de tempo singular usado para HandlingTimeValue.
LocalPickup Boolean Identifica se o frete é oferecido por esta política e o vendedor oferece apenas retirada no local do item (normalmente em um local não comercial).
PickupDropOff Boolean Se definido como verdadeiro, o vendedor oferece o
ShipToLocationsAggr String Este objeto contém os campos regionIncluded e regionExcluded, que definem as regiões geográficas que um vendedor cobre e não cobre pela política de remessa associada.
ShippingOptionsAggr String Uma lista que define as configurações de remessa do vendedor para remessas de pedidos DOMÉSTICOS e INTERNACIONAIS.

Maior Apostador

Consulte o lance mais alto dos usuários do eBay que deram lances em uma listagem especificada, independentemente de a listagem ter terminado.

Informações Específicas da Tabela
Selecione

As únicas colunas com suporte para filtragem são ItemId e ListMode. Um ItemId deve ser especificado para recuperar dados desta exibição.

Select * FROM HighestBidder WHERE ItemId = '1234567'
Select * FROM HighestBidder WHERE ItemId = '1234567' And ListMode = 'EndedListing'
Colunas
Nome Tipo Descrição
ItemId String O ID do item. Os licitantes que licitam neste item são devolvidos.
HighBidder String ID de usuário do eBay para o usuário com o lance mais alto (ou o timestamp mais antigo, em caso de empate); um candidato a oferta de segunda chance.
HighestBid Decimal Valor do lance oferecido pelo maior lance.
Currency String Código da moeda da oferta.
ListingStatus String Especifica o status de uma listagem ativa ou encerrada no workflow de processamento do sistema eBay. Se uma listagem terminar com uma venda (ou vendas), o eBay precisa atualizar os detalhes da venda (por exemplo, preço total e comprador/oferta de lance mais alto) e a taxa de valor final. Esse processamento pode levar vários minutos. Se você recuperar um item vendido e nenhum detalhe sobre o comprador/oferta de maior lance for retornado ou nenhuma taxa de valor final estiver disponível, use essas informações de status de listagem para determinar se o eBay concluiu o processamento da listagem.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ListMode String Especifica quais informações do proponente devem ser retornadas. EndedListing retorna todos os licitantes não vencedores apenas para listagens encerradas. Ele pode ser usado apenas por um vendedor. SecondChanceEligibleEndedListing retorna todos os licitantes não vencedores de uma listagem encerrada que ainda não receberam uma oferta de segunda chance e demonstraram interesse em receber uma oferta de segunda chance. Ele pode ser usado apenas por um vendedor. ViewAll retorna todos os proponentes de uma listagem encerrada ou ainda ativa. Pode ser usado por qualquer usuário. Os valores permitidos são EndedListing, SecondChanceEligibleEndedListing, ViewAll.

ItemCompatibilityList

Consulte categorias de compatibilidade e possíveis valores de compatibilidade para um item específico.

Colunas
Nome Tipo Descrição
ItemId [KEY] String O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
CompatibilityAttributes String Uma lista de todas as possíveis categorias de compatibilidade para o item especificado.
PossibleCompatibilites String Uma lista de todos os valores de compatibilidade possíveis para o item especificado.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeItemCompatibilityList String Isso é usado para incluir itens ItemCompatibilityList e não deve ser definido manualmente.

ItemEnvio

Detalhes da consulta pertinentes a um ou mais itens para os quais o frete calculado foi oferecido pelo vendedor, como dimensão da embalagem, peso e custos de embalagem/manuseio.

Informações Específicas da Tabela
Selecione

Os filtros DestinationCountryCode e ItemId devem ser especificados para recuperar dados dessa exibição. Além disso, o filtro QuantitySold pode ser usado, mas é opcional.

SELECT * FROM ItemShipping WHERE ItemId='110177686055' AND DestinationCountryCode='US'
Colunas
Nome Tipo Descrição
ItemId String A ID do item que identifica exclusivamente a listagem de itens para a qual recuperar os dados. Entrada necessária.
DestinationCountryCode String Código do país de destino. Se DestinationCountryCode for US, um código postal é necessário e representa o CEP dos EUA. Padrão: EUA.
ExpeditedService Boolean Indica se o serviço é um serviço de remessa acelerada.
FreeShipping Boolean Especifica que o vendedor deseja oferecer frete grátis. Isso se aplica apenas ao primeiro serviço de remessa doméstica especificado e será ignorado se for definido para qualquer outro serviço de remessa.
ImportCharge Decimal O custo total de alfândega e impostos para o trecho internacional de um pedido enviado usando o Programa de remessa global. Esse valor é calculado e fornecido para cada item pelo provedor de remessa internacional quando um comprador visualiza as propriedades do item.
Currency String Identificação da moeda
ShippingService String Uma opção de serviço de remessa oferecida pelo vendedor para enviar um item a um comprador. Para obter uma lista de valores válidos de ShippingService, chame GeteBayDetails com DetailName definido como ShippingServiceDetails. O sinalizador ShippingServiceDetails.ValidForSellingFlow também deve estar presente. Caso contrário, essa opção de serviço de frete específica não será mais válida e não poderá ser oferecida aos compradores por meio de uma listagem.
ShippingInsuranceCost Decimal O custo do seguro associado ao envio de um único item com este serviço de envio.
ShippingServiceAdditionalCost Decimal Uma opção de serviço de remessa oferecida pelo vendedor para enviar um item a um comprador. Para obter uma lista de valores válidos de ShippingService, chame GeteBayDetails com DetailName definido como ShippingServiceDetails. O sinalizador ShippingServiceDetails.ValidForSellingFlow também deve estar presente. Caso contrário, essa opção de serviço de frete específica não será mais válida e não poderá ser oferecida aos compradores por meio de uma listagem.
ShippingServiceCost Decimal O custo base do envio do item usando o serviço de envio especificado no campo ShippingService. No caso de uma listagem de preço fixo com várias quantidades, o campo ShippingServiceAdditionalCost mostra o custo de envio de cada item adicional se o comprador comprar várias quantidades do mesmo item de linha.
ShippingServicePriority Integer Controla o pedido (relativo a outros serviços de frete) em que o ShippingService correspondente aparecerá na página Ver Item e Checkout.
ShippingTimeMax Integer O número máximo garantido de dias que a transportadora levará para enviar um item (sem incluir o tempo que o vendedor leva para entregar o item à transportadora).
ShippingTimeMin Integer O número mínimo garantido de dias em que a transportadora pode enviar um item (sem incluir o tempo que o vendedor leva para entregar o item à transportadora).
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
QuantitySold String Número de itens vendidos a um único comprador e a serem enviados juntos.
DestinationPostalCode String Código postal do país de destino (ou CEP para os EUA). Ignorado se nenhum código de país for fornecido. Tag opcional para alguns países. É mais provável que seja necessário para países grandes.

Específicos do Artigo

Consultar itens específicos para um item específico.

Colunas
Nome Tipo Descrição
ItemId [KEY] String O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
Attribute String Uma lista de todos os atributos para o item especificado.
Specifics String Uma lista de todos os atributos específicos para o item especificado.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeItemSpecifics String Isso é usado para incluir itens ItemSpecifics e não deve ser definido manualmente.

ItemTransactions

Consulte as informações do item de linha do pedido (transação) para uma listagem especificada. Para listagens de leilão, os itens de linha de pedido não são criados até que o leilão termine com um licitante vencedor ou se o recurso Comprar agora estiver ativado para a listagem e usado pelo comprador para comprar o item. Para listagens de preço fixo, os itens de linha do pedido são criados depois que um comprador se compromete a comprar o(s) item(ns).

Informações Específicas da Tabela
Selecione

A coluna ItemId deve ser especificada para recuperar as informações da transação.

Obtenha todas as transações relacionadas a um item específico:

SELECT * FROM ItemTransactions WHERE ItemId='012345678901'

Filtre o número de transações retornadas especificando o número de dias no passado:

SELECT * FROM ItemTransactions WHERE ItemId='012345678901' AND NumberOfDays='25'

Obtenha informações para uma transação específica que foi feita para um item específico:

SELECT * FROM ItemTransactions WHERE ItemId='012345678901' AND TransactionId='0'
Colunas
Nome Tipo Descrição
OrderLineItemId [KEY] String Um identificador exclusivo para um item de linha de pedido do eBay. Este campo é criado assim que houver o compromisso de compra do vendedor, e seu valor é baseado na concatenação de ItemId e TransactionId com um hífen entre esses dois Ids.
TransactionId String O identificador exclusivo de uma transação feita para um item específico. Se um TransactionId for fornecido, qualquer filtro de tempo especificado será ignorado.
ItemId String Identificador exclusivo para uma listagem de itens do eBay.
HandlingCost Decimal O custo de manuseio cobrado pelo vendedor pelo item de linha do pedido. Este campo só é retornado após a conclusão do checkout. O valor desse campo é retornado como zero dólares (0,0) se o vendedor não especificar um custo de manuseio para a listagem.
ShippingCost Decimal O custo de envio pago pelo comprador pelo item de linha do pedido. Este campo só é retornado após a conclusão do checkout.
AdjustmentAmount Decimal Valor do ajuste inserido pelo comprador. Um valor positivo indica que o valor é uma cobrança extra paga ao vendedor pelo comprador. Um valor negativo indica que esse valor é um crédito dado ao comprador pelo vendedor.
AmountPaid Decimal O valor total que o comprador pagou pelo item de linha do pedido.
Currency String Um código de moeda ISO 4217 padrão de 3 dígitos para a moeda usada em países ao redor do mundo.
BestOfferSale Boolean Indica se o item de linha do pedido foi ou não criado como resultado da aceitação pelo vendedor de uma Melhor Oferta de um comprador.
BuyerId String ID de usuário exclusivo do eBay para o usuário.
BuyerCheckoutMessage String Este campo é retornado se um comprador deixou um comentário para o vendedor durante o fluxo de finalização da compra.
CreatedDate Datetime Indica a hora de criação do item de linha do pedido.
DepositType String Este valor indica se o vendedor exige ou não um depósito para o veículo. Este campo só se aplica a listagens de Motores do eBay nos EUA. Caso contrário, este campo é retornado como um valor vazio.
EBayPlusTransaction Boolean Se verdadeiro, esta transação é para um item que foi comprado no programa eBay Plus.
ExtendedOrderId String Um identificador exclusivo para um pedido do eBay.
FinalValueFee Decimal Uma taxa de valor final é calculada e cobrada na conta de um vendedor imediatamente após a criação de um item de linha de pedido.
Gift Boolean Este campo booleano é retornado como verdadeiro se o vendedor estiver dando um vale-presente digital a outra pessoa como presente. Este campo é aplicável apenas para itens de linha de pedido de vale-presente digital.
GiftSummaryMessage String Este texto de formato livre contém a mensagem que o comprador do vale-presente digital deixou para o destinatário do vale-presente.
IntangibleItem Boolean Este sinalizador indica se o item de linha do pedido é ou não um bem intangível, como uma faixa de MP3 ou um toque de celular. Itens intangíveis não são elegíveis para o programa de proteção ao vendedor do PayPal, portanto, o vendedor não poderá abrir um caso de item não pago contra o comprador.
InvoiceSentTime Datetime Este campo indica a data e a hora em que uma fatura do pedido foi enviada do vendedor ao comprador. Este campo só é retornado se uma fatura (contendo o item de linha do pedido) foi enviada ao comprador.
IsMultiLegShipping Boolean Se IsMultilegShipping for true, o Global Shipping Program (GSP) será usado para enviar o item de linha do pedido a um comprador internacional.
LogisticsPlanType String Este campo será retornado somente se o comprador comprou um vale-presente digital, que é entregue por e-mail, ou se o comprador comprou um item habilitado com o recurso Click and Collect.
PaidTime Datetime Indica a hora em que o pedido foi marcado como pago. Este campo não é devolvido até que o pagamento seja efetuado pelo comprador. Este campo não será devolvido para pedidos em que o comprador tenha recebido reembolsos parciais ou totais.
PayPalEmailAddress String O endereço e-mail do PayPal do vendedor. Este campo só é retornado se o vendedor for o usuário autenticado.
QuantityPurchased Integer Esse valor indica o número de itens idênticos comprados ao mesmo tempo pelo mesmo comprador em uma listagem.
ProductName String O nome de um produto do Selling Manager.
ShippedTime Datetime Indica a hora em que os itens associados ao pedido foram marcados como enviados. Este valor só será visível para o usuário em qualquer lado do pedido. Um pedido pode ser marcado como enviado em My eBay, Selling Manager Pro ou programaticamente pelo vendedor por meio do procedimento armazenado CompleteSale.
ShippingConvenienceCharge Decimal O valor que o vendedor está sendo cobrado pela conveniência de uma entrega do eBay Now.
ExpeditedService Boolean Indica se o serviço é um serviço de remessa acelerada.
ShippingServiceImportCharge Decimal O custo total de alfândega e impostos para o trecho internacional de um pedido enviado usando o Programa de remessa global. Esse valor é calculado e fornecido para cada item pelo provedor de remessa internacional quando um comprador visualiza as propriedades do item.
ShippingInsuranceCost Decimal O custo do seguro associado ao envio de um único item com este serviço de envio.
ShippingPackageInfo String Se o pedido estiver sendo entregue através do eBay Now, ele contém informações sobre o status do pedido, o identificador exclusivo da loja de origem do pedido e os prazos de entrega esperados e reais.
ShippingService String Uma opção de serviço de remessa oferecida pelo vendedor para enviar um item a um comprador.
ShippingServiceAdditionalCost Decimal O custo de envio de cada item adicional se o mesmo comprador comprar um ou mais do mesmo item de linha.
ShippingServiceCost Decimal O custo base usando o serviço de remessa especificado no campo ShippingService para enviar o item. No caso de uma listagem de quantidade múltipla e preço fixo, o campo ShippingServiceAdditionalCost mostra o custo de envio de cada item adicional se o comprador comprar um ou mais do mesmo item de linha.
ShippingServicePriority Integer Esse valor inteiro controla o pedido (relativo a outros serviços de remessa) no qual o ShippingService correspondente aparecerá na página Ver Item e Check-out.
ShippingTimeMax Integer O número máximo garantido de dias que a transportadora levará para enviar um item (sem incluir o tempo que o vendedor leva para entregar o item à transportadora).
ShippingTimeMin Integer O número mínimo garantido de dias em que a transportadora pode enviar um item (sem incluir o tempo que o vendedor leva para entregar o item à transportadora).
BuyerSelectedShipping Boolean Indica se o comprador selecionou detalhes de envio durante a finalização da compra.
CheckoutStatus String Indica o status atual do fluxo de checkout do pedido.
CompleteStatus String Indica se o checkout está completo, incompleto ou pendente para um pedido.
DigitalStatus String O estado atual de um vale-presente digital comprado.
EBayPaymentStatus String Indica o sucesso ou insucesso do pagamento online de uma encomenda por parte do comprador.
InquiryStatus String Este campo fornece o status de uma Consulta de Item Não Recebido (INR) pelo comprador. Este campo só é retornado se o comprador tiver criado uma Consulta de INR.
IntegratedMerchantCreditCardEnabled Boolean Indica se o item pode ser pago por meio de uma conta de gateway de pagamento.
LastTimeModified Datetime Indica a data e a hora em que o status de um pedido foi atualizado pela última vez (em GMT).
PaymentHoldStatus String Este campo indica o tipo e/ou status de uma retenção de pagamento no item.
PaymentInstrument String O método de pagamento usado por um comprador alemão ao qual foi oferecida a opção Pagar na fatura. Este campo só será retornado se um comprador alemão tiver oferecido a opção Pagar na fatura. Caso contrário, a forma de pagamento selecionada pelo comprador é retornada no campo PaymentMethodUsed.
PaymentMethodUsed String O método de pagamento que o comprador selecionou para pagar o pedido. Se a finalização da compra ainda não estiver concluída, PaymentMethodUsed será definido como o que o comprador selecionou como sua preferência na página Revisar sua compra.
ReturnStatus String Este campo fornece o status de uma solicitação de devolução do comprador. Este campo só é retornado se o comprador iniciou uma solicitação de devolução ou escalou uma solicitação de devolução existente para um caso de devolução.
TransactionPrice Decimal O preço do item de linha do pedido (transação).
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ModTimeFrom String Os campos ModTimeFrom e ModTimeTo especificam um intervalo de datas para recuperar itens de linha de pedido associados ao ItemId especificado. O campo ModTimeFrom é o intervalo de datas inicial.
ModTimeTo String Os campos ModTimeFrom e ModTimeTo especificam um intervalo de datas para recuperar itens de linha de pedido associados ao ItemId especificado. O campo ModTimeTo é o intervalo de datas final.
NumberOfDays String Este filtro de tempo especifica o número de dias (períodos de 24 horas) no passado para pesquisar itens de linha do pedido.

Itens Mais Assistidos

Consulte os itens com as contagens de exibição mais altas para todo o site ou para uma categoria específica. Os itens principais são determinados pelos totais de Watch Count do dia anterior. A classificação dos itens mais assistidos é calculada com as informações mais recentes da contagem de exibição.

Informações Específicas da Tabela
Selecione

As únicas colunas que podem ser usadas para filtrar são CategoryId, AffiliateCustomId, AffiliateNetworkId e AffiliateTrackingId. Esses filtros são opcionais.

SELECT * FROM MostWatchedItems
SELECT * FROM MostWatchedItems WHERE CategoryId = '277' 
Colunas
Nome Tipo Descrição
ItemId [KEY] String O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado.
Title String Nome do item conforme aparece na listagem ou nos resultados da pesquisa.
Subtitle String Subtítulo do item. Devolvido apenas se o vendedor incluir uma legenda para o anúncio.
WatchCount Integer O número de relógios colocados neste item das contas My eBay dos compradores.
BidCount Integer O número de lances que foram colocados no item.
BuyItNowPrice Decimal O preço Compre agora do item (se houver), na moeda do site em que o item foi listado.
Currency String Os códigos de moeda ISO 4217 de 3 dígitos para a moeda usada pelo site.
OriginalRetailPrice Decimal O preço real de varejo definido pelo fabricante (OEM).
PricingTreatment String Usando os valores OriginalRetailPrice, MinimumAdvertisedPrice e StartPrice, o eBay identifica se a listagem se enquadra em MAP ou STP (também conhecido como OriginalRetailPrice).
SoldOffEbay Boolean Usado pelos sites eBay do Reino Unido e eBay da Alemanha (DE), esse sinalizador indica que o preço com desconto (especificado como StartPrice) é o preço pelo qual o vendedor ofereceu o mesmo item (ou semelhante) para venda em um site ou loja off-line. do que o eBay nos últimos 30 dias. O preço com desconto é sempre referente ao preço do item definido pelo vendedor.
SoldOnEbay Boolean Usado pelos sites eBay do Reino Unido e eBay da Alemanha (DE), esse sinalizador indica que o preço com desconto (especificado como StartPrice) é o preço pelo qual o vendedor ofereceu o mesmo item (ou semelhante) à venda no eBay nos 30 dias anteriores. O preço com desconto é sempre referente ao preço do item definido pelo vendedor.
GlobalId String O site no qual o item está listado. Retorna um ID global, que é um identificador exclusivo para combinações de site, idioma e território.
ImageURL String URL de uma imagem usada como miniatura da Galeria, se houver. A imagem usa um dos seguintes formatos gráficos: JPEG, BMP, TIF ou GIF. Devolvido apenas se o vendedor optar por mostrar uma imagem da galeria.
OriginalPrice Decimal Preço original de um item cujo preço foi reduzido por um vendedor com o recurso Exibição de preço promocional. Só devolvido se o preço foi revisto.
PrimaryCategoryId String ID numérico da primeira (ou única) categoria na qual o item está listado. (As listagens podem aparecer em mais de uma categoria.)
PrimaryCategoryName String Nome de exibição da primeira (ou única) categoria na qual o item está listado. Esta é uma trilha de navegação de categoria totalmente qualificada (por exemplo, Computadores e Redes:Laptops, Notebooks).
ShippingCost Decimal O custo de envio associado ao primeiro serviço de envio. Retornado apenas quando ShippingType é plano.
ShippingType String O modelo de custo de envio oferecido pelo vendedor.
TimeLeft String Tempo restante antes do término da listagem de itens. A duração é representada no formato de duração ISO 8601 (PnDTnHnMnS). Para listagens encerradas, o tempo restante é P0DT0H0M0S (zero dias, zero horas, zero minutos e zero segundos).
ViewItemURL String A URL da página da Web em que um usuário pode visualizar a listagem. No site dos EUA, isso é chamado de página Exibir item. Se você habilitou o rastreamento de afiliados na chamada, ViewItemURL contém uma string que inclui informações de rastreamento de afiliados (consulte a rede de parceiros do eBay).
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CategoryId String Especifica a categoria da qual recuperar listagens de itens.
AffiliateCustomId String Não precisa ser especificado. Você pode definir um AffiliateCustomId para monitorar melhor seus esforços de marketing. Se você estiver usando a rede de parceiros do eBay e fornecer um AffiliateCustomId, o URL de rastreamento retornado pela rede de parceiros do eBay conterá o AffiliateUserId.
AffiliateNetworkId String Especifica seu parceiro de rastreamento para comissões afiliadas.
AffiliateTrackingId String O valor especificado é obtido de seu parceiro de rastreamento.

PedidoPagamentos

Consultar todos os pagamentos dos pedidos, em que o usuário autenticado seja o comprador ou o vendedor. Por defeito, são devolvidos apenas os dados de pagamento das encomendas realizadas nos últimos 90 dias. Detalhes de pagamento de pedidos com mais de 90 dias podem ser recuperados especificando OrderId.

Ver Informações Específicas
Selecione

Exemplos de consulta à visualização OrderPayments:

SELECT * FROM OrderPayments WHERE ModTimeFrom = '2/22/2018'

SELECT * FROM OrderPayments WHERE NumberOfDays = '30'
Colunas
Nome Tipo Descrição
PaymentId [KEY] String Um ID de transação exclusivo para o pagamento.
OrderId String Um identificador exclusivo para um pedido do eBay.
FeeOrCreditAmount Decimal Valor da taxa é um valor positivo e Valor do crédito é um valor negativo.
Payee String A pessoa ou organização que deve receber a alocação de pagamento.
Payer String Este campo indica o usuário do eBay ou parceiro do eBay que enviou o pagamento.
PaymentAmount Decimal O valor do pagamento que é alocado ao beneficiário.
PaymentStatus String O status atual de um pagamento do comprador alocado a um beneficiário especificado.
PaymentTime Datetime A data e a hora em que o pagamento é recebido pelo beneficiário.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CreateTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar detalhes de pagamento dos pedidos criados nesse intervalo de datas.
CreateTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar detalhes de pagamento dos pedidos criados nesse intervalo de datas.
ModTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar detalhes de pagamento dos pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
ModTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar os detalhes de pagamento dos pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
NumberOfDays Integer Todos os detalhes de pagamento do eBay dos pedidos que foram criados ou modificados nesse período são retornados na saída. Mín.: 1. Máx.: 30.
OrderRole String Filtra os detalhes de pagamento devolvidos dos pedidos com base na papel do usuário. A papel do usuário é comprador ou vendedor.
OrderStatus String Filtra os detalhes de pagamento devolvidos dos pedidos com base no status do pedido. Valores aplicáveis: Ativo, Todos, Concluído, Inativo.

Pedidos

Consultar todos os pedidos em que o usuário autenticado seja o comprador ou o vendedor. Por padrão, apenas os pedidos feitos nos últimos 90 dias são devolvidos. Pedidos com mais de 90 dias podem ser recuperados especificando OrderId.

Ver Informações Específicas
Selecione

Exemplos de consulta à visualização Pedidos:

SELECT * FROM Orders WHERE OrderId = '110276240386-28854859001'

SELECT * FROM Orders WHERE OrderId IN ('110276240386-28854859001','110277719772-28859911001')

SELECT * FROM Orders WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'

SELECT * FROM Orders WHERE OrderStatus = 'Active'

SELECT * FROM Orders WHERE NumberOfDays = '26'
Colunas
Nome Tipo Descrição
OrderId [KEY] String Um identificador exclusivo para um pedido do eBay.
ExtendedOrderId String O identificador exclusivo da ordem no formato legado, conforme tradicionalmente usado pela API de Negociação.
BuyerUserId String ID de usuário do eBay do comprador do pedido.
SellerUserId String Este é o ID de usuário do eBay do vendedor do pedido.
OrderStatus String Esse valor de enumeração indica o status atual do pedido. Valores aplicáveis: Ativo, Todos, Cancelado, Concluído, Inativo.
AdjustmentAmount Decimal Esse valor indica a quantia em dólares pela qual o comprador ajustou o total do pedido.
AmountPaid Decimal Este valor indica o valor total do pedido.
AmountSaved Decimal Este valor indica o desconto de frete obtido pelo comprador como resultado da criação de um pedido de Fatura Combinada.
CreatedTime Datetime Timestamp que indica a data e hora em que o pedido foi criado.
ShippedTime Datetime Timestamp indicando a data e hora do envio do pedido. Este campo não é retornado até que o pedido seja marcado como enviado.
PaymentMethod String O método de pagamento que o comprador selecionou para pagar o pedido.
PaymentStatus String Este valor indica o status de pagamento de um pedido.
CheckoutStatus String Contêiner que consiste em detalhes relacionados ao status atual do checkout do pedido.
SellerEmail String O endereço e-mail do vendedor envolvido no pedido. O endereço e-mail do vendedor só é retornado se for o mesmo vendedor que fez a ligação.
SubTotal Decimal O valor subtotal do pedido é o custo total de todos os itens de linha do pedido. Este valor não inclui custos de envio/manuseio, seguro de envio ou impostos sobre vendas.
Total Decimal O valor total é igual ao valor subtotal mais os custos de envio/manuseio, seguro de envio e impostos sobre vendas.
CancelCompleteDate Datetime Timestamp indicando quando o processo de cancelamento de um pedido do eBay foi concluído.
CancelInitiationDate Datetime Este carimbo de data/hora indica quando o cancelamento do pedido do eBay foi iniciado.
CancelInitiator String Esse valor indica qual parte iniciou o cancelamento do pedido do eBay.
CancelReason String Este valor indica o motivo pelo qual o cancelamento do pedido foi iniciado.
CancelStatus String O status atual da solicitação de cancelamento do pedido, se existir.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CreateTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar os pedidos criados nesse intervalo de datas.
CreateTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar os pedidos criados nesse intervalo de datas.
ModTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar pedidos modificados dentro desse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
ModTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar pedidos modificados dentro desse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
NumberOfDays Integer Todos os pedidos do eBay que foram criados ou modificados nesse período são retornados na saída. Mín.: 1. Máx.: 30.
OrderRole String Filtra os pedidos retornados com base na papel do usuário. A papel do usuário é comprador ou vendedor.

PedidoEnvio

Consulte os detalhes de envio dos pedidos em que o usuário autenticado seja o comprador ou o vendedor. Por defeito, são devolvidos apenas os dados de envio das encomendas efetuadas nos últimos 90 dias. Detalhes de envio de pedidos com mais de 90 dias podem ser recuperados especificando OrderId.

Ver Informações Específicas
Selecione

Exemplos de consulta à visualização OrderShipping:

SELECT * FROM OrderShipping WHERE NumberOfDays = '30'

SELECT * FROM OrderShipping WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'
Colunas
Nome Tipo Descrição
OrderId [KEY] String O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
AddressId String ID exclusivo para o endereço de um usuário no banco de dados do eBay.
CityName String O nome da cidade do usuário.
Country String O código de dois dígitos que representa o país do usuário.
CountryName String O nome do país do usuário.
AddressName String Nome do usuário para o endereço.
Phone String Número de telefone principal do usuário.
PostalCode String Código postal do usuário.
StateOrProvince String O estado ou província do endereço do usuário. Se é um estado ou uma província dependerá da região e/ou país.
Street1 String A primeira linha do endereço do usuário.
Street2 String A segunda linha do endereço do usuário (como o número do apartamento ou da suíte).
ShippingCharge Decimal O valor em dólares neste campo indica o valor que está sendo cobrado do vendedor (no nível do pedido) pela conveniência de uma entrega sob demanda do eBay.
ExpeditedService Boolean Indica se o serviço é um serviço de remessa acelerada.
ShippingImportCharge Decimal O custo total de alfândega e impostos para o trecho internacional de um pedido enviado usando o Programa de remessa global.
ShippingInsuranceCost Decimal O custo do seguro associado ao envio de um único item com este serviço de envio.
ShippingServiceAdditionalCost Decimal O custo de envio de cada item adicional se o mesmo comprador comprar várias quantidades do mesmo item de linha.
ShippingServiceCost Decimal O custo base do envio do item usando o serviço de envio especificado no campo ShippingService.
ActualDeliveryTime Datetime Esse carimbo de data/hora indica quando o pedido foi realmente entregue ao comprador.
EstimatedDeliveryTimeMax Datetime Os timestamps EstimatedDeliveryTimeMin e EstimatedDeliveryTimeMax indicam a janela durante a qual o comprador pode esperar a entrega.
EstimatedDeliveryTimeMin Datetime Os timestamps EstimatedDeliveryTimeMin e EstimatedDeliveryTimeMax indicam a janela durante a qual o comprador pode esperar a entrega.
HandleByTime Datetime Esse carimbo de data/hora indica a última data/hora em que o vendedor deve enviar o pacote para garantir que o pacote chegue ao comprador dentro da janela de entrega estimada.
ScheduledDeliveryTimeMax Datetime Os timestamps ScheduledDeliveryTimeMin e ScheduledDeliveryTimeMax indicam a janela de entrega para a qual o comprador pode esperar receber o pedido.
ScheduledDeliveryTimeMin Datetime Os timestamps ScheduledDeliveryTimeMin e ScheduledDeliveryTimeMax indicam a janela de entrega para a qual o comprador pode esperar receber o pedido.
ShippingTrackingEvent String Esse valor de enumeração indica se o pedido foi ou não retirado da loja indicada pelo valor StoreID.
StoreId String O identificador único da loja de onde o pedido será entregue.
SalesTaxAmount Decimal O valor do imposto sobre vendas, calculado para um pedido com base em SalesTaxPercent e nas informações de preço.
SalesTaxPercent Float Porcentagem do preço de um item a ser cobrada como imposto sobre vendas do pedido.
SalesTaxState String Estado ou jurisdição para o qual o imposto sobre vendas está sendo cobrado. Só devolvido se o vendedor especificou um valor.
ShipmentTrackingNumbers String Os números de rastreamento atribuídos pelas transportadoras.
ShippingCarriers String O nome das transportadoras usadas para enviar os itens.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CreateTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar os detalhes de envio dos pedidos criados nesse intervalo de datas.
CreateTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar os detalhes de envio dos pedidos criados nesse intervalo de datas.
ModTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar os detalhes de envio dos pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
ModTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar os detalhes de envio dos pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
NumberOfDays Integer Todos os detalhes de remessa do eBay dos pedidos que foram criados ou modificados nesse período são retornados na saída. Mín.: 1. Máx.: 30.
OrderRole String Filtra os detalhes de envio devolvidos dos pedidos com base na papel do usuário. A papel do usuário é comprador ou vendedor.
OrderStatus String Filtra os detalhes de envio devolvidos dos pedidos com base no status do pedido. Valores aplicáveis: Ativo, Todos, Concluído, Inativo.

Políticas de Pagamento

Recupera todas as políticas de pagamento configuradas para o mercado especificado usando o parâmetro de consultar MarketplaceId.

Selecione

MarketplaceId é um filtro obrigatório na consultar Selecionar. Você pode seguir a consultar abaixo para obter os valores necessários através do SQL:

SELECT * FROM PaymentPolicies WHERE MarketplaceId='EBAY_US'

Alguns dos campos são nomeados com o sufixo Aggr. Esses campos exibem o conteúdo da tag JSON com o mesmo nome que é retornado do endpoint da API.

Colunas
Nome Tipo Descrição
PaymentPolicyId [KEY] String Um ID exclusivo atribuído pelo eBay para uma política de pagamento. Esse ID é gerado quando a política é criada.
Description String A descrição da política de pagamento.
Name String A descrição da política de pagamento.
CategoryTypesName String O valor do nome do tipo de categoria ao qual esta política se aplica. Usado para diferenciar contas que vendem veículos motorizados daquelas que não vendem.
DepositAggr String Valores e datas de vencimento para depósitos em listagens de veículos motorizados no eBay Motors. É aplicável apenas se o campo categoryTypes.name estiver definido como MOTORS_VEHICLES.
MarketplaceId String A ID do mercado eBay ao qual a política de pagamento se aplica.
ImmediatePay Boolean Se definido como verdadeiro, o pagamento será devido no recebimento (o eBay gera um recibo quando o comprador concorda em comprar um item).
PaymentMethodAggr String Se o vendedor não tiver aceitado pagamentos gerenciados, esse contêiner retornará uma lista dos métodos de pagamento aceitos pelo vendedor.
RecipientAccountReferenceId String Contém o endereço e-mail do PayPal do destinatário (comprador) se o referenceType estiver definido como PAYPAL_EMAIL.
RecipientAccountReferenceType String Uma referência à conta de um destinatário. Atualmente, apenas PAYPAL_EMAIL é válido.

Políticas de Devolução

Recupera todas as políticas de devolução configuradas para o mercado especificado usando o parâmetro de consultar MarketplaceId.

Selecione

MarketplaceId é um filtro obrigatório na consultar Selecionar. Você pode seguir a consultar abaixo para obter os valores necessários através do SQL:

SELECT * FROM ReturnPolicies WHERE MarketplaceId='EBAY_US'

Alguns dos campos são nomeados com o sufixo Aggr. Esses campos exibem o conteúdo da tag JSON com o mesmo nome que é retornado do endpoint da API.

Colunas
Nome Tipo Descrição
ReturnPolicyId [KEY] String Um ID exclusivo atribuído pelo eBay para esta política.
Description String A descrição definida pelo vendedor da política de devolução para uso interno (esse valor não é exibido para usuários finais).
Name String O tipo de categoria ao qual a apólice se aplica (veículos motorizados ou veículos não motorizados).
CategoryTypesName String O tipo de categoria ao qual a apólice se aplica (veículos motorizados ou veículos não motorizados).
MarketplaceId String A ID do mercado do eBay ao qual esta política de devolução se aplica.
ExtendedHolidayReturnsOffered String Se definido como verdadeiro, o vendedor oferece uma política de Devolução de Férias Estendida para suas listagens.
InternationalOverrideAggr String Se preenchido, especifica as políticas do vendedor para devoluções internacionais (itens que exigem postagem por meio de um serviço de remessa internacional).
RefundMethod String Indica o método que o vendedor usa para compensar o comprador pelos itens devolvidos. O método de retorno especificado se aplica apenas a retornos de remorso.
RestockingFeePercentage String Para vendedores que aceitam devoluções, este campo é preenchido se eles cobrarem dos compradores uma taxa de reabastecimento quando os itens forem devolvidos.
ReturnInstructions String Contém a explicação detalhada do vendedor para sua política de devolução e é exibida na seção Política de devolução da página Exibir item.
ReturnMethod String Válido apenas no mercado dos EUA, este campo opcional indica serviços adicionais (além de devolução do dinheiro) que os vendedores podem oferecer aos compradores para devoluções a remorso.
ReturnPeriodValue String Especifica o tempo que o comprador tem para devolver um item.
ReturnPeriodUnit String Especifica a unidade de medida de tempo que o comprador tem para devolver um item.
ReturnsAccepted Boolean Se definido como verdadeiro, o vendedor aceita devoluções.
ReturnShippingCostPayer String Este campo indica quem é responsável pelo pagamento das despesas de envio dos itens devolvidos. O campo pode ser definido como COMPRADOR ou VENDEDOR.

Transportadoras

Consultar transportadoras suportadas pelo site especificado.

Colunas
Nome Tipo Descrição
ShippingCarrierId Integer Identificador numérico.
Description String String de exibição que os aplicativos podem usar para apresentar uma lista de transportadoras em um formato mais amigável (como em uma lista suspensa).
DetailVersion String Retorna o número da versão mais recente para este campo.
ShippingCarrier String O código da transportadora.
UpdateTime Datetime Fornece a hora em GMT em que os sinalizadores de recursos para os detalhes foram atualizados pela última vez.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Uma designação de que tipo de informação você deseja retornar para o site eBay especificado. Os valores permitidos são ShippingCarrierDetails.

Categorias de Envio

Uma categoria de serviço de frete compatível com o site.

Colunas
Nome Tipo Descrição
ShippingCategory [KEY] String Indica a categoria de envio. As categorias de envio incluem as seguintes: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER e NONE. Os serviços de remessa internacional geralmente são agrupados na categoria NONE. Para obter mais informações sobre essas categorias de remessa e quais serviços se enquadram em cada categoria, consulte a página Noções básicas de remessa no site da Central de remessas do eBay.
Description String String de exibição que os aplicativos podem usar para apresentar uma lista de categorias de remessa em um formato mais amigável (como em uma lista suspensa). Este campo é localizado por site.
DetailVersion String Retorna o número da versão mais recente para este campo. A versão pode ser usada para determinar se e quando atualizar os dados do cliente em cache.
UpdateTime Datetime Fornece a hora em GMT em que os sinalizadores de recursos para os detalhes foram atualizados pela última vez. Esse carimbo de data/hora pode ser usado para determinar se e quando atualizar os dados do cliente em cache.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Uma designação de que tipo de informação você deseja retornar para o site eBay especificado. Os valores permitidos são ShippingCategoryDetails.

Locais de Envio

Lista as regiões e locais suportados pelos serviços de remessa do eBay. Retorna todos os locais de envio suportados pelo eBay, independentemente do site especificado na solicitação.

Colunas
Nome Tipo Descrição
ShippingLocation [KEY] String Nome curto ou abreviação de uma região (por exemplo, Ásia) ou local (por exemplo, Japão).
Description String String de exibição que os aplicativos podem usar para apresentar uma lista de locais de remessa em um formato mais amigável (como em uma lista suspensa). Este campo está localizado no idioma do site.
DetailVersion String Retorna o número da versão mais recente para este campo. A versão pode ser usada para determinar se e quando atualizar os dados do cliente em cache.
UpdateTime Datetime Fornece a hora em GMT em que os sinalizadores de recursos para os detalhes foram atualizados pela última vez. Esse carimbo de data/hora pode ser usado para determinar se e quando atualizar os dados do cliente em cache.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Uma designação de que tipo de informação você deseja retornar para o site eBay especificado. Os valores permitidos são ShippingLocationDetails.

Serviços de Transporte

Consulte os serviços de remessa suportados pelo site eBay especificado.

Informações Específicas da Tabela
Selecione

A consultar a seguir recupera todos os serviços de remessa disponíveis. Não há filtros suportados para esta exibição.

SELECT * FROM ShippingServices
Colunas
Nome Tipo Descrição
ShippingServiceId [KEY] Integer Identificador numérico. Um valor maior que 50000 representa um serviço de remessa internacional.
CODService Boolean Este sinalizador é retornado como verdadeiro se o valor ShippingService correspondente for um serviço COD (Cash-On-Delivery).
CostGroupFlat Boolean Se retornado, este é o grupo de serviço de frete ao qual o serviço de frete pertence.
Description String Uma descrição amigável das opções de serviço de remessa.
DetailVersion String Retorna o número da versão mais recente para este campo.
DimensionsRequired Boolean Se a opção de serviço de frete exige que as dimensões do pacote sejam fornecidas pelo vendedor.
ExpeditedService Boolean Indica se o serviço de frete é um serviço de frete expresso. Retornado apenas para sites para os quais o recurso Get It Fast está ativado e somente se verdadeiro.
InternationalService Boolean Indica se o serviço de frete é um serviço de frete internacional.
MappedToShippingServiceId Integer A ID de outro serviço de frete que será usado quando um serviço de frete for preterido.
ShippingCategory String Indica a categoria de envio. As categorias de envio incluem as seguintes: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER e NONE. Os serviços de remessa internacional geralmente são agrupados na categoria NONE.
ShippingService String O nome da opção de serviço de frete. Se a coluna ValidForSellingFlow não for verdadeira, essa opção de serviço de remessa específica não é mais válida e não pode ser oferecida aos compradores por meio de uma listagem.
ShippingTimeMax Integer O número máximo garantido de dias que a transportadora levará para enviar um item (sem incluir o tempo que o vendedor leva para entregar o item à transportadora). Sempre retornado quando ExpeditedService é verdadeiro ou se definido para um determinado serviço.
ShippingTimeMin Integer O número mínimo garantido de dias que a transportadora levará para enviar um item (sem incluir o tempo que o vendedor leva para entregar o item à transportadora). Sempre retornado quando ExpeditedService é verdadeiro ou se definido para um determinado serviço.
SurchargeApplicable Boolean Verdadeiro se uma sobretaxa se aplica a qualquer região para a qual este serviço é enviado.
UpdateTime Datetime Fornece a hora em GMT em que os sinalizadores de recursos para os detalhes foram atualizados pela última vez.
ValidForSellingFlow Boolean Se este campo for retornado como verdadeiro, pode ser utilizada a opção de serviço de frete. Se este campo for retornado como falso, a opção de serviço de frete não é suportada no momento.
WeightRequired Boolean Se verdadeiro, um vendedor que seleciona este tipo de pacote para a listagem e oferece este serviço de frete deve especificar WeightMajor e WeightMinor na definição do item. Se não for retornado, WeightRequired será falso.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Uma designação de que tipo de informação você deseja retornar para o site eBay especificado. Os valores permitidos são ShippingServiceDetails.

Sites

Lista todos os sites eBay disponíveis e seus números de SiteID associados.

Colunas
Nome Tipo Descrição
SiteID Integer Identificador numérico para um site do eBay. Se você estiver usando a API SOAP, use IDs de site numéricos na URL de solicitação. Se você estiver usando a API XML, use IDs de site numéricos no cabeçalho X-EBAY- API -SITEID.
SiteName String Nome curto que identifica um site do eBay. Normalmente, um site do eBay está associado a um determinado país ou região (por exemplo, EUA ou Bélgica_Francês). Sites especializados (por exemplo, Lojas eBay) usam o mesmo ID de site que o site eBay principal associado. O site eBay Motors dos EUA é uma exceção a essa convenção.
DetailVersion String Retorna o número da versão mais recente para este campo. A versão pode ser usada para determinar se e quando atualizar os dados do cliente em cache.
UpdateTime Datetime Fornece a hora em GMT em que os sinalizadores de recursos para os detalhes foram atualizados pela última vez. Esse carimbo de data/hora pode ser usado para determinar se e quando atualizar os dados do cliente em cache.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
DetailName String Uma designação de que tipo de informação você deseja retornar para o site eBay especificado. Os valores permitidos são SiteDetails.

Produtos Mais Vendidos

Consulte seus produtos mais vendidos no eBay.

Informações Específicas da Tabela
Selecione

As únicas colunas que podem ser usadas para filtrar são AffiliateCustomId, AffiliateNetworkId e AffiliateTrackingId. Esses filtros são opcionais.

SELECT * FROM TopSellingProducts
SELECT * FROM TopSellingProducts WHERE AffiliateCustomId='12345'
Colunas
Nome Tipo Descrição
Title String O título do produto, conforme especificado no catálogo.
ProductId String O eBay ou IDs externos associados ao produto. Use esse valor como entrada para pesquisar o mesmo produto no futuro ou use o valor ISBN, EAN ou UPC (se retornado). Os valores ProductId podem ser usados para recuperar produtos, listas de itens ou guias e revisões. Comprimento máximo: 4000.
ProductURL String URL totalmente qualificado para informações opcionais sobre o produto, como a descrição ou os créditos de um filme. Essas informações são hospedadas no site do eBay e não podem ser editadas. Partes do conteúdo são protegidas por direitos autorais. Este link permite que os usuários visualizem detalhes descritivos adicionais sobre o produto.
ImageURL String URL totalmente qualificado para uma imagem de estoque (se houver) associada ao produto do catálogo do eBay. A URL é para a imagem que o eBay geralmente exibe nos resultados da pesquisa de produtos (geralmente 70px de altura). Pode ser útil calcular as dimensões da foto programaticamente antes de exibi-la. Retornado apenas se um URL estiver disponível para o produto.
CatalogName String Nome do catálogo em que o produto está. Devolvido apenas se o produto estiver em um catálogo.
ReviewCount Long O número total de avaliações disponíveis para este produto no site do eBay.
HighestPrice Decimal O preço mais alto para itens listados como este produto.
LowestPrice Decimal O preço mais baixo para itens listados como este produto.
Currency String O código de moeda de três dígitos conforme definido na ISO 4217.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
AffiliateCustomId String Não precisa ser especificado. Você pode usar essa pseudocoluna se quiser aproveitá-la para monitorar melhor seus esforços de marketing. Se você estiver usando a rede de parceiros do eBay e fornecer um AffiliateCustomId, o URL de rastreamento retornado pela rede de parceiros do eBay conterá o AffiliateUserId.
AffiliateNetworkId String Especifica seu parceiro de rastreamento para comissões afiliadas.
AffiliateTrackingId String O valor especificado é obtido de seu parceiro de rastreamento.

TransaçõesPagamentos

Consultar todos os pagamentos das transações em que o usuário autenticado seja o comprador ou o vendedor. Por padrão, são devolvidos apenas os pagamentos das transações realizadas nos últimos 90 dias. Os pagamentos das transações em pedidos com mais de 90 dias podem ser recuperados especificando OrderIds.

Ver Informações Específicas
Selecione

Exemplos de consulta à visualização TransactionPayments:

SELECT * FROM TransactionPayments WHERE OrderRole = 'Seller'

SELECT * FROM TransactionPayments WHERE OrderId = '110277719772-28859911001'
Colunas
Nome Tipo Descrição
TransactionReferenceId [KEY] String Um ID de transação exclusivo para o pagamento.
TransactionId String O identificador exclusivo da transação para a qual o pagamento foi feito.
OrderId String O identificador exclusivo do pedido para o qual o pagamento foi feito.
FeeOrCreditAmount Decimal Valor da taxa é um valor positivo e Valor do crédito é um valor negativo.
Payee String A pessoa ou organização que deve receber a alocação de pagamento.
Payer String Este campo indica o usuário do eBay ou parceiro do eBay que enviou o pagamento.
PaymentAmount Decimal O valor do pagamento que é alocado ao beneficiário.
PaymentStatus String O status atual de um pagamento do comprador alocado a um beneficiário especificado.
PaymentTime Datetime A data e a hora em que o pagamento é recebido pelo beneficiário.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CreateTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar detalhes de pagamento das transações em pedidos criados nesse intervalo de datas. Por padrão, o intervalo de datas é de 90 dias.
CreateTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar detalhes de pagamento das transações em pedidos criados dentro desse intervalo de datas. Por padrão, o intervalo de datas é de 90 dias.
ModTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar detalhes de pagamento das transações em pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
ModTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar os detalhes de pagamento das transações em pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
NumberOfDays Integer Todos os detalhes de pagamento do eBay das transações em pedidos que foram criados ou modificados nesse período são retornados na saída. Mín.: 1. Máx.: 30.
OrderRole String Filtra os detalhes de pagamento retornados das transações com base na papel do usuário. A papel do usuário é comprador ou vendedor.
OrderStatus String Filtra os detalhes de pagamento devolvidos das transações com base no status do pedido. Valores aplicáveis: Ativo, Todos, Concluído, Inativo.

Transações

Consulte todas as transações nas quais o usuário autenticado é o comprador ou o vendedor. Por padrão, são retornadas apenas as transações de pedidos feitos nos últimos 90 dias. As transações de pedidos com mais de 90 dias podem ser recuperadas especificando OrderId.

Ver Informações Específicas
Selecione

Exemplos de consulta da exibição Transações.

Select * FROM Transactions WHERE OrderRole = 'Seller'

Select * FROM Transactions WHERE OrderId = '110276240386-28854859001'

Select * FROM Transactions WHERE CreateTimeFrom = '2/10/2018' And CreateTimeTo = '3/16/2018'
Colunas
Nome Tipo Descrição
TransactionId [KEY] String Identificador exclusivo para um item de linha de pedido do eBay. Um item de linha de pedido é criado quando há um compromisso de um comprador para comprar um item.
OrderId String O ID que identifica exclusivamente a listagem de itens. O ID é gerado pelo eBay depois que um item é listado. Você não pode escolher ou revisar esse valor.
ItemId String O identificador exclusivo da listagem do eBay. Esse identificador é gerado pelo eBay e retornado na resposta de uma chamada Adicionar se um item for listado com sucesso.
ItemSite String O nome do site no qual o item está listado.
ItemTitle String Este campo é usado para especificar o título da listagem.
ActualHandlingCost Decimal O custo de manuseio cobrado pelo vendedor pelo item de linha do pedido.
ActualShippingCost Decimal O custo de envio pago pelo comprador para o item de linha do pedido. Este campo só é retornado após a conclusão do checkout.
BuyerEmail String Endereço E-mail do usuário.
BuyerFirstName String O primeiro nome do comprador que comprou o pedido.
BuyerLastName String O sobrenome do comprador que comprou o pedido.
CreatedDate Datetime Indica a hora de criação do item de linha do pedido.
Price Decimal O preço do item de linha do pedido.
SiteId String O site no qual o item de linha do pedido (transação) foi criado.
PaidTime Datetime Indica a hora em que o pedido foi marcado como pago.
DigitalRecipientEmail String Este campo exibe o endereço e-mail do remetente/comprador do vale-presente digital.
DigitalRecipientName String Este campo exibe o nome real (não o ID de usuário do eBay) do remetente/comprador do vale-presente digital.
DigitalSenderEmail String Este campo exibe o endereço e-mail do remetente/comprador do vale-presente digital.
DigitalSenderName String Este campo exibe o nome real (não o ID de usuário do eBay) do remetente/comprador do vale-presente digital
DigitalDeliveryMethod String Esse valor indica a forma como o vale-presente digital será entregue ao comprador.
EBayPlusTransaction Boolean Se verdadeiro, esta transação é para um item que foi comprado no programa eBay Plus.
ExternalTransactionId String Identificador exclusivo para um pagamento do PayPal de um pedido do eBay.
ExternalTransactionStatus String O status de processamento atual de um pagamento do PayPal para um pedido do eBay.
ExternalTransactionTime Datetime Carimbo de data/hora para transação de pagamento.
ExternalFeeOrCreditAmount Decimal Valor da taxa é um valor positivo e Valor do crédito é um valor negativo.
ExternalPaymentOrRefundAmount Decimal Se positivo, o valor que o comprador paga ao vendedor por meio do PayPal na compra dos itens. Se negativo, o valor reembolsado ao comprador. Padrão = 0.
FinalValueFee Decimal Uma taxa de valor final é calculada e cobrada na conta do vendedor imediatamente após a criação de um item de linha de pedido.
GuaranteedDelivery Boolean Este campo é retornado como verdadeiro se o item de linha do pedido for qualificado para Entrega Garantida do eBay ou falso se não for elegível.
GuaranteedShipping Boolean Este campo é retornado como verdadeiro se o vendedor optar por usar o recurso Envio Garantido do eBay no momento da listagem.
InvoiceSentTime Datetime Este campo indica a data/hora em que uma fatura do pedido foi enviada do vendedor ao comprador.
DigitalStatus String Esse valor de enumeração indica o estado atual de um vale-presente digital adquirido.
InquiryStatus String Este campo fornece o status da Consulta de Item Não Recebido (INR) de um comprador.
ReturnStatus String Este campo fornece o status da solicitação de devolução de um comprador.
TotalTaxAmount Decimal Esse valor indica o valor total do imposto para o item de linha do pedido, incluindo o imposto sobre vendas do item, o imposto sobre vendas sobre remessa e manuseio e qualquer taxa de reciclagem de lixo eletrônico.
UnpaidItemStatus String Este campo indica o status do caso Item não pago. Esse campo sempre é retornado com o contêiner UnpaidItem.
UnpaidItemType String Este campo indica se a caixa Item não pago foi aberta manualmente pelo cliente ou aberta automaticamente pelo recurso Assistente de item não pago do eBay.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CreateTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar transações de pedidos criados nesse intervalo de datas.
CreateTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar transações de pedidos criados nesse intervalo de datas.
ModTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar transações de pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
ModTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar transações de pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
NumberOfDays Integer Todas as transações do eBay que foram criadas ou modificadas nesse período são retornadas na saída. Mín.: 1. Máx.: 30.
OrderRole String Filtra as transações retornadas com base na papel do usuário. A papel do usuário é comprador ou vendedor.
OrderStatus String Filtra as transações retornadas com base no status do pedido. Valores aplicáveis: Ativo, Todos, Concluído, Inativo.

TransaçãoEnvio

Consulte os detalhes de envio das transações em que o usuário autenticado é o comprador ou o vendedor. Por defeito, são devolvidos apenas os dados de envio das transacções efectuadas nos últimos 90 dias. Os detalhes de envio das transações em pedidos com mais de 90 dias podem ser recuperados especificando OrderIds.

Ver Informações Específicas
Selecione

Exemplos de consulta à visualização TransactionShipping:

SELECT * FROM TransactionShipping WHERE ModTimeFrom = '2/22/2018' And ModTimeTo = '3/4/2018'

SELECT * FROM TransactionShipping WHERE OrderId = '110277719772-28859911001'

SELECT * FROM TransactionShipping WHERE OrderId IN ('110277719772-28859911001', '110276240386-28854859001')
Colunas
Nome Tipo Descrição
TransactionId [KEY] String Identificador exclusivo da transação.
OrderId String Identificador exclusivo do pedido.
InternationalPackagingHandlingCosts Decimal Taxas que um vendedor pode cobrar pelo envio do item (além do que o serviço de envio possa cobrar).
OriginatingPostalCode String Código postal do local de onde o pacote será enviado.
PackagingHandlingCosts Decimal Taxas que um vendedor pode cobrar pelo envio do item (além do que o serviço de envio possa cobrar).
ShippingIrregular Boolean Este campo booleano indica que o pacote de remessa é considerado uma forma e/ou tamanho irregular pela transportadora e, portanto, requer tratamento especial.
ExpeditedService Boolean Indica se o serviço é um serviço de remessa acelerada.
ShippingImportCharge Decimal O custo total de alfândega e impostos para o trecho internacional de um pedido enviado usando o Programa de remessa global.
ShippingInsuranceCost Decimal O custo do seguro associado ao envio de um único item com este serviço de envio.
ShippingServiceAdditionalCost Decimal O custo de envio de cada item adicional se o mesmo comprador comprar várias quantidades do mesmo item de linha.
ShippingServiceCost Decimal O custo base do envio do item usando o serviço de envio especificado no campo ShippingService.
ActualDeliveryTime Datetime Esse carimbo de data/hora indica quando o pedido foi realmente entregue ao comprador.
EstimatedDeliveryTimeMax Datetime Os timestamps EstimatedDeliveryTimeMin e EstimatedDeliveryTimeMax indicam a janela durante a qual o comprador pode esperar a entrega.
EstimatedDeliveryTimeMin Datetime Os timestamps EstimatedDeliveryTimeMin e EstimatedDeliveryTimeMax indicam a janela durante a qual o comprador pode esperar a entrega.
HandleByTime Datetime Esse carimbo de data/hora indica a última data/hora em que o vendedor deve enviar o pacote para garantir que o pacote chegue ao comprador dentro da janela de entrega estimada.
ScheduledDeliveryTimeMax Datetime Os timestamps ScheduledDeliveryTimeMin e ScheduledDeliveryTimeMax indicam a janela de entrega para a qual o comprador pode esperar receber o pedido.
ScheduledDeliveryTimeMin Datetime Os timestamps ScheduledDeliveryTimeMin e ScheduledDeliveryTimeMax indicam a janela de entrega para a qual o comprador pode esperar receber o pedido.
ShippingTrackingEvent String Esse valor de enumeração indica se o pedido foi ou não retirado da loja indicada pelo valor StoreID.
StoreId String O identificador único da loja de onde o pedido será entregue.
ShipmentTrackingNumbers String Os números de rastreamento atribuídos pelas transportadoras.
ShippingCarriers String O nome das transportadoras usadas para enviar os itens.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
CreateTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar os detalhes de remessa das transações em pedidos criados nesse intervalo de datas. Por padrão, o intervalo de datas é de 90 dias.
CreateTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar os detalhes de remessa das transações em pedidos criados nesse intervalo de datas. Por padrão, o intervalo de datas é de 90 dias.
ModTimeFrom Datetime Especifica o início do intervalo de datas para o qual recuperar detalhes de remessa das transações em pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
ModTimeTo Datetime Especifica o final do intervalo de datas para o qual recuperar detalhes de remessa das transações em pedidos modificados nesse intervalo de datas. O intervalo de tempo máximo que pode ser especificado é de 30 dias.
NumberOfDays Integer Todos os detalhes de remessa do eBay das transações em pedidos que foram criados ou modificados nesse período são retornados na saída. Mín.: 1. Máx.: 30.
OrderRole String Filtra os detalhes de envio devolvidos das transações com base na papel do usuário. A papel do usuário é comprador ou vendedor.
OrderStatus String Filtra os detalhes de envio devolvidos das transações com base no status do pedido. Valores aplicáveis: Ativo, Todos, Concluído, Inativo.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados do Ebay

Nome Descrição
AddItem Crie e publique uma nova listagem de itens em um site do eBay.
CompleteSale Realize várias tarefas após a criação de um único item de linha ou pedido de vários itens de linha. Por exemplo, conclua uma venda e deixe um feedback.
CreateDSRSummery Recupere um relatório resumido de DSR, incluindo a precisão da descrição, comunicação, envio, etc. Essas informações podem ajudar os vendedores a determinar como práticas comerciais específicas podem estar contribuindo para pontuações DSR mais altas ou mais baixas.
CreateReport Começa a processar os dados para download de um arquivo de relatório.
GetOAuthAccessToken Obtém o token de acesso OAuth do eBay.
GetOAuthAuthorizationURL Obtém o URL de autorização do eBay. Acesse a URL retornada na saída em um navegador da Internet. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para o eBay.
GetReport Baixa um relatório que foi criado anteriormente com o procedimento armazenado CreateReport. Para baixar o relatório, seu status deve ser Concluído.
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com o eBay.
SetUserNotes Adicione, substitua e exclua notas do My eBay para itens que estão sendo rastreados nas áreas de compra e venda do My eBay.
UploadFile Carrega um arquivo para a conta do eBay.

Adicionar Item

Crie e publique uma nova listagem de itens em um site do eBay.

Procedimento Armazenado* Informações Específicas

Após a criação bem-sucedida de uma Listagem de Item, um ID de Item é retornado na resposta junto com as taxas estimadas para listar o Item. Depois de adicionar um item, você pode usar a tabela ItemListing para atualizar, excluir e consultar.

As entradas necessárias para adicionar qualquer item são as seguintes: Title, Description, CategoryId, StartPrice, ConditionId, Country, Currency, DispatchTimeMax, ListingDuration, ListingType, PaymentMethod, PayPalEmailAddress, Quantity, Location e ReturnsAcceptedOption.

Você também precisa especificar várias entradas necessárias para selecionar um tipo de remessa: Plana ou Calculada. Ambos os tipos de remessa exigem que um ShippingService seja especificado.

Adicionar um item

Você pode seguir o procedimento abaixo para obter os valores necessários e adicionar um item através do SQL:

  1. Use a exibição Categorias para selecionar uma categoria de nível superior; por exemplo, Livros. Você pode usar a seguinte consultar:

    SELECT * FROM Categories
    
  2. Use a exibição Categorias para selecionar uma categoria de folha; por exemplo, Ficção e Literatura. Um ID de categoria de folha é necessário para adicionar um item. Você pode usar uma consultar como a seguinte:

    SELECT * FROM Categories WHERE CategoryParentId='267'
    
  3. Use a exibição ShippingServices para selecionar um serviço de remessa. O valor da coluna ValidForSellingFlow deve ser true; caso contrário, essa opção de serviço de frete específica não será mais válida e não poderá ser oferecida aos compradores por meio de uma listagem.

Selecionando frete fixo

As entradas a seguir são necessárias para o tipo de remessa Simples: ShippingType, ShippingService, ShippingServicePriority e ShippingServiceCost.

Selecionando frete calculado

O tipo de envio calculado requer informações adicionais relacionadas às estatísticas do pacote. As entradas a seguir são necessárias para esse tipo de remessa: ShippingType, WeightMajor, WeightMinor, OriginatingPostalCode, ShippingService e ShippingServicePriority.

Note: Este procedimento faz uso de indexed parameters. Esses parâmetros de entrada são indicados com um # no final de seus nomes.

Os parâmetros indexados facilitam o fornecimento de várias instâncias de um único parâmetro como entradas para o procedimento.

Suponha que haja um parâmetro de entrada chamado Param#. Insira várias instâncias de um parâmetro indexado como este:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Entrada
Nome Tipo Obrigatório Descrição
Title String Falso Nome do item conforme aparece na listagem ou nos resultados da pesquisa.
Description String Falso A descrição do item pelo vendedor. Nas solicitações de listagem, você pode usar tags CDATA para enviar sua descrição se desejar usar caracteres HTML ou XML reservados na descrição.
CategoryId String Falso ID da categoria para a primeira (ou única) categoria na qual o item está listado (ou será listado, se o item for novo).
StartPrice String Falso O preço original do item no momento da listagem ou relistagem. Se esse valor mudar quando o item for revisado, o novo valor se tornará o preço original.
ConditionId String Falso Um identificador para a condição do item. Por exemplo, 1.000 para Novo ou 3.000 para Usado.
Country String Falso Define o código de país ISO 3166 de 2 letras.
Currency String Falso Moeda associada às informações de preço do item. Código de moeda ISO 4217 de 3 letras.
DispatchTimeMax String Falso Especifica o número máximo de dias úteis que o vendedor se compromete a preparar um item para ser enviado após receber um pagamento compensado. Este tempo não inclui o tempo de envio (o tempo de trânsito da transportadora).
ListingDuration String Falso Descreve o número de dias que o vendedor deseja que o anúncio fique ativo (disponível para licitação/compra).
ListingType String Falso O formato da listagem que o vendedor deseja usar, como leilão chinês ou preço fixo.
PaymentMethod String Falso Identifica o método de pagamento (como PayPal) que o vendedor aceitará quando o comprador pagar pelo item. Use a exibição CategoryFeatures para localizar os métodos de pagamento disponíveis para uma categoria.
PayPalEmailAddress String Falso O endereço e-mail do PayPal do vendedor.
Quantity String Falso O valor da Quantidade para listagens de leilão deve ser sempre 1. Para uma listagem de preço fixo, o valor da Quantidade indica o número de itens idênticos que o vendedor tem disponível para venda na listagem.
Location String Falso Indica a localização geográfica do item (juntamente com o País). Ao revisar uma listagem, você pode adicionar ou alterar esse valor somente se a listagem não tiver lances (ou nenhum item tiver sido vendido) e não terminar em 12 horas.
ReturnsAcceptedOption String Falso Indica se o vendedor permite que o comprador devolva o item. Um dos seguintes valores: ReturnsAccepted ou ReturnsNotAccepted. Se você especificar ReturnsNotAccepted, a página Exibir item indicará que as devoluções não são aceitas.
Sku String Falso Um valor SKU (Stock Keeping Unit) é um identificador definido pelo vendedor para um produto.
ShippingType String Falso O modelo de custo de envio oferecido pelo vendedor.
FreeShipping String Falso Especifica que o vendedor deseja oferecer frete grátis. Isso se aplica apenas ao primeiro serviço de remessa doméstica especificado e será ignorado se for definido para qualquer outro serviço de remessa.
ShippingService String Falso Uma opção de serviço de remessa oferecida pelo vendedor para enviar um item a um comprador. Para obter uma lista de valores válidos de ShippingService, consultar a visualização ShippingServices; o ShippingService retornado deve ter um valor true na coluna ValidForSellingFlow.
ShippingServiceCost String Falso O custo base do envio do item usando o serviço de envio especificado no campo ShippingService, se um tiver sido especificado. Esta coluna inclui o custo de embalagem e manuseio para frete fixo e calculado. Se for para frete calculado para uma listagem que ainda não foi encerrada, observe que o custo não pode ser determinado até que a listagem seja encerrada e o comprador tenha especificado um código postal. Esse valor reflete a economia de uma opção de serviço de frete promocional. Também aplicável a Half.com.
ShippingServicePriority String Falso Esse valor inteiro controla o pedido (relativo a outros serviços de remessa) no qual o ShippingService correspondente aparecerá na página Ver Item e Check-out. Os vendedores podem especificar até quatro serviços de remessa doméstica.
ShippingServiceAdditionalCost String Falso O custo de envio de cada item adicional se o mesmo comprador comprar várias quantidades do mesmo item de linha. Se for menor que ShippingServiceCost, esta coluna dará ao comprador um desconto de frete. Este campo é obrigatório ao criar uma listagem de preço fixo de quantidade múltipla. Este campo não é aplicável para listagens de quantidade única.
CalculatedShippingMeasurementSystem String Falso Sistema de medição (por exemplo, inglês).
CalculatedShippingMeasurementUnit String Falso Especifica o tipo de unidade de peso e dimensões de um pacote de remessa.
CalculatedShippingPackageLength String Falso Comprimento do pacote, em um número inteiro de polegadas (inglês) ou centímetros (métrico), necessário para enviar o item.
CalculatedShippingPackageDepth String Falso Profundidade do pacote, em um número inteiro de polegadas (inglês) ou centímetros (métrico), necessário para enviar o item.
CalculatedShippingPackageWidth String Falso Largura do pacote, em um número inteiro de polegadas (inglês) ou centímetros (métrico), necessário para enviar o item.
ShippingPackage String Falso A natureza do pacote usado para enviar o(s) item(ns). Necessário apenas para envio calculado.
WeightMajor String Falso A unidade principal usada para especificar o peso de um pacote de remessa. Por exemplo, libras.
WeightMinor String Falso A unidade menor usada para especificar o peso de um pacote de remessa. Por exemplo, onças.
OriginatingPostalCode String Falso Código postal do local de onde o pacote será enviado. Necessário para envio calculado. Use Item.PostalCode para especificar o local do item usado para pesquisas por local.
CategoryMappingAllowed String Falso Controla como o eBay lida com casos em que a categoria não existe mais na estrutura de categoria atual: Se verdadeiro, o eBay usará o novo ID para a listagem; se falso, um erro é retornado.
BestOfferEnabled String Falso Este campo indica se o recurso Melhor Oferta está ou não habilitado para este item.
LinkedPayPalAccount String Falso O vendedor inclui e define esse campo como verdadeiro como um mecanismo para bloquear licitantes que não tenham uma conta do PayPal vinculada à sua conta do eBay.
MaximumBuyerPolicyViolations String Falso Esse valor inteiro define o número máximo de violações da política do comprador que um comprador em potencial pode ter durante um período de tempo especificado (MaximumBuyerPolicyViolationsPeriod) antes de ser impedido de comprar/fazer lances no item.
MaximumBuyerPolicyViolationsPeriod String Falso Esse valor define o período de tempo durante o qual as violações da política do comprador para um comprador em potencial serão contadas.
MaximumItemCount String Falso O número máximo de itens que um comprador pode comprar do vendedor durante um período de 10 dias antes de ser impedido de comprar/fazer lances no item.
MaximumUnpaidItemStrikesInfo String Falso O número máximo de avisos de itens não pagos que um comprador em potencial pode ter durante um período de tempo especificado (MaximumUnpaidItemStrikesInfoPeriod) antes de ser impedido de comprar/fazer lances no item.
MaximumUnpaidItemStrikesInfoPeriod String Falso O período de tempo durante o qual o item não pago será cobrado de um comprador em potencial. Se o número de greves de itens não pagos durante esse período definido exceder o valor definido no campo MaximumUnpaidStrikesInfo, esse comprador em potencial será impedido de comprar/fazer lances no item.
MinimumFeedbackScore String Falso O vendedor inclui este campo como um mecanismo para bloquear licitantes que tenham uma Pontuação de Feedback inferior ao valor especificado.
ShipToRegistrationCountry String Falso O vendedor inclui e define esse campo como verdadeiro como um mecanismo para bloquear licitantes que residem (de acordo com seu endereço de remessa principal do eBay) em países que estão na lista de exclusão de envio.
VerifiedUser String Falso Para impedir que usuários não verificados comprem/atribuam lances em seus itens, o vendedor deve incluir este campo e definir seu valor como verdadeiro.
ZeroFeedbackScore String Falso Este recurso de requisitos do comprador está disponível apenas para vendedores no site da China e é aplicável apenas a itens de preço fixo ou de leilão Compre agora.
CategoryBasedAttributesPrefill String Falso Se verdadeiro, o eBay preencherá automaticamente alguns dos valores de itens específicos com base na categoria (ou categorias) da listagem. Por exemplo, marca, tamanho ou cor.
StoreCategoryId String Falso Identificador exclusivo de uma categoria personalizada principal na qual listar o item.
StoreCategoryName String Falso Nome da categoria de uma categoria personalizada principal na qual listar o item.
StoreCategoryId2 String Falso Identificador exclusivo para a categoria personalizada secundária na qual listar o item.
StoreCategoryName2 String Falso Nome da categoria personalizada secundária na qual listar o item.
LiveAuction String Falso Este campo deve ser incluído e definido como verdadeiro se a listagem fizer parte de um leilão ao vivo. Este campo booleano é retornado como verdadeiro na tabela ItemList se a listagem fizer parte de um leilão ao vivo. Consulte a página inicial dos leilões ao vivo do eBay para obter mais informações sobre os leilões ao vivo no eBay.com.
LotSize String Falso Um lote é um conjunto de dois ou mais itens semelhantes incluídos em uma única listagem que devem ser adquiridos juntos em um único item de linha de pedido. O valor LotSize é o número de itens no lote. Este campo é obrigatório se dois ou mais itens estiverem incluídos em uma listagem.
DaysToFullPayment String Falso Este valor inteiro indica o número de dias que um comprador tem (depois de se comprometer a comprar) para efetuar o pagamento integral ao vendedor e fechar o saldo remanescente de um veículo motorizado. Os valores válidos são 3, 7 (padrão), 10 e 14. Voltar para o início
PostalCode String Falso Código postal do local onde o item está localizado. Este valor é usado para pesquisas de proximidade.
Brand String Falso A marca do produto. O eBay pesquisa os nomes que estão publicamente disponíveis em seus catálogos de produtos. Isso significa que você pode especificar o nome da marca conhecida que um usuário comum reconheceria. Ambos Brand e MPN devem ser especificados se a coluna BrandMPN for usada.
BrandMPN String Falso O número de peça do fabricante do produto. Use o valor especificado pelo fabricante.
EAN String Falso Aplicável apenas para listar casos de uso (não para pesquisa do lado do comprador). EAN é um identificador exclusivo de 8 ou 13 dígitos que muitos setores (como editores de livros) usam para identificar produtos.
IncludeeBayProductDetails String Falso Este campo booleano controla se um produto do catálogo do eBay é ou não usado para ajudar a criar ou revisar uma lista de itens.
IncludeStockPhotoURL String Falso Se verdadeiro, indica que a listagem do item inclui a foto do estoque.
ISBN String Falso Aplicável apenas para listar casos de uso (não para pesquisa do lado do comprador). ISBN é um identificador exclusivo para livros (um padrão internacional). Especifique um ISBN de 10 ou 13 caracteres.
ProductId String Falso O identificador exclusivo de uma versão específica de um produto.
ProductReferenceId String Falso O ID de referência global curto para um produto de catálogo.
UPC String Falso Aplicável apenas para listar casos de uso (não para pesquisa do lado do comprador). UPC é um identificador exclusivo de 12 caracteres que muitos setores usam para identificar produtos.
UseStockPhotoURLAsGallery String Falso Se verdadeiro, indica que a foto de estoque de um item (se disponível) é usada como miniatura da galeria. IncludeStockPhotoURL também deve ser true e Item.
MinimumRemnantSet String Falso Permite que você (o vendedor) evite ficar com 1 item em sua listagem. Um caso de uso típico são ingressos para eventos em assentos adjacentes reservados ou itens que normalmente só são vendidos se mais de 1 puder ser comprado de uma vez.
ScheduleTime String Falso Permite que o usuário especifique a hora em que a listagem se torna ativa no eBay.
PaymentProfileId String Falso O identificador exclusivo de um perfil de pagamento de políticas de negócios. Um PaymentProfileId ou PaymentProfileName pode ser especificado.
PaymentProfileName String Falso O nome de um perfil de pagamento de políticas de negócios. Um PaymentProfileId ou PaymentProfileName pode ser especificado.
ReturnProfileId String Falso O identificador exclusivo de um perfil de política de devolução de políticas de negócios. Um ReturnProfileId ou ReturnProfileName pode ser especificado.
ReturnProfileName String Falso O nome de um perfil de política de retorno de Políticas de Negócios. Um ReturnProfileId ou ReturnProfileName pode ser especificado.
ShippingProfileId String Falso O identificador exclusivo de um perfil de política de remessa de políticas de negócios. Um ShippingProfileId ou ShippingProfileName pode ser especificado.
ShippingProfileName String Falso O nome de um perfil de política de remessa de Políticas de Negócios. Um ShippingProfileId ou ShippingProfileName pode ser especificado.
MeasurementUnit String Falso Especifica o tipo de unidade de peso e dimensões de um pacote de remessa.
PackageDepth String Falso Profundidade do pacote, em um número inteiro de polegadas, necessário para enviar o item.
MeasurementSystem String Falso Sistema de medição (por exemplo, inglês).
Unit String Falso Unidade de medida (por exemplo, lbs, oz, kg, g, in, cm).
PackageLength String Falso Comprimento do pacote, em um número inteiro de polegadas, necessário para enviar o item.
PackageWidth String Falso Largura do pacote, em um número inteiro de polegadas, necessário para enviar o item.
ShippingIrregular String Falso Se um pacote é irregular e, portanto, não pode passar pela máquina de estampagem no escritório de serviço de expedição e, portanto, requer manuseio especial ou frágil.
SubTitle String Falso Subtítulo para usar além do título.
TaxCategory String Falso Código de categoria de exceção fiscal.
ThirdPartyCheckout String Falso Determina se o checkout deve ou não ser tratado por um aplicativo de checkout terceirizado autorizado.
TransactionId String Falso Um identificador exclusivo para um item de linha de pedido (transação). Um item de linha de pedido é criado quando um comprador se compromete a comprar um item. Como você pode alterar listas ativas de preços fixos de várias quantidades mesmo após a compra de um dos itens, o TransactionId é associado a um instantâneo dos dados do item no momento da compra. Comprimento máximo: 19.
UseRecommendedProduct String Falso Se verdadeiro, e os detalhes do item na solicitação corresponderem a um produto no catálogo do eBay, o produto correspondente será usado para listar o item.
UseTaxTable String Falso Indica se a tabela de impostos do vendedor deve ser usada ao aplicar e calcular o imposto sobre vendas para um item de linha do pedido.
UUID String Falso Marca de restrição universalmente exclusiva. Use o UUID para garantir que você liste um determinado item apenas uma vez, principalmente se estiver listando muitos itens de uma só vez.
BusinessSeller String Falso Se verdadeiro, isso indica que o vendedor é um usuário comercial e pretende usar os recursos de listagem oferecidos apenas para usuários comerciais.
RestrictedToBusiness String Falso Se verdadeiro, isso indica que o vendedor optou por oferecer o item exclusivamente para usuários comerciais. Se falso ou não for especificado, isso indica que o vendedor optou por oferecer o item a todos os usuários.
VATPercent String Falso Taxa de IVA para o item, se houver.
VIN String Falso Este campo exibe o Número de Identificação do Veículo, que é um número de série exclusivo para um veículo motorizado.
VRM String Falso Marca de registro de veículo, que é um identificador exclusivo para um veículo motorizado no Reino Unido.
GalleryDuration String Falso Número de dias que o tipo Galeria em destaque se aplica a uma listagem. Os valores aplicáveis incluem Days_7 e LifeTime.
GalleryURL String Falso Este campo é usado apenas internamente. A imagem da Galeria é sempre o primeiro PictureURL transmitido e esse campo é definido com esse valor.
PhotoDisplay String Falso Especifica o tipo de exibição de imagem usado em uma listagem. Algumas opções só estão disponíveis se as imagens forem hospedadas por meio do eBay Picture Services (EPS).
PictureUrl# String Falso Fonte da imagem. Use esta entrada para adicionar várias imagens. PictureUrl#1, PictureUrl#2, PictureUrl#3 etc.
ItemSpecificName# String Falso Nome dos detalhes do item. Combine isso com ItemSpecificValue.
ItemSpecificValue# String Falso Valor específico do item. Combine isso com ItemSpecificName.
Colunas do conjunto de resultados
Nome Tipo Descrição
ItemId String O identificador exclusivo do item criado.
StartTime String Data e hora de início da nova listagem.
EndTime String Data e hora em que a nova listagem está programada para terminar com base na hora de início e no valor de duração da listagem que foi definido no campo ListingDuration no horário da listagem.
FeesAggregate String Uma série de taxas associadas à criação da listagem.
DiscountReason String Um ou mais tipos de desconto de atualização/taxa de listagem oferecidos pelo eBay ao vendedor. Valores aplicáveis: CustomCode, Promotion, SpecialOffer.

CompleteSale

Realize várias tarefas após a criação de um único item de linha ou pedido de vários itens de linha. Por exemplo, conclua uma venda e deixe um feedback.

Entrada
Nome Tipo Obrigatório Descrição
FeedbackCommentText String Falso Comentário textual que explica, esclarece ou justifica a classificação de Feedback especificada em FeedbackCommentType. Este campo é obrigatório se o feedback for deixado.
FeedbackCommentType String Falso Esse valor indica a classificação de Feedback para o usuário especificado no campo FeedbackTargetUser. Este campo é obrigatório se o feedback for deixado. Por exemplo, positivo ou negativo.
FeedbackTargetUser String Falso Nome de usuário do usuário de destino.
ItemId String Falso ID do item vendido.
ListingType String Falso Este campo é obrigatório se CompleteSale estiver sendo usado para um pedido Half.com. O valor deve ser definido como Half, que é o único valor ListingType aplicável para esta entrada.
OrderId String Falso Um identificador exclusivo que identifica um único item de linha ou vários pedidos de itens de linha.
OrderLineItemId String Falso Um identificador exclusivo para um item de linha de pedido do eBay com base na concatenação de ItemId e TransactionId com um hífen entre esses dois IDs. Para um único pedido de item de linha, o valor OrderLineItemId pode ser passado para o campo OrderId.
Paid String Falso Se o comprador pagou pelo pedido. Verdadeiro ou falso.
ShipmentNotes String Falso Este campo de string permite que um vendedor forneça notas ao comprador sobre o envio de um item Half.com. Por exemplo: Enviado com USPS Media.
ShipmentTrackingNumber String Falso O número de rastreamento atribuído pela transportadora ao envio do item. Este campo e o campo ShippingCarrierUsed são mutuamente dependentes. Ao enviar ShipmentTrackingNumber, você também deve fornecer um valor para ShippingCarrierUsed. Ao enviar ShippingCarrierUsed, você também deve fornecer um valor para ShipmentTrackingNumber.
ShippingCarrierUsed String Falso O nome da transportadora usada para enviar o item. Este campo e o campo ShipmentTrackingNumber são mutuamente dependentes. Ao enviar ShippingCarrierUsed, você também deve fornecer um valor para ShipmentTrackingNumber. Ao enviar ShipmentTrackingNumber, você também deve fornecer um valor para ShippingCarrierUsed.
ShippedTime String Falso A data e a hora em que o vendedor entregou os pacotes à transportadora. Se este campo não estiver incluído na chamada, o timestamp da execução da chamada é usado como o horário de envio.
Shipped String Falso O vendedor inclui e define este campo como verdadeiro se o pedido foi enviado. Se a chamada for bem-sucedida, os itens de linha do pedido serão marcados como Enviados em Meu eBay. Por exemplo, verdadeiro ou falso.
TransactionId String Falso Identificador exclusivo para um item de linha de pedido do eBay (transação).
Colunas do conjunto de resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

CreateDSRSummery

Recupere um relatório resumido de DSR, incluindo a precisão da descrição, comunicação, envio, etc. Essas informações podem ajudar os vendedores a determinar como práticas comerciais específicas podem estar contribuindo para pontuações DSR mais altas ou mais baixas.

Entrada
Nome Tipo Obrigatório Descrição
CategoryId String Falso O relatório resumido será baseado em DSRs deixados para itens que foram listados apenas em categorias especificadas.
DateFrom String Falso O ponto inicial do intervalo de datas usado para coletar dados DSR para itens comprados. O período de tempo se aplica à data final da transação do item ou à data em que o item foi listado.
DateTo String Falso O ponto final do intervalo de datas.
DateRangeEventType String Falso Tipo de evento de item no qual o intervalo de datas será baseado. Os tipos de evento de intervalo de datas incluem: TransactionEndDate - O intervalo de datas especificado refere-se à data em que as transações foram encerradas. ListingDate - O intervalo de datas especificado refere-se à data em que os itens foram listados. Os valores permitidos são TransactionEndDate, ListingDate.
ShippingCostType String Falso Restrinja os DSRs a itens com frete grátis ou itens para os quais houve cobrança de frete e manuseio. Os valores permitidos são Grátis, Pago.
ShippingDestinationType String Falso Restrinja os DSRs a destinos de remessa doméstica ou internacional. Os valores permitidos são Doméstico, Limites.
ShippingService String Falso Serviço de transporte usado para enviar itens.
ShipToCountry String Falso País para o qual os itens foram enviados.
ItemId String Falso ID da listagem associada à transação para a qual o vendedor está coletando dados resumidos de classificação.
TransactionId String Falso Identificador exclusivo para uma transação.
ReportType String Falso Os relatórios serão gerados com base neste filtro. Os valores permitidos são ByCategory, ByPeriod, ByShippingDetails, ByTransaction.
Colunas do conjunto de resultados
Nome Tipo Descrição
JobId String JobId que você pode usar para baixar o relatório posteriormente.

CreateReport

Começa a processar os dados para download de um arquivo de relatório.

Entrada
Nome Tipo Obrigatório Descrição
DownloadJobType String Falso Este campo é usado para especificar o tipo de relatório de dados do comerciante a ser criado. Os valores permitidos são ActiveInventoryReport, FeeSettlementReport, SoldReport, OrderReport.
UUID String Falso Um identificador exclusivo universal (UUID) fornecido pelo aplicativo do vendedor.
Colunas do conjunto de resultados
Nome Tipo Descrição
JobId String ID exclusivo atribuído a um trabalho.

GetOAuthAccessToken

Obtém o token de acesso OAuth do eBay.

Entrada
Nome Tipo Obrigatório Descrição
Verifier String Falso O token do verificador retornado pelo eBay após usar a URL obtida com GetOAuthAuthorizationURL. Necessário apenas para Web AuthMode.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo.
RuName String Falso O nome da URL de redirecionamento no Token do eBay por meio da seção Aplicativo da página Tokens do usuário.
SessionId String Falso A ID da sessão necessária para autenticar ao usar Auth e Auth.
Scope String Falso O escopo ou as permissões que você está solicitando. o valor padrão é *https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly*.
AuthMode String Falso O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
State String Falso Um valor opaco usado pelo cliente para manter o estado entre a solicitação e o retorno de chamada.
Colunas do conjunto de resultados
Nome Tipo Descrição
OAuthAccessToken String O token OAuth.
OAuthRefreshToken String O token de atualização OAuth.
ExpiresIn String O tempo de vida restante do token de acesso em segundos.

GetOAuthAuthorizationURL

Obtém o URL de autorização do eBay. Acesse a URL retornada na saída em um navegador da Internet. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para o eBay.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o eBay retornará depois que o usuário autorizar seu aplicativo. Se UseOAuth for definido como true, RuName será usado em vez de CallbackUrl.
RuName String Falso O nome da URL de redirecionamento no Token do eBay por meio da seção Aplicativo da página Tokens do usuário.
State String Falso Um valor opaco usado pelo cliente para manter o estado entre a solicitação e o retorno de chamada.
Scope String Falso O escopo ou as permissões que você está solicitando. Necessário apenas para a autenticação OAuth. o valor padrão é *https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly*.
Colunas do conjunto de resultados
Nome Tipo Descrição
URL String A URL a ser inserida em um navegador da Web para obter o token do verificador, que você precisará enviar de volta com o procedimento armazenado GetOAuthAccessToken.

GetReport

Baixa um relatório que foi criado anteriormente com o procedimento armazenado CreateReport. Para baixar o relatório, seu status deve ser Concluído.

Entrada
Nome Tipo Obrigatório Descrição
DownloadPath String Falso Caminho local para salvar o relatório gerado.
FileReferenceId String Falso Um ID exclusivo atribuído ao arquivo.
TaskReferenceId String Falso Este campo faz referência ao JobId retornado após chamar o procedimento armazenado CreateReport.
Colunas do conjunto de resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.
FileData String Se o DownloadPath for deixado em branco, o conteúdo do arquivo baixado será exposto como uma string codificada em Base64.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com o eBay.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Falso O token antigo a ser atualizado.
Colunas do conjunto de resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do eBay.
ExpiresIn String O tempo de vida restante no token de acesso.

SetUserNotes

Adicione, substitua e exclua notas do Meu eBay para itens que estão sendo rastreados nas áreas de Vendas e Compras do Meu eBay.

Note: Este procedimento faz uso de indexed parameters. Esses parâmetros de entrada são indicados com um # no final de seus nomes.

Os parâmetros indexados facilitam o fornecimento de várias instâncias de um único parâmetro como entradas para o procedimento.

Suponha que haja um parâmetro de entrada chamado Param#. Insira várias instâncias de um parâmetro indexado como este:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Entrada
Nome Tipo Obrigatório Descrição
Action String Verdade O vendedor deve incluir este campo e defini-lo como 'AddOrUpdate' para adicionar uma nova nota de usuário ou atualizar uma nota de usuário existente, ou defini-lo como 'Excluir' para excluir uma nota de usuário existente.
ItemId String Falso Identificador exclusivo da listagem à qual a nota My eBay será anexada. As notas só podem ser adicionadas a itens que estão sendo rastreados no momento no Meu eBay.
NoteText String Falso Este campo é necessário se a Ação for AddOrUpdate. O texto fornecido neste campo substituirá completamente qualquer nota My eBay existente para o item especificado.
OrderLineItemId String Falso Um identificador exclusivo para um item de linha de pedido do eBay. Este campo é criado assim que houver o compromisso de compra do vendedor, e seu valor é baseado na concatenação de ItemID e TransactionID, com um hífen entre esses dois IDs. OrderLineItemID pode ser usado na entrada em vez de um par ItemID/TransactionID para identificar um item de linha de pedido.
SKU String Falso Valor SKU da variação do item ao qual a nota My eBay será anexada. As notas só podem ser adicionadas a itens que estão sendo rastreados no momento no Meu eBay. Um valor de SKU (unidade de manutenção de estoque) é definido e usado pelo vendedor para identificar uma variação dentro de uma listagem de variação múltipla e preço fixo. O valor SKU é atribuído a uma variação de um item por meio do elemento Variations.Variation.SKU.
TransactionId String Falso Identificador exclusivo do item de linha do pedido ao qual a nota My eBay será anexada. As observações só podem ser adicionadas a itens de linha de pedido que estão sendo rastreados no momento em Meu eBay. Os compradores podem visualizar as notas do usuário feitas nos itens de linha do pedido no campo PrivateNotes do contêiner WonList em GetMyeBayBuying, e os vendedores podem ver as notas do usuário feitas nos itens de linha do pedido no campo PrivateNotes dos contêineres SoldList e DeletedFromSoldList em GetMyeBaySellinging.
VariationSpecificName# String Falso Dependendo da chamada e do contexto, esse valor é o nome de um item/categoria/variação específica ou um nome de compatibilidade de peças.
VariationSpecificValue# String Falso Dependendo da chamada e do contexto, esse valor é o valor de um item/categoria/variação específica, um valor de compatibilidade de peças ou um identificador de produto.
Colunas do conjunto de resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

CarregarArquivo

Carrega um arquivo para a conta do eBay.

Procedimento armazenado* Informações específicas

Este procedimento associa o arquivo especificado ao ID de tarefa especificado e carrega o arquivo de entrada. Após o upload do arquivo, o processamento do arquivo é iniciado.

As entradas necessárias para carregar um arquivo são as seguintes: TaskID e FilePath.

Carregar um arquivo

Você pode seguir o procedimento abaixo para enviar um procedimento de upload de arquivo bem-sucedido:

  1. Use a tabela Tarefas para criar uma nova Tarefa. Você pode usar a seguinte consultar:

    INSERT INTO [Tarefas] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')
    
  2. Você pode obter o TaskID recém-gerado a partir das chaves geradas ou usando a tabela Tarefas novamente para selecionar.

        Statement stat = conn.createStatement();
        stat.executeUpdate("INSERT INTO [Tarefas] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')", Statement.RETURN_GENERATED_KEYS);
        ResultSet rs = stat.getGeneratedKeys();
        while (rs.next()) {
          for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) {
            System.out.println(rs.getMetaData().getColumnName(i) + "=" + rs.getString(i));
          }
    }
    

    ou

    SELECT * FROM [Tarefas] WHERE FeedType = 'LMS_ADD_ITEM' AND CreationDate > '2021-11-16 09:19:00'
    
  3. Use esse ID de tarefa como entrada junto com o FilePath do arquivo a ser carregado, no procedimento armazenado UploadFile.

        CallableStatement callableStatement = conn.prepareCall("UploadFile");
        callableStatement.setString("TaskID", "task-5-1XXXXX");
        callableStatement.setString("FilePath", "C:\Users\User\Documents\upload.csv");
    
        boolean ret = callableStatement.execute();
        if (!ret) {
          int count = callableStatement.getUpdateCount();
          if (count != -1) {
            System.out.println("Affected rows: " + count);
          }
        } else {
          ResultSet rs = callableStatement.getResultSet();
          while (rs.next()) {
            for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) {
              System.out.println(rs.getMetaData().getColumnName(i) + "=" + rs.getString(i));
            }
          }
    }
    
  4. Então seu arquivo deve estar processando. Para rastrear o status, você pode executar uma consultar SELECT na tabela Tasks com o TaskID e verificar a coluna Status.

    SELECT Status FROM [Tarefas] WHERE TaskID = '{Generated Task ID}'
    
Entrada
Nome Tipo Obrigatório Descrição
TaskID String Verdade O task_id associado ao arquivo que será carregado. Este ID foi gerado quando a tarefa especificada foi criada.
FilePath String Falso O caminho absoluto do arquivo a ser carregado.
Content String Falso O conteúdo do arquivo que você deseja carregar deve ser um fluxo de entrada e o campo FilePath deve ser mantido em branco.
FileName String Falso O nome do arquivo carregado. Deve ser especificado apenas ao carregar o conteúdo como InputStream. (Com extensão)
Colunas do conjunto de resultados
Nome Tipo Descrição
Success String Este parâmetro define se a operação foi bem-sucedida ou não.
Description String Mensagem de descrição da operação de upload. Pode ser uma mensagem de erro ou uma mensagem de sucesso.

Tabelas do sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de esquema

As tabelas a seguir retornam metadados de banco de dados para o eBay:

Tabelas de fonte de dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar tabelas de informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibição.
IsUpdateable Boolean Se a tabela pode ser atualizada.

sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela ItemListing:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='ItemListing' 
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado AddItem:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddItem' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela ItemListing:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='ItemListing'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), clusterizado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:ebay:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento colaborativo de consultas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os recursos SELECT da fonte de dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Propriedades de configurações avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

Propriedade Descrição
AuthScheme O esquema usado para autenticação. As entradas aceitas são Auth e AuthNAuth.
DevID Seu ID de desenvolvedor, conforme registrado no Programa de Desenvolvedores do eBay.
SiteID A ID do site do eBay para o qual você deseja enviar a solicitação. Por padrão, é 0, (EUA).
UseSandbox Um booleano que indica se você está usando uma conta de sandbox.
RuName O nome da URL de redirecionamento usado para validação. Essa propriedade só é necessária se você estiver usando o provedor para permitir que outros usuários acessem seus próprios dados.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Diversos

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Autenticação

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

Propriedade Descrição
AuthScheme O esquema usado para autenticação. As entradas aceitas são Auth e AuthNAuth.
DevID Seu ID de desenvolvedor, conforme registrado no Programa de Desenvolvedores do eBay.
SiteID A ID do site do eBay para o qual você deseja enviar a solicitação. Por padrão, é 0, (EUA).
UseSandbox Um booleano que indica se você está usando uma conta de sandbox.
RuName O nome da URL de redirecionamento usado para validação. Essa propriedade só é necessária se você estiver usando o provedor para permitir que outros usuários acessem seus próprios dados.

AuthScheme

O esquema usado para autenticação. As entradas aceitas são Auth e AuthNAuth.

Valores possíveis

Auto, OAuth, AuthNAuth

Tipo de dados

string

Valor padrão

"Auto"

Observações
  • Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
  • OAuth: Defina para executar a autenticação OAuth.
  • AuthNAuth: Defina para executar o método de autenticação Auth'n'Auth tradicional usado pelas APIs do eBay.

DevID

Seu ID de desenvolvedor, conforme registrado no Programa de Desenvolvedores do eBay.

Tipo de dados

string

Valor padrão

""

Observações

Seu ID de desenvolvedor, conforme registrado no Programa de Desenvolvedores do eBay.

SiteID

A ID do site do eBay para o qual você deseja enviar a solicitação. Por padrão, é 0, (EUA).

Tipo de dados

string

Valor padrão

"0"

Observações

A ID do site do eBay para o qual você deseja enviar a solicitação. Por padrão, é 0, (EUA)

UseSandbox

Um booleano que indica se você está usando uma conta de sandbox.

Tipo de dados

bool

Valor padrão

false

Observações

Um booleano que indica se você está usando uma conta de sandbox.

RuName

O nome da URL de redirecionamento usado para validação. Essa propriedade só é necessária se você estiver usando o provedor para permitir que outros usuários acessem seus próprios dados.

Tipo de dados

string

Valor padrão

""

Observações

O nome da URL de redirecionamento usado para validação. Essa propriedade só é necessária se você estiver usando o conector para permitir que outros usuários acessem seus próprios dados. Você pode obtê-lo clicando em Tokens de usuário em sua conta de desenvolvedor, clicando em Obter um token do eBay por meio de seu aplicativo e, em seguida, clicando em Adicionar URL de redirecionamento do eBay.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de dados

string

Valor padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

  1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
  3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve lidar com a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de dados

string

Valor padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de dados

string

Valor padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

CallbackURL

O URL de retorno de chamada OAuth para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo.

Tipo de dados

string

Valor padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de dados

string

Valor padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em máquinas sem cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de dados

string

Valor padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de dados

string

Valor padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de dados

string

Valor padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de dados

string

Valor padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de dados

string

Valor padrão

"%APPDATA%\\\Ebay Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\Ebay Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

BrowsableSchemas

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de dados

string

Valor padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA,TableB,TableC.

Tipo de dados

string

Valor padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de dados

string

Valor padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de dados

int

Valor padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de dados

string

Valor padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

PseudoColumns

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de dados

string

Valor padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo limite

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de dados

int

Valor padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.