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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Códigos são retornados em JSON; arquivos, em binário. Toda requisição exige Bearer e a permissão reveal.

dataCodeContentData Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Confira tamanho, checksum e formato. Um envio pronto ainda não significa uma entrega recebida.

dataDigitalUploadData Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

ApiResponse[ImportData]

ApiResponse_ImportData_ · Confira o estado, a versão e a validação. O rascunho pertence à chave API que o criou.

dataImportData Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Leia as configurações e quantidades antes de alterá-las. A resposta não contém códigos nem arquivos.

dataPoolData Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Consulte até 100 unidades por página. A lista mostra metadados sem revelar os códigos.

dataUnitsData Obrigatório: Conteúdo de uma resposta bem-sucedida.

Exemplo: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

CodeContentData

CodeContentData · Códigos são retornados em JSON; arquivos, em binário. Toda requisição exige Bearer e a permissão reveal.

codeTextoObrigatório: O código digital exato. Preserve as maiúsculas e os espaços internos.

minLength: 1maxLength: 512

Exemplo: "DEMO-ONE"
delivery_idTexto nullOpcional: ID da entrega ou atribuição do pedido.

Texto:format: "uuid"

Exemplo: null
kindTextoOpcional: Variante da estrutura de dados definida pelos valores permitidos.

const: "code"

Padrão: "code"Exemplo: "code"
payload_idTextoObrigatório: ID do conteúdo; não é uma URL pública de download.

format: "uuid"

Exemplo: "00000000-0000-4000-8000-000000000004"
unit_idTextoObrigatório: ID de um código ou arquivo individual.

format: "uuid"

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

Campos adicionais: Não

DigitalUploadCreate

DigitalUploadCreate · Reserve espaço para um arquivo e vincule-o a uma importação ou à unidade que será substituída.

consumer_idTextoObrigatório

ID da importação ou unidade vinculada.

format: "uuid"

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

consumer_kindTextoObrigatório

Destino do envio: digital_import / digital_unit.

Restrições

enum: ["digital_import", "digital_unit"]

Exemplo: "digital_import"

filenameTextoObrigatório

Arquivo

minLength: 1maxLength: 255

Exemplo: "codes.txt"

purposeTextoObrigatório

digital_import: TXT/CSV; digital_unit: arquivo vendido individualmente.

Restrições

enum: ["digital_unit", "digital_import"]

Exemplo: "digital_import"

sha256TextoObrigatório

SHA-256 (hex, 64)

Restrições

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

Exemplo: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNúmero inteiroObrigatório

Tamanho em bytes

minimum: 1maximum: 262144000

Exemplo: 18

Campos adicionais: Não

DigitalUploadData

DigitalUploadData · Confira tamanho, checksum e formato. Um envio pronto ainda não significa uma entrega recebida.

consumer_idTextoObrigatório

ID da importação ou unidade vinculada.

format: "uuid"

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

consumer_kindTextoObrigatório

Destino do envio: digital_import / digital_unit.

Restrições

enum: ["digital_import", "digital_unit"]

Exemplo: "digital_import"

expires_atTextoObrigatório

Prazo de validade deste envio ou importação.

format: "date-time"

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

filenameTextoObrigatório

Arquivo

Exemplo: "codes.txt"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"

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

product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"

purposeTextoObrigatório

digital_import: TXT/CSV; digital_unit: arquivo vendido individualmente.

Restrições

enum: ["digital_unit", "digital_import"]

Exemplo: "digital_import"

received_bytesNúmero inteiroObrigatório

Enviando… · Tamanho em bytes

Exemplo: 18

sha256TextoObrigatório

SHA-256 (hex, 64)

Exemplo: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNúmero inteiroObrigatório

Tamanho em bytes

Exemplo: 18

statusTextoObrigatório

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

Exemplo: "ready"

Campos adicionais: Não

ImportCommit

ImportCommit · Crie uma entrega planejada ou recebida com o lote validado. Uma entrega planejada ainda não pode ser vendida.

delivered_atTextoObrigatório

Data e hora da entrega.

format: "date-time"

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

expected_delivery_versionNúmero inteiroObrigatório

Versão da entrega; 0 para uma nova entrega.

minimum: 0maximum: 0

Exemplo: 0

expected_sales_limit_versionNúmero inteiro nullOpcional

Versão do limite de venda; obrigatória com publish_for_sale=true.

Número inteiro:minimum: 0maximum: 9223372036854775807

Exemplo: 0

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 2

location_idTextoObrigatório

Identificador da localização no armazém.

Restrições

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

Exemplo: "location-digital"

publish_for_saleBooleanoOpcional

true também aumenta o limite finito de venda; false não o altera.

Padrão: falseExemplo: true

statusTextoObrigatório

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

Restrições

enum: ["planned", "received"]

Exemplo: "received"

validation_digestTextoObrigatório

Checksum da validação; envie sem alterações na confirmação.

Restrições

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

Exemplo: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idTextoObrigatório

Identificador do armazém.

Restrições

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

Exemplo: "warehouse-main"

Campos adicionais: Não

ImportCreate

ImportCreate · Prepare um rascunho com até 1000 códigos ou 100 arquivos. Isso ainda não aumenta o estoque à venda.

countNúmero inteiroObrigatório

Número exato de unidades do lote.

minimum: 1maximum: 1000

Exemplo: 2

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["code", "file"]

Exemplo: "code"

Campos adicionais: Não

ImportData

ImportData · Confira o estado, a versão e a validação. O rascunho pertence à chave API que o criou.

delivery_idTexto nullObrigatório

ID da entrega ou atribuição do pedido.

Exemplo: null

delivery_statusTexto nullObrigatório

Estado da entrega: planned / received; null antes da confirmação.

Exemplo: null

delivery_versionNúmero inteiro nullObrigatório

Versão atual da entrega do depósito.

Exemplo: null

expected_countNúmero inteiroObrigatório

Quantidade esperada; somente o lote completo é aceito.

Exemplo: 2

expires_atTextoObrigatório

Prazo de validade deste envio ou importação.

format: "date-time"

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

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"

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

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["code", "file"]

Exemplo: "code"

product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"

statusTextoObrigatório

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

Exemplo: "validated"

validated_countNúmero inteiroObrigatório

Unidades aceitas na última validação bem-sucedida.

Exemplo: 2

validation_digestTexto nullObrigatório

Checksum da validação; envie sem alterações na confirmação.

Exemplo: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionNúmero inteiroObrigatório

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

Exemplo: 2

Campos adicionais: Não

ImportReceive

ImportReceive · Receba as unidades existentes sem importar novamente os códigos ou arquivos.

expected_delivery_versionNúmero inteiroObrigatório: Versão da entrega; 0 para uma nova entrega.

minimum: 1maximum: 9223372036854775807

Exemplo: 1
expected_sales_limit_versionNúmero inteiro nullOpcional: Versão do limite de venda; obrigatória com publish_for_sale=true.

Número inteiro:minimum: 0maximum: 9223372036854775807
expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 3
publish_for_saleBooleanoOpcional: true também aumenta o limite finito de venda; false não o altera.

Padrão: false

Campos adicionais: Não

ImportValidate

ImportValidate · Valide o lote inteiro. Duplicatas ou entradas inválidas rejeitam o lote; os códigos nunca são truncados.

code_columnTexto nullOpcional

Coluna CSV dos códigos; use code.

Texto:const: "code"

expected_versionNúmero inteiroObrigatório

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

minimum: 1maximum: 9223372036854775807

Exemplo: 1

formatTexto nullOpcional

Lista de códigos: txt / csv; use upload_ids para arquivos.

Restrições · Texto 1

enum: ["txt", "csv"]

Exemplo: "txt"

source_upload_idTexto nullOpcional

Envio privado TXT/CSV pronto desta importação.

Texto:format: "uuid"

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

upload_idsLista <Texto> nullOpcional

1–100 envios privados de arquivos prontos desta importação.

Lista:minItems: 1maxItems: 100

Lista / Lista:format: "uuid"

Campos adicionais: Não

ImportWithdrawal

ImportWithdrawal · Retire somente unidades livres. As reservadas e atribuídas continuam vinculadas aos pedidos.

expected_delivery_versionNúmero inteiroObrigatório: Versão da entrega; 0 para uma nova entrega.

minimum: 1maximum: 9223372036854775807

Exemplo: 1
expected_order_versionNúmero inteiroObrigatório: Versão da ordem de atribuição, não do pedido do cliente.

minimum: 0maximum: 9223372036854775807

Exemplo: 1
expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 3
reasonTextoObrigatório: Motivo registrado para a alteração.

minLength: 1maxLength: 500

Exemplo: "Withdraw a revoked license"

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

PoolChange

PoolChange · Ative códigos ou arquivos individuais a partir do Professional. Desativar mantém o acesso às compras anteriores.

email_modeTextoOpcional

disabled: sem e-mail; order_link: link do pedido; code_text: pode incluir códigos.

Restrições

enum: ["disabled", "order_link", "code_text"]

Padrão: "disabled"Exemplo: "order_link"

enabledBooleanoObrigatório

Indica se esta configuração está habilitada.

Exemplo: true

expected_versionNúmero inteiroObrigatório

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

minimum: 0maximum: 9223372036854775807

Exemplo: 0

retention_daysNúmero inteiro nullOpcional

null: sem prazo; 1–3650 dias desde o primeiro acesso. Códigos não são apagados automaticamente.

Número inteiro:minimum: 1maximum: 3650

Exemplo: null

Campos adicionais: Não

PoolCounts

PoolCounts · Leia as configurações e quantidades antes de alterá-las. A resposta não contém códigos nem arquivos.

availableNúmero inteiroObrigatório: Quantidade de unidades livres, não reservadas nem entregues.

Exemplo: 1
heldNúmero inteiroObrigatório: Unidades reservadas para pedidos, ainda não entregues.

Exemplo: 0
issuedNúmero inteiroObrigatório: Unidades já entregues a compras pagas.

Exemplo: 1
plannedNúmero inteiroObrigatório: Unidades de entregas confirmadas ainda não recebidas.

Exemplo: 0
retiredNúmero inteiroObrigatório: Unidades retiradas mantidas no histórico.

Exemplo: 0
stagedNúmero inteiroObrigatório: Unidades de importações incompletas, ainda fora do estoque.

Exemplo: 0

Campos adicionais: Não

PoolData

PoolData · Leia as configurações e quantidades antes de alterá-las. A resposta não contém códigos nem arquivos.

configuredBooleanoObrigatório

Indica se as configurações do estoque foram salvas.

Exemplo: true

countsPoolCounts Obrigatório

Quantidade de unidades por estado do estoque.

Exemplo: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeTextoObrigatório

disabled: sem e-mail; order_link: link do pedido; code_text: pode incluir códigos.

Restrições

enum: ["disabled", "order_link", "code_text"]

Exemplo: "order_link"

enabledBooleanoObrigatório

Indica se esta configuração está habilitada.

Exemplo: true

order_versionNúmero inteiroObrigatório

Versão da ordem de atribuição do estoque.

Exemplo: 2

product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"

retention_daysNúmero inteiro nullObrigatório

null: sem prazo; 1–3650 dias desde o primeiro acesso. Códigos não são apagados automaticamente.

Exemplo: null

versionNúmero inteiroObrigatório

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

Exemplo: 1

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

UnitData

UnitData · Consulte até 100 unidades por página. A lista mostra metadados sem revelar os códigos.

content_stateTextoObrigatório

Estado do conteúdo: present / deleting / deleted.

Exemplo: "present"

delivery_idTexto nullObrigatório

ID da entrega ou atribuição do pedido.

Exemplo: "delivery-example"

filenameTexto nullObrigatório

Arquivo

Exemplo: null

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

format: "uuid"

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

issued_atTexto nullObrigatório

Primeira entrega; null antes dela.

Texto:format: "date-time"

Exemplo: null

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["file", "code"]

Exemplo: "code"

location_idTexto nullObrigatório

Identificador da localização no armazém.

Exemplo: "location-digital"

mime_typeTexto nullObrigatório

Tipo de conteúdo da mídia.

Exemplo: null

payload_idTextoObrigatório

ID do conteúdo; não é uma URL pública de download.

format: "uuid"

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

product_idTextoObrigatório

Identificador do produto.

Exemplo: "example"

size_bytesNúmero inteiro nullObrigatório

Tamanho em bytes

Exemplo: null

sort_orderNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 1

stateTextoObrigatório

Estado

Exemplo: "available"

versionNúmero inteiroObrigatório

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

Exemplo: 1

warehouse_idTexto nullObrigatório

Identificador do armazém.

Exemplo: "warehouse-main"

Campos adicionais: Não

UnitDeletion

UnitDeletion · Retire um código ou arquivo não vendido e informe o motivo. Unidades reservadas ou atribuídas são recusadas.

expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1

Exemplo: 1
reasonTextoObrigatório: Motivo registrado para a alteração.

minLength: 1maxLength: 500

Exemplo: "Withdraw a revoked license"

Campos adicionais: Não

UnitReorder

UnitReorder · Envie a página completa sem filtros na ordem desejada. Uma versão desatualizada retorna 409.

expected_order_versionNúmero inteiroObrigatório: Versão da ordem de atribuição, não do pedido do cliente.

minimum: 1

Exemplo: 1
unit_idsLista <Texto> Obrigatório: Todas as unidades da página sem filtros na ordem desejada.

minItems: 2maxItems: 100
Lista:format: "uuid"

Exemplo: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorTexto nullOpcional: Cursor da página sem filtros; null para a primeira.

Texto:maxLength: 1024

Campos adicionais: Não

UnitReplacement

UnitReplacement · Troque o código ou arquivo sem mudar sua posição. A alteração fica no histórico do estoque.

codeTexto nullOpcional: O código digital exato. Preserve as maiúsculas e os espaços internos.

Texto:minLength: 1maxLength: 512

Exemplo: "SYNTHETIC-REPLACEMENT"
expected_versionNúmero inteiroObrigatório: Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1

Exemplo: 1
reasonTextoObrigatório: Motivo registrado para a alteração.

minLength: 1maxLength: 500

Exemplo: "Replace an invalid activation code"
upload_idTexto nullOpcional: Identificador do recurso; preserve-o conforme retornado. · upload_id

Texto:format: "uuid"

Campos adicionais: Não

UnitsData

UnitsData · Consulte até 100 unidades por página. A lista mostra metadados sem revelar os códigos.

order_versionNúmero inteiroObrigatório: Versão da ordem de atribuição do estoque.

Exemplo: 2
totalNúmero inteiroObrigatório: Valor total.

Exemplo: 1
unitsLista <UnitData > Obrigatório: Metadados das unidades; o conteúdo exige outra requisição autorizada.

Exemplo: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Campos adicionais: Sim