Esquemas de dados: Entregas de mercadorias

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

Esquemas de dados

Obter — Entregas de mercadorias — Resposta

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

dataDeliveryDetailData Obrigatório: Exemplo de resposta · DeliveryDetailData.

Exemplo: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Listar — Entregas de mercadorias — Resposta

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

dataLista <DeliveryData > Obrigatório: Exemplo de resposta · ApiResponse_list_DeliveryData__.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Criar — Entregas de mercadorias — Corpo da requisição

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

delivered_atTextoObrigatório

Data e hora da entrega.

format: "date-time"

Exemplo: "2026-01-01T00:00:00Z"

increases_stockBooleanoOpcional

Indica se o receção da entrega aumenta o stock.

Predefinido: true

location_idTextoObrigatório

Identificador da localização no armazém.

Restrições

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

Exemplo: "example"

notesTextoOpcional

Observações adicionais.

maxLength: 2000

Predefinido: ""

quantityNúmero inteiroObrigatório

Número de unidades.

minimum: 1maximum: 2147483647

Exemplo: 1

reasonTextoOpcional

Motivo registado para a alteração.

maxLength: 500

Predefinido: ""

statusTextoObrigatório

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

Restrições

enum: ["planned", "received"]

Exemplo: "planned"

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

Listar — Entregas de mercadorias — Resposta

DeliveryData · 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"

deleted_atTexto nullObrigatório

Momento da eliminação, se houver.

Texto:format: "date-time"

Exemplo: null

delivered_atTextoObrigatório

Data e hora da entrega.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

idTextoObrigatório

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

Exemplo: "example"

increases_stockBooleanoObrigatório

Indica se o receção da entrega aumenta o stock.

Exemplo: true

location_idTextoObrigatório

Identificador da localização no armazém.

Exemplo: "example"

quantityNúmero inteiroObrigatório

Número de unidades.

Exemplo: 1

received_atTexto nullObrigatório

Data e hora do receção da entrega.

Texto:format: "date-time"

Exemplo: null

record_statusTextoObrigatório

Estado armazenado do registo.

Restrições

enum: ["active", "deleted"]

Exemplo: "active"

statusTextoObrigatório

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

Restrições

enum: ["planned", "received"]

Exemplo: "planned"

stock_applied_atTexto nullObrigatório

Data e hora em que a alteração de stock da entrega foi aplicada.

Texto:format: "date-time"

Exemplo: null

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"

updated_atTexto nullObrigatório

Momento da atualização mais recente.

Texto: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

Obter — Entregas de mercadorias — Resposta

DeliveryDetailData · 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"

deleted_atTexto nullObrigatório

Momento da eliminação, se houver.

Texto:format: "date-time"

Exemplo: null

delivered_atTextoObrigatório

Data e hora da entrega.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

idTextoObrigatório

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

Exemplo: "example"

increases_stockBooleanoObrigatório

Indica se o receção da entrega aumenta o stock.

Exemplo: true

location_idTextoObrigatório

Identificador da localização no armazém.

Exemplo: "example"

notesTexto nullObrigatório

Observações adicionais.

Exemplo: "example"

quantityNúmero inteiroObrigatório

Número de unidades.

Exemplo: 1

received_atTexto nullObrigatório

Data e hora do receção da entrega.

Texto:format: "date-time"

Exemplo: null

record_statusTextoObrigatório

Estado armazenado do registo.

Restrições

enum: ["active", "deleted"]

Exemplo: "active"

statusTextoObrigatório

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

Restrições

enum: ["planned", "received"]

Exemplo: "planned"

stock_applied_atTexto nullObrigatório

Data e hora em que a alteração de stock da entrega foi aplicada.

Texto:format: "date-time"

Exemplo: null

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"

updated_atTexto nullObrigatório

Momento da atualização mais recente.

Texto: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