Esquemas de dados: Produtos

Esquemas de dados: Produtos. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Listar — Produtos — Resposta

ApiResponse_list_ProductSummaryData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <ProductSummaryData > Obrigatório: Exemplo de resposta · ApiResponse_list_ProductSummaryData__.

Exemplo: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

Obter — Produtos — Resposta

ApiResponse_ProductDetailData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataProductDetailData Obrigatório: Exemplo de resposta · ProductDetailData.

Exemplo: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campos adicionais: Não

Informações de disponibilidade no contexto selecionado

AvailabilityData · Esquema · Esquemas de dados: Produtos

available_fromTexto nullObrigatório: Início da disponibilidade.

Texto:format: "date-time"

Exemplo: null
available_untilTexto nullObrigatório: Fim da disponibilidade.

Texto:format: "date-time"

Exemplo: null
is_availableBooleanoObrigatório: Indica se o item está disponível neste contexto.

Exemplo: true

Campos adicionais: Não

Informações do preço no contexto selecionado

PriceData · Esquema · Esquemas de dados: Produtos

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: "0.00"

currencyTextoObrigatório

Código da moeda do valor.

Restrições

pattern: "^[A-Z]{3}$"

Exemplo: "PLN"

minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4

Exemplo: 2

tax_includedBooleanoObrigatório

Indica se o preço enviado inclui impostos.

Exemplo: true

Campos adicionais: Não

Informações da lista de preços

PriceListData · Esquema · Esquemas de dados: Produtos

currencyTextoObrigatório: Código da moeda do valor.
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (PriceListData).
tax_includedBooleanoObrigatório: Indica se o preço enviado inclui impostos.
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controlo de concorrência.

Campos adicionais: Não

Criar — Produtos — Corpo da requisição

ProductCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

brand_idTexto nullOpcional

Identificador da marca.

Texto:minLength: 1maxLength: 63

conditionTextoOpcional

Condição do produto.

Restrições

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Predefinido: "new"

descriptionTexto nullOpcional

Descrição no idioma selecionado.

Texto:maxLength: 100000

feature_value_idsLista <Texto> Opcional

Identificadores dos valores de características selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

identifiersProductIdentifiers nullOpcional

Códigos de identificação do produto.

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

media_idsLista <Texto> Opcional

Identificadores de ficheiros de multimédia já existentes.

maxItems: 20

Lista:minLength: 1maxLength: 63

meta_descriptionTexto nullOpcional

Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160

meta_keywordsLista <Texto> nullOpcional

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20

Lista / Lista:maxLength: 50

meta_titleTexto nullOpcional

Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 300

Exemplo: "Example"

pricingProductPrice Opcional

Configuração de preços e versões para controlo de concorrência.

primary_category_idTexto nullOpcional

Identificador da categoria principal.

Texto:minLength: 1maxLength: 63

publishedBooleanoOpcional

Indica se o recurso está publicado.

Predefinido: false

skuTextoObrigatório

Código da unidade de manutenção de stock.

minLength: 1maxLength: 100

Restrições

pattern: "^\\S+$"

Exemplo: "example"

slugTexto nullOpcional

Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160

tax_category_idTexto nullOpcional

Identificador da categoria fiscal.

Texto:minLength: 1maxLength: 63

variant_value_idsLista <Texto> Opcional

Identificadores dos valores de variantes selecionados.

maxItems: 250

Lista:minLength: 1maxLength: 63

variants_enabledBooleanoOpcional

Indica se o produto utiliza variantes.

Predefinido: false

Campos adicionais: Não

Obter — Produtos — Resposta

ProductDetailData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

availabilityAvailabilityData Obrigatório

Informações de disponibilidade no contexto selecionado.

Exemplo: {"available_from":null,"available_until":null,"is_available":true}

brand_idTexto nullObrigatório

Identificador da marca.

Exemplo: null

conditionTextoObrigatório

Condição do produto.

Restrições

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Exemplo: "new"

created_atTextoObrigatório

Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

descriptionTexto nullObrigatório

Descrição no idioma selecionado.

Exemplo: "example"

featuresLista <FeatureSelectionData > Obrigatório

Características do produto.

Exemplo: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (ProductDetailData).

Exemplo: "example"

identifiersObjetoCampos adicionais: TextoObrigatório

Códigos de identificação do produto.

Exemplo: {}

mediaLista <ProductMediaData > Obrigatório

Informações dos ficheiros de multimédia anexados.

Exemplo:

[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

meta_descriptionTexto nullObrigatório

Descrição para mecanismos de pesquisa no idioma selecionado.

Exemplo: "example"

meta_keywordsLista <Texto> nullObrigatório

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Exemplo: ["example"]

meta_titleTexto nullObrigatório

Título para mecanismos de pesquisa no idioma selecionado.

Exemplo: "example"

nameTexto nullObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"

pricePriceData nullObrigatório

Informações do preço no contexto selecionado.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionNúmero inteiroObrigatório

Versão atual do preço para controlo de concorrência.

Exemplo: 1

primary_category_idTexto nullObrigatório

Identificador da categoria principal.

Exemplo: "example"

primary_media_idTexto nullObrigatório

Identificador do ficheiro de multimédia principal.

Exemplo: "example"

publishedBooleanoObrigatório

Indica se o recurso está publicado.

Exemplo: false

skuTextoObrigatório

Código da unidade de manutenção de stock.

Exemplo: "example"

slugTexto nullObrigatório

Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"

tax_category_idTextoObrigatório

Identificador da categoria fiscal.

Exemplo: "example"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

variants_enabledBooleanoObrigatório

Indica se o produto utiliza variantes.

Exemplo: false

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Códigos de identificação do produto

ProductIdentifiers · Esquema · Esquemas de dados: Produtos

eanTexto nullOpcional: Identificador EAN do produto.

Texto:minLength: 1maxLength: 100
isbnTexto nullOpcional: Identificador ISBN.

Texto:minLength: 1maxLength: 100
mpnTexto nullOpcional: Número de peça do fabricante.

Texto:minLength: 1maxLength: 100
upcTexto nullOpcional: Identificador UPC do produto.

Texto:minLength: 1maxLength: 100

Campos adicionais: Não

Informações dos ficheiros de multimédia anexados

ProductMediaData · Esquema · Esquemas de dados: Produtos

alt_textTexto nullObrigatório

Texto alternativo de uma imagem.

Exemplo: "example"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (ProductMediaData).

Exemplo: "example"

is_primaryBooleanoObrigatório

Indica se este é o item principal.

Exemplo: true

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["image", "video", "model_3d"]

Exemplo: "image"

mime_typeTextoObrigatório

Tipo de conteúdo da multimédia.

Exemplo: "image/jpeg"

positionNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 1

urlTexto nullObrigatório

URL do recurso.

Exemplo: "https://example.invalid/product.jpg"

Campos adicionais: Não

Configuração de preços e versões para controlo de concorrência

ProductPrice · Esquema · Esquemas de dados: Produtos

amountTexto nullObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

Texto:maxLength: 19

Restrições · Texto 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Exemplo: "0.00"

currencyTextoObrigatório

Código da moeda do valor.

Restrições

pattern: "^[A-Z]{3}$"

Exemplo: "PLN"

expected_price_list_versionNúmero inteiroObrigatório

Versão da lista de preços lida anteriormente e exigida nesta escrita.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 0maximum: 9223372036854775807

Exemplo: 0

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["base", "market_fixed"]

Exemplo: "base"

price_list_idTextoObrigatório

Identificador da lista de preços.

minLength: 1maxLength: 63

Exemplo: "example"

tax_includedBooleanoObrigatório

Indica se o preço enviado inclui impostos.

Exemplo: true

Campos adicionais: Não

Listar — Produtos — Resposta

ProductSummaryData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

availabilityAvailabilityData Obrigatório

Informações de disponibilidade no contexto selecionado.

Exemplo: {"available_from":null,"available_until":null,"is_available":true}

brand_idTexto nullObrigatório

Identificador da marca.

Exemplo: null

conditionTextoObrigatório

Condição do produto.

Restrições

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Exemplo: "new"

created_atTextoObrigatório

Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (ProductSummaryData).

Exemplo: "example"

nameTexto nullObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"

pricePriceData nullObrigatório

Informações do preço no contexto selecionado.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionNúmero inteiroObrigatório

Versão atual do preço para controlo de concorrência.

Exemplo: 1

primary_category_idTexto nullObrigatório

Identificador da categoria principal.

Exemplo: "example"

primary_media_idTexto nullObrigatório

Identificador do ficheiro de multimédia principal.

Exemplo: "example"

publishedBooleanoObrigatório

Indica se o recurso está publicado.

Exemplo: false

skuTextoObrigatório

Código da unidade de manutenção de stock.

Exemplo: "example"

slugTexto nullObrigatório

Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"

tax_category_idTextoObrigatório

Identificador da categoria fiscal.

Exemplo: "example"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

variants_enabledBooleanoObrigatório

Indica se o produto utiliza variantes.

Exemplo: false

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Atualizar — Produtos — Corpo da requisição

ProductUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

brand_idTexto nullOpcional

Identificador da marca.

Texto:minLength: 1maxLength: 63

conditionTextoOpcional

Condição do produto.

Restrições

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

descriptionTexto nullOpcional

Descrição no idioma selecionado.

Texto:maxLength: 100000

Exemplo: null

expected_variant_price_versionsObjetoCampos adicionais: Número inteiro

minimum: 0maximum: 9223372036854775807

Opcional

Versões de preços lidas anteriormente, indexadas pelo identificador da variante.

maxProperties: 250

Restrições

propertyNames: {"maxLength": 63, "minLength": 1}

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

feature_value_idsLista <Texto> Opcional

Identificadores dos valores de características selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

identifiersProductIdentifiers nullOpcional

Códigos de identificação do produto.

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

media_idsLista <Texto> Opcional

Identificadores de ficheiros de multimédia já existentes.

maxItems: 20

Lista:minLength: 1maxLength: 63

meta_descriptionTexto nullOpcional

Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160

meta_keywordsLista <Texto> nullOpcional

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20

Lista / Lista:maxLength: 50

meta_titleTexto nullOpcional

Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70

nameTexto nullOpcional

Nome do recurso no contexto correspondente.

Texto:maxLength: 300

Exemplo: null

pricingProductPrice Opcional

Configuração de preços e versões para controlo de concorrência.

Exemplo:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}

primary_category_idTexto nullOpcional

Identificador da categoria principal.

Texto:minLength: 1maxLength: 63

publishedBooleanoOpcional

Indica se o recurso está publicado.

skuTextoOpcional

Código da unidade de manutenção de stock.

minLength: 1maxLength: 100

Restrições

pattern: "^\\S+$"

Exemplo: "example"

slugTexto nullOpcional

Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160

tax_category_idTexto nullOpcional

Identificador da categoria fiscal.

Texto:minLength: 1maxLength: 63

variant_value_idsLista <Texto> Opcional

Identificadores dos valores de variantes selecionados.

maxItems: 250

Lista:minLength: 1maxLength: 63

variants_enabledBooleanoOpcional

Indica se o produto utiliza variantes.

Campos adicionais: Não