Dicionário de dados de migração da loja
A migração de dados da loja inclui informações sobre os recursos Customer
, Order
e Product
da API Admin REST. O dicionário de dados é uma referência complementar para os Parceiros experientes que estão migrando lojas para a Shopify.
Customer
: propriedades do recurso
A tabela abaixo lista algumas informações úteis sobre as propriedades do recurso Customer
da API Admin REST.
Propriedade | Valores | Descrição | Tipo de dado | Comprimento do campo | Acesso ao campo | Campo crítico obrigatório |
---|---|---|---|---|---|---|
accepts_marketing | Padrão: 0 | Se o cliente concordou em receber material de marketing. | Booleano | tinyint(1) | S | |
accepts_marketing_ updated_at |
A data e a hora no formato ISO 8601 em que o cliente consentiu ou se opôs ao recebimento de material de marketing por e-mail. | DateTime | endereços | Uma lista de endereços associados ao cliente. | [{ Address }] | |
Moeda | O código de três letras no formato ISO 4217 para a moeda que o cliente usou no pagamento do último pedido. | String | A moeda da loja | Somente leitura | ||
created_at | Padrão: NULL | A data e a hora (no formato ISO 8601) em que o cliente foi adicionado à loja. | DateTime | datetime | Somente leitura | |
default_address | O endereço padrão do cliente. | { Address } | ||||
Padrão: NULL | O e-mail exclusivo do cliente. | String | varchar(255) | |||
first_name | Padrão: NULL | O primeiro nome do cliente. | String | varchar(255) | ||
Id | Padrão: NULL | Um identificador global exclusivo. (Valor com incrementos automáticos) | Inteiro | bigint(20) | S | |
last_name | Padrão: NULL | O sobrenome do cliente. | String | varchar(255) | ||
last_order_id | Padrão: NULL | O ID do último pedido do cliente. | Inteiro | bigint(20) | Somente leitura | |
last_order_name | Padrão: NULL | O nome do último pedido do cliente. | String | Somente leitura | ||
metacampos | Padrão: NULL | Retorna um metacampo por namespace e chave que pertence ao recurso. | { Metafield } | |||
marketing_opt_ in_level |
|
O nível de ativação para a assinatura de marketing (conforme descrito pela diretriz de práticas recomendadas do M3AAWG) que o cliente deu quando consentiu em receber material de marketing por e-mail. | String, enum | |||
multipass_identifier | Padrão: NULL | Um identificador exclusivo para o cliente que é usado com login Multipass. | String | varchar(255) | ||
observação | Padrão: NULL | Observação sobre o cliente. | String | mediumtext | ||
orders_count | Padrão: 0 | Número de pedidos que o cliente fez na loja durante sua vida útil. | Inteiro | int(11) | Somente leitura | |
telefone | Padrão: NULL | O número de telefone exclusivo (em toda a loja) (formato E.164) para esse cliente. | String | varchar(255) | ||
sms_marketing_ consent |
Padrão: NULL | O estado atual de marketing por SMS do número de telefone do cliente. | String | |||
state |
|
O estado da conta do cliente na loja. | String, enum | varchar(255) | Somente leitura | |
tags | Padrão: NULL | Uma lista separada por vírgula de até 250 tags que foram adicionadas ao cliente. | String | 255 por tag | ||
tax_exempt | Padrão: 0 | Se o cliente está isento de pagar tributos sobre seus pedidos. | Booleano | tinyint(1) | S | |
tax_exemptions | Consulte o recurso Customer para ver uma lista completa dos valores. | A lista de isenções tributárias aplicadas ao cliente. | String | |||
total_spent | Padrão: 0 | O valor total que o cliente gastou em pedidos durante sua vida útil, listado na moeda da loja. Se a loja usar várias moedas, o valor é mostrado na moeda-padrão sem a taxa de câmbio. | Número | decimal(21,3) | Somente leitura | |
updated_at | A data e a hora em que o cliente foi atualizado pela última vez. Considera o fuso horário da loja. | DateTime | datetime | Somente leitura | ||
verified_email | Padrão: 1 | Indica se o cliente verificou o endereço de e-mail. O padrão é "true" se o cliente for criado pelo admin ou pela API da Shopify. | Booleano | tinyint(1) | Somente leitura |
CustomerAddress
: propriedades do recurso
A tabela abaixo lista algumas informações úteis sobre as propriedades do recurso CustomerAddress
da API Admin REST. Vale lembrar que não existem campos obrigatórios críticos para esse recurso.
Propriedade | Valores | Descrição | Tipo de dado | Comprimento do campo | Acesso ao campo |
---|---|---|---|---|---|
address1 | Padrão: NULL | O endereço de correspondência do cliente. São aceitos 100 por conta de cliente. | String | varchar(255) | |
address2 | Padrão: NULL | Campo adicional para o endereço de correspondência do cliente. | String | varchar(255) | |
city | Padrão: NULL | A cidade ou a vila do cliente. | String | varchar(255) | |
company | Padrão: NULL | A empresa do cliente. | String | varchar(255) | |
país | Padrão: NULL | O país do cliente. | String | varchar(255) | |
first_name | Padrão: NULL | O primeiro nome do cliente. | String | varchar(255) | |
country_code | O código de duas letras do país do cliente. | String | Somente leitura | ||
country_name | O nome normalizado do país do cliente. | String | |||
last_name | Padrão: NULL | O sobrenome do cliente. | String | varchar(255) | |
Nome | Nome e sobrenome do cliente. | String | |||
telefone | Padrão: NULL | O número de telefone do cliente nesse endereço. | String | varchar(255) | |
province | Padrão: NULL | O nome da região do cliente. Em geral, é uma província, um estado ou um distrito administrativo. | String | varchar(255) | |
province_code | O código de duas letras para a região do cliente. | String | Somente leitura | ||
zip | Padrão: NULL | O CEP do cliente, que também pode se denominar ZIP, código postal, Eircode etc. | String | varchar(255) |
Order
: propriedades do recurso
A tabela abaixo lista algumas informações úteis sobre as propriedades do recurso Order
da API Admin REST.
Propriedade | Valores | Descrição | Tipo de dado | Comprimento do campo | Acesso ao campo | Campo crítico obrigatório |
---|---|---|---|---|---|---|
app_id | Padrão: NULL | O ID do app que criou o pedido. | inteiro | bigint(20) | Somente leitura | |
billing_address | Padrão: NULL | O endereço de correspondência associado à forma de pagamento. Esse campo é opcional e não está disponível em pedidos que não exigem uma forma de pagamento. | inteiro | bigint(20) | ||
browser_ip | O endereço IP do navegador usado pelo cliente quando fez o pedido. Tanto IPv4 quanto IPv6 são aceitos. | string | varchar(255) | Somente leitura | ||
buyer_accepts_marketing | Padrão: 0 | Indica se o cliente consentiu em receber atualizações por e-mail da loja. | booleano | tinyint(1) | ||
cancel_reason |
|
O motivo para o cancelamento do pedido | string | varchar(255) | ||
cancelled_at | Padrão: NULL | A data e a hora de cancelamento do pedido. Retorna zero se o pedido não foi cancelado. | date | datetime | Somente leitura | |
cart_token | Padrão: NULL | Um valor exclusivo para referência ao carrinho associado ao pedido. | string | varchar(255) | Somente leitura | |
checkout_token | Padrão: NULL | Um valor exclusivo para referência ao checkout associado ao pedido. | string | varchar(64) | Somente leitura | |
client_details |
|
Informações sobre o navegador que o cliente usou quando fez o pedido: accept_language: os idiomas e as localidades que o navegador entende. browser_height: a altura da tela do navegador em pixels, se disponível. browser_ip: o endereço IP do navegador. browser_width: a largura da tela do navegador em pixels, se disponível. session_hash: um hash da sessão. user_agent: informações do cliente que usa o navegador, incluindo software e versões operacionais. |
objeto | Somente leitura | ||
closed_at | Padrão: NULL | A data e a hora (formato ISO 8601) de fechamento do pedido. Retorna zero se o pedido não foi fechado. | date | datetime | Somente leitura | |
created_at | Padrão: NULL | A data e a hora geradas automaticamente (no formato ISO 8601) da criação do pedido na Shopify. O valor dessa propriedade não pode ser alterado. | date | datetime(6) | Somente leitura | |
Moeda | Padrão: NULL | O código de três letras (formato ISO 4217) para a moeda da loja. | string | char(3) | ||
current_subtotal_price | O subtotal atual do preço do pedido na moeda da loja. O valor desse campo reflete as edições, as devoluções e os reembolsos do pedido. | string | varchar(255) | Somente leitura | ||
current_subtotal_price_set | O subtotal atual do preço do pedido nas moedas de compra e de apresentação.Os valores associados a esse campo refletem as edições, as devoluções e os reembolsos do pedido. | objeto | Somente leitura | |||
current_total_discounts | O total atual de descontos do pedido na moeda da loja. O valor desse campo reflete as edições, as devoluções e os reembolsos do pedido. | string | varchar(255) | Somente leitura | ||
current_total_discounts_set | O total atual de descontos do pedido nas moedas da loja e de apresentação. Os valores associados a esse campo refletem as edições, as devoluções e os reembolsos do pedido. | objeto | Somente leitura | |||
current_total_duties_set | O total atual de tributos de importação cobrados no pedido nas moedas da loja e de apresentação. Os valores associados a esse campo refletem as edições, as devoluções e os reembolsos do pedido. | objeto | Somente leitura | |||
current_total_price | O total atual do preço do pedido na moeda da loja. O valor desse campo reflete as edições, as devoluções e os reembolsos do pedido. | string | varchar(255) | Somente leitura | ||
current_total_price_set | O preço total atual do pedido nas moedas da loja e de apresentação. Os valores associados a esse campo refletem as edições, as devoluções e os reembolsos do pedido. | objeto | Somente leitura | |||
current_total_tax | O total atual de tributos cobrados no pedido na moeda da loja. O valor desse campo reflete as edições, as devoluções ou os reembolsos do pedido. | string | varchar(255) | Somente leitura | ||
current_total_tax_set | O total atual de tributos cobrados no pedido nas moedas da loja e de apresentação. Os valores associados a esse campo refletem as edições, as devoluções e os reembolsos do pedido. | objeto | Somente leitura | |||
cliente | Padrão: NULL | Informações sobre o cliente. O pedido pode não ter um cliente, e os apps não devem depender da existência de um objeto de cliente. Esse valor pode ser nulo se o pedido foi criado pelo Shopify PDV. | inteiro | bigint(20) | ||
customer_locale | Padrão: NULL | O código de duas ou três letras do idioma, seguido por um modificador de região opcional. | string | varchar(255) | Somente leitura | |
discount_applications | Uma lista ordenada de apps de desconto empilhados. A propriedade discount_applications inclui três tipos: discount_code, manual e script. Todos eles compartilham uma estrutura comum e têm atributos específicos de algum tipo. |
array | Somente leitura | |||
discount_codes | Uma lista de descontos aplicados ao pedido. | array | ||||
O e-mail do cliente. | varchar(255) | |||||
estimated_taxes | Indica se os tributos sobre o pedido são estimados. Muitos fatores podem mudar entre o momento em que o cliente faz um pedido e o momento em que o pedido é enviado, e isso pode afetar o cálculo dos tributos. Essa propriedade retorna "false" quando os tributos sobre o pedido estão finalizados e não estão sujeitos a alterações. | booleano | tinyint(1) | |||
financial_status |
|
O status dos pagamentos associados ao pedido. Só pode ser definido quando o pedido é criado. | string | varchar(255) | Somente leitura | |
fulfillment_status |
|
O status do pedido quanto aos items de linha processados. | string | varchar(255) | ||
processamentos | Uma matriz de processamentos associados ao pedido | array | ||||
Id | Padrão: NULL | O ID do pedido, usado para fins da API. Essa informação é diferente da propriedade order_number, que é o ID usado pelo titular da loja e pelo cliente. | inteiro | bigint(20) | Somente leitura | |
landing_site | Padrão: NULL | O URL da página de destino acessada pelo comprador ao entrar na loja. | string | varchar(4096) | Somente leitura | |
line_items | Uma lista de objetos de item de linha, cada qual contendo informações sobre um item no pedido | array | S | |||
location_id | Padrão: NULL | O ID do local físico onde o pedido foi processado. Se for necessário fazer referência ao local em relação a um pedido, use o recurso FulfillmentOrder. | inteiro | bigint(20) | ||
Nome | Padrão: NULL | O nome do pedido, gerado pela combinação da propriedade order_number com o prefixo e o sufixo do pedido, que estão definidos nas configurações gerais do lojista. Essa informação é diferente da propriedade ID, que é o ID do pedido usado pela API. Esse campo também pode ser definido pela API como qualquer valor de string. | string | varchar(255) | ||
observação | Padrão: NULL | Uma observação opcional que um titular da loja pode anexar ao pedido. | string | |||
note_attributes | Padrão: NULL | Informações extras que são adicionadas ao pedido. Aparece na seção "Informações adicionais" da página de informações do pedido. Cada entrada da matriz precisa conter um hash com chaves de nome e de valor. | string | |||
número | Padrão: NULL | A posição do pedido na contagem de pedidos da loja. Os números são sequenciais e começam em 1. | inteiro | int(11) | Somente leitura | |
order_number | A posição do pedido na contagem de pedidos da loja, que começa em 1001. Os números de pedido são sequenciais. | inteiro | bigint(20) | Somente leitura | ||
order_status_url | O URL que aponta para a página de status do pedido na web, se aplicável. | string | varchar(255) | Somente leitura | ||
original_total_duties_set | O total original de tributos de importação cobrados no pedido nas moedas da loja e de apresentação. | objeto | Somente leitura | |||
payment_gateway_names | Padrão: NULL | A lista de gateways de pagamento usados para o pedido. |
varchar(255) | Somente leitura | ||
payment_terms | Padrão: NULL | Os termos e as condições para o processamento do pagamento. | objeto | bigint(20) | Somente leitura | |
telefone | Padrão: NULL | O número de telefone do cliente para receber notificações por SMS. | string | varchar(255) | ||
presentment_currency | Padrão: NULL | A moeda de apresentação que foi usada para exibir os preços ao cliente. | string | char(3) | ||
processed_at | Padrão: NULL | A data e a hora (formato ISO 8601) do processamento de um pedido. Esse valor é a data em que aparece nos pedidos e é usado nos relatórios de análise. Se você está importando pedidos de um app ou de outra plataforma, é possível definir processed_at como um valor de data e hora no passado para corresponder à criação do pedido original. | date | datetime(6) | ||
processing_method |
|
Como o pagamento foi processado | string | varchar(255) | Somente leitura | |
referring_site | Padrão: NULL | O site no qual cliente clicou no link para a loja. | string | varchar(4096) | ||
reembolsos | Uma lista de reembolsos aplicados ao pedido | array | Somente leitura | |||
shipping_address | Padrão: NULL | O endereço de e-mail para onde o pedido será enviado. É uma informação opcional e não estará disponível nos pedidos que não exigem frete. | inteiro | bigint(20) | ||
shipping_lines | Uma matriz de objetos; cada qual detalha uma forma de frete usada. | array | ||||
source_name | Padrão: NULL | Origem do pedido. Pode ser definido apenas durante a criação do pedido e não permite gravação posterior. Os valores para os canais de vendas Shopify são protegidos e não podem ser atribuídos por outros clientes da API: web, pdv, shopify_draft_order, iphone e android. Os pedidos criados por meio da API podem ser atribuídos a qualquer outra string de sua escolha. Se a informação não for especificada, os novos pedidos receberão o valor do ID do app. | string | varchar(255) | ||
subtotal_price | O preço do pedido na moeda da loja após descontos, mas antes de frete, tributos de importação, tributos e gorjetas. | inteiro | bigint(20) | |||
subtotal_price_set | O subtotal do pedido na loja e nas moedas de apresentação após descontos, mas antes de frete, tributos de importação, tributos e gorjetas. | objeto | ||||
tags | Tags anexadas ao pedido, formatadas como uma string de valores separados por vírgula. As tags são descritores curtos adicionais, usados em geral para filtragem e pesquisa. Cada tag individual está limitada a 40 caracteres. | string | varchar(4096) | |||
tax_lines | Uma matriz de objetos de linha de tributos. Cada objeto detalha um tributo aplicável ao pedido e tem estas propriedades: Durante a criação de um pedido pela API, é possível especificar as linhas de tributos no pedido ou nos itens de linha, mas não em ambos. As linhas de tributos especificadas no pedido são divididas entre os itens de linha tributados no pedido criado. |
array | ||||
taxes_included |
|
Indica se os tributos estão incluídos no subtotal do pedido. | booleano | tinyint(1) | ||
test |
|
Indica se o pedido é de teste. | booleano | tinyint(1) | Somente leitura | |
token | Padrão: NULL | Um valor exclusivo para referência ao pedido. | string | varchar(32) | Somente leitura | |
total_discounts | Padrão: 0 | O total de descontos aplicados ao preço do pedido na moeda da loja. | string | decimal(21,3) | ||
total_discounts_set | O total de descontos aplicados ao preço do pedido nas moedas da loja e de apresentação. | objeto | ||||
total_line_items_price | Padrão: 0 | A soma de todos os preços de itens de linha na moeda da loja. | string | decimal(21,3) | ||
total_line_items_price_set | O total de todos os preços de itens de linha nas moedas da loja e de apresentação. | objeto | ||||
total_outstanding | Padrão: 0 | O valor total pendente do pedido na moeda da loja. | string | decimal(21,3) | ||
total_price | Padrão: 0 | A soma de todos os preços de itens de linha, descontos, frete, tributos e gorjetas na moeda da loja. Precisa ser um valor positivo. | string | decimal(21,3) | ||
total_price_set | O preço total do pedido nas moedas da loja e de apresentação. | objeto | ||||
total_shipping_price_set | O preço total de frete do pedido, excluindo descontos e devoluções, nas moedas da loja e de apresentação. Se taxes_included for definido como verdadeiro, total_shipping_price_set incluirá os tributos. | objeto | ||||
total_tax | Padrão: 0 | A soma de todos os tributos aplicados ao pedido na moeda da loja. Precisa ser um valor positivo. | string | decimal(21,3) | ||
total_tax_set | O tributo total aplicado ao pedido nas moedas da loja e de apresentação. | objeto | ||||
total_tip_received | A soma de todas as gorjetas do pedido na moeda da loja. | inteiro | bigint(20) | Somente leitura | ||
total_weight | Padrão: 0 | A soma de todos os pesos de itens de linha em gramas. A soma não é ajustada quando os itens são removidos do pedido. | inteiro | bigint(20) unsigned | ||
updated_at | A data e a hora (no formato ISO 8601) da última modificação do pedido. | date | datetime(6) | Somente leitura | ||
user_id | Padrão: NULL | O ID do usuário que processou o pedido durante uma sessão no Shopify PDV, se aplicável. | inteiro | bigint(20) |
Product
: propriedades do recurso
A tabela abaixo lista algumas informações úteis sobre as propriedades do recurso Product
da API Admin REST.
Propriedade | Valores | Descrição | Tipo de dado | Comprimento do campo | Acesso ao campo | Campo crítico obrigatório |
---|---|---|---|---|---|---|
body_html | Padrão: NULL | Descrição do produto. Compatível com a formatação HTML. | string | mediumtext | ||
created_at | Padrão: NULL | A data e a hora (no formato ISO 8601) de criação do pedido. | date | datetime | Somente leitura | |
handle | Padrão: NULL | string | varchar(255) | |||
Id | Padrão: NULL | Um número inteiro de 64 bits não atribuído que é usado como identificador exclusivo para o produto. Cada ID é único em todo o sistema da Shopify, ou seja, não há dois produtos com o mesmo ID, mesmo que sejam de lojas diferentes. | inteiro | bigint(20) | Somente leitura | S |
imagens | Uma lista de objetos de imagem de produto, cada qual representando uma imagem associada ao produto. | [{ product_image }] | ||||
Opções | As propriedades do produto personalizado. Por exemplo, tamanho, cor e material. Cada produto pode ter até 3 opções, e o valor de cada opção pode ter até 255 caracteres. As variantes do produto são compostas por combinações de valores de opção. Não é possível criar opções sem valores. Para criar novas opções, também é preciso criar uma variante com um valor de opção associado. | array | ||||
product_type | Padrão: NULL | Uma categorização para o produto, usada para filtrar e pesquisar produtos. | string | varchar(255) | ||
published_at | Padrão: NULL | A data e a hora (formato ISO 8601) de publicação do produto. O valor pode ser definido como nulo para cancelar a publicação do produto no canal de vendas Loja virtual. | date | datetime | ||
published_scope |
|
Indica se o produto foi publicado no canal Ponto de venda. | string | |||
Status |
|
O status do produto. | string | varchar(32) | ||
tags | Uma sequência de tags separadas por vírgulas usadas para filtragem e pesquisa. Um produto pode ter até 250 tags, cada uma com até 255 caracteres. | string | ||||
template_suffix | Padrão: NULL | O sufixo do modelo Liquid usado na página do produto. Se essa propriedade for especificada, a página do produto usará um modelo chamado "product.suffix.liquid", onde "sufixo" é o valor da propriedade. Se esta propriedade for "" ou nula, a página do produto usará o modelo-padrão "product.liquid". | string | varchar(255) | ||
title | Padrão: NULL | O nome do produto | string | varchar(255) | ||
updated_at | Padrão: NULL | A data e a hora (formato ISO 8601) da modificação mais recente do produto. O valor de updated_at do produto pode ser alterado por diferentes motivos. Por exemplo, se foi feito o pedido de um produto que tem o acompanhamento de estoque configurado, o ajuste de estoque será contabilizado como atualização. | date | datetime | Somente leitura | |
variantes | Uma matriz de variantes do produto, cada uma representando uma versão diferente dele. A propriedade position é somente leitura. A posição das variantes é indicada pela ordem em que estão listadas. | array | ||||
fornecedor | Padrão: NULL | O nome do fabricante do produto. | string | varchar(255) |
ProductImage
: propriedades do recurso
A tabela abaixo lista algumas informações úteis sobre as propriedades do recurso ProductImage
da API Admin REST. Vale lembrar que não existem campos obrigatórios somente leitura ou críticos para esse recurso.
Propriedade | Valores | Descrição | Tipo de dado | Comprimento do campo |
---|---|---|---|---|
created_at | Padrão: NULL | A data e a hora de criação da imagem do produto. A API retorna esse valor no formato ISO 8601. | date | datetime |
height | Padrão: NULL | Dimensão da altura da imagem, que é determinada no upload. | smallint(4) unsigned | |
Id | Padrão: NULL | Um identificador numérico exclusivo para a imagem do produto. (auto_increment) | inteiro | bigint(20) |
position | Padrão: 0 | A ordem da imagem do produto na lista. A primeira imagem ocupa a posição 1 e é a "principal" do produto. | smallint(5) unsigned | |
product_id | Padrão: NULL | O ID do produto associado à imagem. | bigint(20) | |
src | Especifica o local da imagem do produto. Esse parâmetro é compatível com filtros de URL que podem ser usados para recuperar cópias modificadas da imagem. Por exemplo, adicione _small ao nome do arquivo para recuperar uma cópia em escala da imagem com 100 x 100 px (por exemplo, ipod-nano_small.png) ou adicione _2048x2048 para recuperar uma cópia da imagem com a resolução de 2048 x 2048 px (por exemplo, ipod-nano_2048x2048.png). | |||
updated_at | Padrão: NULL | A data e a hora da modificação mais recente da imagem do produto. A API retorna esse valor no formato ISO 8601. | date | datetime |
variant_ids | Uma matriz com IDs de variantes associadas à imagem. | |||
width | Padrão: NULL | Dimensão de largura da imagem, determinada no upload. | smallint(4) unsigned |
ProductVariant
: propriedades do recurso
A tabela abaixo lista algumas informações úteis sobre as propriedades do recurso ProductVariant
da API Admin REST. Vale lembrar que não existem campos obrigatórios críticos para esse recurso.
Propriedade | Valores | Descrição | Tipo de dado | Comprimento do campo | Acesso ao campo |
---|---|---|---|---|---|
código de barras | Padrão: NULL | O código de barras, UPC ou ISBN do produto. | varchar(255) | ||
compare_at_price | Padrão: NULL | O preço original do item antes de ajuste ou promoção. | decimal(20,2) | ||
created_at | Padrão: NULL | A data e a hora no formato ISO 8601 de criação da variante do produto. | date | datetime | |
fulfillment_service |
|
O serviço de processamento de pedidos associado à variante do produto. | varchar(255) | ||
gramas | O peso da variante do produto em gramas. | ||||
Id | Padrão: NULL | O identificador numérico exclusivo da variante do produto. Esse valor é incrementado automaticamente. | bigint(20) | ||
image_id | Padrão: NULL | O identificador numérico exclusivo da imagem de um produto. A imagem precisa estar associada ao mesmo produto que a variante. | bigint(20) | ||
inventory_item_id | O identificador exclusivo do item de estoque, que é usado na API Inventory para consultar as informações de estoque. | ||||
inventory_management |
|
O serviço de processamento de pedidos que acompanha o número de itens em estoque para a variante do produto. | varchar(255) | ||
inventory_policy |
|
Indica se os clientes podem realizar um pedido que inclua a variante do produto quando ela estiver fora de estoque. | varchar(40) | ||
inventory_quantity | Padrão: 1 | Um agregado de estoque em todos os locais. Para ajustar o estoque em um local específico, use o recurso InventoryLevel. | int(11) | Somente leitura | |
option | As propriedades personalizadas que um titular da loja usa para definir variantes do produto. É possível definir três opções: option1, option2, option3. Valor-padrão: título-padrão. O campo de título é uma concatenação dos campos option1, option2 e option3. A atualização dos campos de opção atualiza o campo de título. | ||||
position | Padrão: 0 | A ordem da variante do produto na lista de variantes. A primeira posição na lista é 1. A posição das variantes é indicada pela ordem em que estão listadas. | smallint(5) unsigned | Somente leitura | |
presentment_prices | Uma lista dos preços de apresentação e da Comparação de preços da variante em cada moeda de apresentação habilitada na loja. Cada objeto de preço tem estas propriedades: - currency_code: o código de três letras (formato ISO 4217) para uma das moedas de apresentação da loja. - amount: o preço da variante ou a Comparação de preços na moeda de apresentação. Requer o header "X-Shopify-Api-Features": "include-presentment-prices". |
Somente leitura | |||
price | Padrão: 0 | O preço da variante do produto. | decimal(20,2) | ||
product_id | Padrão: NULL | O identificador numérico exclusivo do produto. | bigint(20) | ||
requires_shipping | Padrão: 1 | Essa propriedade está obsoleta. Use a propriedade "requires_shipping" no recurso InventoryItem. | booleano | tinyint(1) | |
SKU | Um identificador exclusivo para a variante do produto na loja. Obrigatório para se conectar a um FulfillmentService. | varchar(255) | |||
tax_code | Esse parâmetro se aplica apenas às lojas que têm o app Avalara AvaTax instalado. Especifica o código de tributação da Avalara para a variante do produto. | ||||
tributável | Padrão: 1 | Indica se há a cobrança de tributo quando a variante do produto é vendida. | booleano | tinyint(1) | |
title | O título da variante do produto. O campo do título é uma concatenação dos campos option1, option2 e option3. O título só pode ser atualizado indiretamente, pelo uso dos campos de opção. | varchar(255) | Somente leitura | ||
updated_at | Padrão: NULL | A data e a hora da modificação mais recente da variante do produto. O valor é retornado no formato ISO 8601. | date | datetime | |
weight | O peso da variante do produto no sistema unitário especificado com weight_unit. | ||||
weight_unit |
|
A unidade de medida que se aplica ao peso da variante do produto. Se você não especificar um valor para weight_unit, será aplicada a unidade de medida padrão da loja. | varchar(2) |