Esquemas de dados: Inventário

Esquemas de dados: Inventário. Campos, tipos e restrições dos dados aceitos ou retornados pela API.

Esquemas de dados

Quantidades atribuídas às localizações do armazém

AllocationData · Esquema · Esquemas de dados: Inventário

location_codeTextoObrigatório: Código da localização no armazém.

Exemplo: "example"
location_idTextoObrigatório: Identificador da localização no armazém.

Exemplo: "example"
location_nameTextoObrigatório: Nome da localização no armazém.

Exemplo: "example"
on_handNúmero inteiroObrigatório: Quantidade física em estoque.

Exemplo: 10

Campos adicionais: Não

Listar · Estoque — Inventário — Resposta

ApiResponse_list_StockData__ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataLista <StockData > Obrigatório: Exemplo de resposta · ApiResponse_list_StockData__.

Exemplo: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"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

Obter · Estoque — Inventário — Resposta

ApiResponse_StockDetailData_ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataStockDetailData Obrigatório: Exemplo de resposta · StockDetailData.

Exemplo: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

Atualizar · Reserva manual — Inventário — Corpo da requisição

ManualReservationUpdate · Campos, tipos e restrições dos dados aceitos ou retornados 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
manual_reservedNúmero inteiroObrigatório: Quantidade reservada manualmente.

minimum: 0maximum: 2147483647

Exemplo: 1
reasonTextoOpcional: Motivo registrado para a alteração.

maxLength: 500

Padrão: ""

Campos adicionais: Não

Atualizar · Limite de vendas — Inventário — Corpo da requisição

SalesLimitUpdate · Campos, tipos e restrições dos dados aceitos ou retornados 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
reasonTextoOpcional: Motivo registrado para a alteração.

maxLength: 500

Padrão: ""
sellable_limitNúmero inteiroObrigatório: Limite de venda: -1 significa ilimitado e 0 desabilita a disponibilidade para venda.

minimum: -1maximum: 2147483647

Exemplo: 1

Campos adicionais: Não

Criar · Ajuste de estoque — Inventário — Corpo da requisição

StockAdjustmentCreate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

expected_versionNúmero inteiroObrigatório

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

minimum: 0maximum: 9223372036854775807

Exemplo: 0

locationsLista <LocationQuantity > Obrigatório

Localizações do armazém.

minItems: 1maxItems: 100

Exemplo: [{"location_id":"example","on_hand":1}]

reasonTextoObrigatório

Motivo registrado para a alteração.

minLength: 1maxLength: 500

Exemplo: "Example"

target_idTextoObrigatório

Identificador do produto ou variante afetado pela operação.

Restrições

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

Exemplo: "example"

target_typeTextoObrigatório

Indica se a operação se refere a um produto ou a uma variante.

Restrições

enum: ["product", "variant"]

Exemplo: "product"

warehouse_idTextoObrigatório

Identificador do armazém.

Restrições

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

Exemplo: "example"

Campos adicionais: Não

Atualizar · Estoque — Inventário — Corpo da requisição

StockAdjustmentUpdate · Campos, tipos e restrições dos dados aceitos ou retornados 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
locationsLista <LocationQuantity > Obrigatório: Localizações do armazém.

minItems: 1maxItems: 100

Exemplo: [{"location_id":"example","on_hand":1}]
reasonTextoObrigatório: Motivo registrado para a alteração.

minLength: 1maxLength: 500

Exemplo: "Example"

Campos adicionais: Não

Listar · Estoque — Inventário — Resposta

StockData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

activeBooleanoObrigatório

Indica se o recurso está ativo.

Exemplo: true

availableNúmero inteiro nullObrigatório

Quantidade disponível para venda; null representa uma quantidade ilimitada.

Exemplo: 5

idTextoObrigatório

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

Exemplo: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNúmero inteiroObrigatório

Quantidade reservada manualmente.

Exemplo: 2

on_handNúmero inteiroObrigatório

Quantidade física em estoque.

Exemplo: 10

reservedNúmero inteiroObrigatório

Quantidade reservada por pedidos.

Exemplo: 3

sellable_limitNúmero inteiroObrigatório

Limite de venda: -1 significa ilimitado e 0 desabilita a disponibilidade para venda.

Exemplo: 10

target_idTextoObrigatório

Identificador do produto ou variante afetado pela operação.

Exemplo: "example"

target_typeTextoObrigatório

Indica se a operação se refere a um produto ou a uma variante.

Restrições

enum: ["product", "variant"]

Exemplo: "product"

total_reservedNúmero inteiroObrigatório

Quantidade total reservada.

Exemplo: 5

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

Exemplo: 1

warehouse_idTextoObrigatório

Identificador do armazém.

Exemplo: "example"

Campos adicionais: Não

Obter · Estoque — Inventário — Resposta

StockDetailData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

activeBooleanoObrigatório

Indica se o recurso está ativo.

Exemplo: true

allocationsLista <AllocationData > Obrigatório

Quantidades atribuídas às localizações do armazém.

Exemplo: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableNúmero inteiro nullObrigatório

Quantidade disponível para venda; null representa uma quantidade ilimitada.

Exemplo: 5

idTextoObrigatório

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

Exemplo: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNúmero inteiroObrigatório

Quantidade reservada manualmente.

Exemplo: 2

on_handNúmero inteiroObrigatório

Quantidade física em estoque.

Exemplo: 10

reservedNúmero inteiroObrigatório

Quantidade reservada por pedidos.

Exemplo: 3

sellable_limitNúmero inteiroObrigatório

Limite de venda: -1 significa ilimitado e 0 desabilita a disponibilidade para venda.

Exemplo: 10

target_idTextoObrigatório

Identificador do produto ou variante afetado pela operação.

Exemplo: "example"

target_typeTextoObrigatório

Indica se a operação se refere a um produto ou a uma variante.

Restrições

enum: ["product", "variant"]

Exemplo: "product"

total_reservedNúmero inteiroObrigatório

Quantidade total reservada.

Exemplo: 5

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

Exemplo: 1

warehouse_idTextoObrigatório

Identificador do armazém.

Exemplo: "example"

Campos adicionais: Não