Saltar para o conteúdo
ShopentlyLearn

Esquemas de dados: Marcas

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

Esquemas de dados

Obter — Marcas — Resposta

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

Exemplo de resposta · BrandData.

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

Listar — Marcas — Resposta

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

Exemplo de resposta · ApiResponse_list_BrandData__.

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

Criar — Marcas — Corpo da requisição

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

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160
Exemplo: "Example"

Campos adicionais: Não

Obter — Marcas — Resposta

BrandData · 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. (BrandData).

Exemplo: "example"
nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"
numberTextoObrigatório

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

Exemplo: "example"
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

Atualizar — Marcas — Corpo da requisição

BrandUpdate · 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
nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160
Exemplo: "Example"

Campos adicionais: Não