Saltar para o conteúdo
ShopentlyLearn

Esquemas de dados: Características e valores

Esquemas de dados: Características e valores. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Obter — Características e valores — Resposta

ApiResponse_FeatureData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
dataFeatureData Obrigatório

Exemplo de resposta · FeatureData.

Exemplo: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","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

Obter · Valores — Características e valores — Resposta

ApiResponse_FeatureValueData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
dataFeatureValueData Obrigatório

Exemplo de resposta · FeatureValueData.

Exemplo: {"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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

Listar — Características e valores — Resposta

ApiResponse_list_FeatureData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
dataLista <FeatureData > Obrigatório

Exemplo de resposta · ApiResponse_list_FeatureData__.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","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

Listar · Valores — Características e valores — Resposta

ApiResponse_list_FeatureValueData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
dataLista <FeatureValueData > Obrigatório

Exemplo de resposta · ApiResponse_list_FeatureValueData__.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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

Criar — Características e valores — Corpo da requisição

FeatureCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 120
Restrições
pattern
"^[^\\x00]*$"
Exemplo: "Example"
positionNúmero inteiroOpcional

Posição na coleção ordenada.

minimum: 0maximum: 2147483647

Campos adicionais: Não

Obter — Características e valores — Resposta

FeatureData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
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. (FeatureData).

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"
positionNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 1
updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
Exemplo: "2026-01-01T12:00:00Z"
versionNúmero inteiroObrigatório

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

Exemplo: 1

Campos adicionais: Não

Características do produto

FeatureSelectionData · Esquema · Esquemas de dados: Características e valores
feature_idTextoObrigatório

Identificador da característica.

Exemplo: "example"
feature_nameTexto nullObrigatório

Nome da característica.

Exemplo: "example"
valueTexto nullObrigatório

Valor definido pelo esquema que o contém.

Exemplo: "example"
value_idTextoObrigatório

Identificador do valor do catálogo.

Exemplo: "example"

Campos adicionais: Não

Atualizar — Características e valores — Corpo da requisição

FeatureUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807
Exemplo: 1
nameTexto nullOpcional

Nome do recurso no contexto correspondente.

Texto:minLength: 1maxLength: 120
Restrições · Texto 1
pattern
"^[^\\x00]*$"
Exemplo: "Example"
positionNúmero inteiroOpcional

Posição na coleção ordenada.

minimum: 0maximum: 2147483647

Campos adicionais: Não

Criar · Valores — Características e valores — Corpo da requisição

FeatureValueCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807
Exemplo: 1
positionNúmero inteiroOpcional

Posição na coleção ordenada.

minimum: 0maximum: 2147483647
valueTextoObrigatório

Valor definido pelo esquema que o contém.

minLength: 1maxLength: 180
Restrições
pattern
"^[^\\x00]*$"
Exemplo: "Example"

Campos adicionais: Não

Obter · Valores — Características e valores — Resposta

FeatureValueData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
created_atTextoObrigatório

Momento da criação.

format: "date-time"
Exemplo: "2026-01-01T12:00:00Z"
feature_idTextoObrigatório

Identificador da característica.

Exemplo: "example"
idTextoObrigatório

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

Exemplo: "example"
numberTextoObrigatório

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

Exemplo: "example"
positionNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 1
updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
Exemplo: "2026-01-01T12:00:00Z"
valueTexto nullObrigatório

Valor definido pelo esquema que o contém.

Exemplo: "example"
versionNúmero inteiroObrigatório

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

Exemplo: 1

Campos adicionais: Não

Atualizar · Valores — Características e valores — Corpo da requisição

FeatureValueUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.
expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807
Exemplo: 1
positionNúmero inteiroOpcional

Posição na coleção ordenada.

minimum: 0maximum: 2147483647
valueTexto nullOpcional

Valor definido pelo esquema que o contém.

Texto:minLength: 1maxLength: 180
Restrições · Texto 1
pattern
"^[^\\x00]*$"
Exemplo: "Example"

Campos adicionais: Não