Esquemas de dados: Produtos

dataProductFileListData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

dataReleaseListData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

dataUploadData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

dataAudienceData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Exemplo: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"request_id":"example-request"}

Campos adicionais: Não

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

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

audienceAudienceSelection Obrigatório

Regra explícita de acesso ao arquivo compartilhado.

Exemplo: {"mode":"all_purchasers"}

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 1

Campos adicionais: Não

anchor_atTextoObrigatório

Primeira publicação; não muda ao editar a regra.

format: "date-time"

Exemplo: "2026-11-03T12:00:00Z"

effective_atTextoObrigatório

Data de publicação desta regra de acesso.

format: "date-time"

Exemplo: "2026-11-03T12:00:00Z"

file_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · file_id

Exemplo: "00000000-0000-4000-8000-000000000007"

file_version_idTextoObrigatório

ID de uma versão imutável do arquivo.

Exemplo: "00000000-0000-4000-8000-000000000010"

historical_access_preservedBooleanoOpcional

Direitos já concedidos são mantidos ao restringir a regra.

Padrão: trueExemplo: true

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

Exemplo: "00000000-0000-4000-8000-000000000009"

lookback_daysNúmero inteiro | nullObrigatório

1–3650 dias antes da primeira publicação; somente recent_and_new.

Exemplo: null

modeTextoObrigatório

Regra explícita de acesso ao arquivo compartilhado. new_purchases / recent_and_new / selected / all_purchasers.

Exemplo: "all_purchasers"

next_cursorTexto | nullObrigatório

Valor de continuação da próxima página, ou null.

Exemplo: null

order_idsLista <Texto> Obrigatório

Pedidos pagos e não reembolsados que contêm este produto.

Exemplo: []

product_versionNúmero inteiroObrigatório

Versão atual do produto para controle de concorrência.

Exemplo: 3

revisionNúmero inteiroObrigatório

Revisão sequencial da regra de acesso.

Exemplo: 1

Campos adicionais: Não

lookback_daysNúmero inteiro | nullOpcional

1–3650 dias antes da primeira publicação; somente recent_and_new.

Número inteiro:minimum: 1maximum: 3650

modeTextoObrigatório

Regra explícita de acesso ao arquivo compartilhado. new_purchases / recent_and_new / selected / all_purchasers.

Restrições

enum

["new_purchases", "recent_and_new", "selected", "all_purchasers"]

Exemplo: "new_purchases"

order_idsLista <Texto> Opcional

Pedidos pagos e não reembolsados que contêm este produto.

maxItems: 1000

Restrições · Lista 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

Padrão: []

Campos adicionais: Não

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

audienceAudienceSelection | nullOpcional

Regra explícita de acesso ao arquivo compartilhado.

Exemplo: {"mode":"new_purchases"}

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 1

labelTextoOpcional

Nome do recurso no contexto correspondente.

maxLength: 300

Padrão: ""

upload_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · upload_id

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

Campos adicionais: Não

Campos adicionais: Sim

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

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 controle de concorrência.

Campos adicionais: Não

brand_idTexto | nullOpcional

Identificador da marca.

Texto:minLength: 1maxLength: 63

conditionTextoOpcional

Condição do produto.

Restrições

enum

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

Padrão: "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 arquivos de mídia já existentes.

maxItems: 30

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 controle de concorrência.

primary_category_idTexto | nullOpcional

Identificador da categoria principal.

Texto:minLength: 1maxLength: 63

publishedBooleanoOpcional

Indica se o recurso está publicado.

Padrão: false

skuTextoObrigatório

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

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.

Padrão: false

Campos adicionais: Não

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 arquivos de mí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 usuário.

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 controle de concorrência.

Exemplo: 1

primary_category_idTexto | nullObrigatório

Identificador da categoria principal.

Exemplo: "example"

primary_media_idTexto | nullObrigatório

Identificador do arquivo de mídia principal.

Exemplo: "example"

publishedBooleanoObrigatório

Indica se o recurso está publicado.

Exemplo: false

skuTextoObrigatório

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

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 controle de concorrência.

Exemplo: 1

Campos adicionais: Não

categoryFileCategory Obrigatório

Categoria do arquivo: internal / customer_document / digital

Exemplo: "digital"

created_atTextoObrigatório

Momento da criação.

format: "date-time"

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

current_version_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · current_version_id

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

file_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · file_id

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

filenameTextoObrigatório

Arquivo

Exemplo: "manual.pdf"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

labelTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Manual"

mime_typeTextoObrigatório

Tipo de conteúdo da mídia.

Exemplo: "application/pdf"

sha256TextoObrigatório

SHA-256 (hex, 64)

Exemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"

size_bytesNúmero inteiroObrigatório

Tamanho em bytes

Exemplo: 46

stateTextoObrigatório

Estado

Exemplo: "active"

version_numberNúmero inteiroObrigatório

Versão

Exemplo: 1

Campos adicionais: Não

filesLista <ProductFileData > Obrigatório

Arquivos do produto

Exemplo: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]

product_versionNúmero inteiroObrigatório

Versão atual do produto para controle de concorrência.

Exemplo: 2

Campos adicionais: Não

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

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 mí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

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

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 usuário.

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 controle de concorrência.

Exemplo: 1

primary_category_idTexto | nullObrigatório

Identificador da categoria principal.

Exemplo: "example"

primary_media_idTexto | nullObrigatório

Identificador do arquivo de mídia principal.

Exemplo: "example"

publishedBooleanoObrigatório

Indica se o recurso está publicado.

Exemplo: false

skuTextoObrigatório

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

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 controle de concorrência.

Exemplo: 1

Campos adicionais: Não

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 arquivos de mídia já existentes.

maxItems: 30

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

pricingProductPrice Opcional

Configuração de preços e versões para controle 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 estoque.

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

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 1

Campos adicionais: Não

changelogTextoObrigatório

Descrição das alterações

Exemplo: "Manual update"

filesLista <ReleaseFileData > Obrigatório

Arquivos do produto

Exemplo: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

manifest_sha256Texto | nullObrigatório

Versões digitais · SHA-256

Exemplo: "1111111111111111111111111111111111111111111111111111111111111111"

published_atTexto | nullObrigatório

Publicar versão · UTC

Texto:format: "date-time"

Exemplo: null

release_sequenceNúmero inteiro | nullObrigatório

Versões digitais · Posição na coleção ordenada.

Exemplo: null

stateTextoObrigatório

Estado

Exemplo: "active"

version_labelTextoObrigatório

Versão

Exemplo: "1.0"

withdrawn_atTexto | nullObrigatório

Retirar oferta · UTC

Texto:format: "date-time"

Exemplo: null

Campos adicionais: Não

changelogTextoOpcional

Descrição das alterações

maxLength: 20000

Padrão: ""

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 1

version_idsLista <Texto> Obrigatório

Versão · UUID[]

minItems: 1maxItems: 20

Lista:format: "uuid"

Exemplo: ["00000000-0000-4000-8000-000000000001"]

version_labelTextoObrigatório

Versão

minLength: 1maxLength: 64

Exemplo: "1.0"

Campos adicionais: Não

file_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · file_id

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

sort_orderNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 0

version_idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. · version_id

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

Campos adicionais: Não

current_release_idTexto | nullObrigatório

Identificador do recurso; preserve-o conforme retornado. · current_release_id

Texto:format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

product_versionNúmero inteiroObrigatório

Versão atual do produto para controle de concorrência.

Exemplo: 2

releasesLista <ReleaseData > Obrigatório

Versões digitais

Exemplo: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]

update_daysNúmero inteiro | nullObrigatório

Número de dias (days; null)

Exemplo: 365

update_modeTextoObrigatório

Acesso a arquivos futuros após a compra: none / period / unlimited

Exemplo: "period"

update_monthsNúmero inteiro | nullObrigatório

Meses (months; null)

Exemplo: null

Campos adicionais: Não

daysNúmero inteiro | nullOpcional

Número de dias (1–3650; mode=period; months=null)

Número inteiro:minimum: 1maximum: 3650

Exemplo: 365

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 1

modeTextoObrigatório

Acesso a arquivos futuros após a compra: none / period / unlimited

Restrições

enum

["none", "period", "unlimited"]

Exemplo: "period"

monthsNúmero inteiro | nullOpcional

Meses (1–120; mode=period; days=null)

Número inteiro:minimum: 1maximum: 120

Exemplo: null

Campos adicionais: Não

filenameTextoObrigatório

Arquivo

minLength: 1maxLength: 255

Exemplo: "manual.pdf"

product_idTexto | nullOpcional

Identificador do produto.

Restrições · Texto 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

Exemplo: "example"

sha256TextoObrigatório

SHA-256 (hex, 64)

Restrições

pattern

"^[0-9a-f]{64}$"

Exemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"

size_bytesNúmero inteiroObrigatório

Tamanho em bytes

minimum: 1maximum: 262144000

Exemplo: 46

Campos adicionais: Não

categoryFileCategory Obrigatório

Categoria do arquivo: internal / customer_document / digital

Exemplo: "digital"

expires_atTextoObrigatório

Data e hora de expiração da credencial.

format: "date-time"

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

filenameTextoObrigatório

Arquivo

Exemplo: "manual.pdf"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000001"

product_idTexto | nullObrigatório

Identificador do produto.

Exemplo: "example"

received_bytesNúmero inteiroObrigatório

Enviando… · Tamanho em bytes

Exemplo: 46

sha256TextoObrigatório

SHA-256 (hex, 64)

Exemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"

size_bytesNúmero inteiroObrigatório

Tamanho em bytes

Exemplo: 46

statusTextoObrigatório

Estado aceito por esta operação específica.

Exemplo: "ready"

Campos adicionais: Não