Esquemas de dados: Armazéns e localizações

Esquemas de dados: Armazéns e localizações. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Listar · Localizações — Armazéns e localizações — Resposta

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

dataLista <LocationData > Obrigatório: Exemplo de resposta · ApiResponse_list_LocationData__.

Exemplo: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Listar — Armazéns e localizações — Resposta

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

dataLista <WarehouseData > Obrigatório: Exemplo de resposta · ApiResponse_list_WarehouseData__.

Exemplo: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Obter — Armazéns e localizações — Resposta

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

dataWarehouseData Obrigatório: Exemplo de resposta · WarehouseData.

Exemplo: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

Listar · Localizações — Armazéns e localizações — Resposta

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

codeTextoObrigatório

Código estável legível por programas.

Exemplo: "example"

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. (LocationData).

Exemplo: "example"

is_leafBooleanoObrigatório

Indica se a categoria não possui subcategorias.

Exemplo: true

location_typeTextoObrigatório

Tipo da localização no armazém.

Restrições

enum: ["zone", "rack", "shelf", "bin"]

Exemplo: "zone"

nameTextoObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"

parent_idTexto nullObrigatório

Identificador da categoria superior.

Exemplo: null

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

warehouse_idTextoObrigatório

Identificador do armazém.

Exemplo: "example"

Campos adicionais: Não

Localizações do armazém

LocationQuantity · Esquema · Esquemas de dados: Armazéns e localizações

location_idTextoObrigatório

Identificador da localização no armazém.

Restrições

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

Exemplo: "example"

on_handNúmero inteiroObrigatório

Quantidade física em stock.

minimum: 0maximum: 2147483647

Exemplo: 1

Campos adicionais: Não

Obter — Armazéns e localizações — Resposta

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

activeBooleanoObrigatório: Indica se o recurso está ativo.

Exemplo: true
address_lineTexto nullObrigatório: Linha de endereço.

Exemplo: "example"
cityTexto nullObrigatório: Cidade ou localidade.

Exemplo: "example"
codeTextoObrigatório: Código estável legível por programas.

Exemplo: "example"
country_codeTextoObrigatório: Código do país.

Exemplo: "PL"
created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
customer_visibleBooleanoObrigatório: Indica se o estado é visível para o cliente.

Exemplo: false
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (WarehouseData).

Exemplo: "example"
nameTextoObrigatório: Nome do recurso no contexto correspondente.

Exemplo: "Example"
postal_codeTexto nullObrigatório: Código postal.

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