Pular para o conteúdo principal

v1.1 — Novos campos, filtros e schemas

Equipe idworks
Equipe idworks
API

Atualização do contrato a partir das mudanças de comportamento dos handlers das últimas semanas: novos campos de request, novos filtros de query, enums revisados e um schema novo de movimentação. Sem quebras de compatibilidade.

✨ Added​

  • POST /accounts/bank-account e PUT /accounts/bank-account/{idbankaccount} — novo campo IDCompanyIntegrationPix no request body (integração de Pix vinculada à conta, independente da integração TEF). O PUT passa a documentar também InitialBalance e InitialBalanceDate (modo de ajuste de saldo inicial).
  • GET /orders/hub — 24 parâmetros de query agora documentados: ConsumerNameCorporateName, ConsumerCpfCnpj, ConsumerEmail, Order, OrderFrom, IDStatusOrder, IDSalesChannel, ShippingId, PackId, DateFrom, DateTo, IDCompanyIntegration, IDTypeCompanyIntegration, IDIntegration, Coupon, UtmCampaign, UtmMedium, UtmSource, UtmiCampaign, UtmiPage, UtmiPart, OrdersNotCreated, Search, Page.
  • GET /purchase — 11 filtros novos, incluindo StockKeepingUnitPurchaseScheduleStatus (1 Recebido, 2 Agendado, 3 Atrasado, 4 Não agendado), IDOrder, chNFeFrom, NfeNumberFrom, StartTimeFrom/StartTimeTo e SinceRecordTimestamp. O item de PurchaseListItem ganhou IDStockKeepingUnitPurchaseSchedule.
  • GET /sku/movement — novo modo Type=KardexBatch (Kardex por lote, exige IDBatch) com o schema novo SkuMovementKardexBatchItem (saldo e custo acumulados por lote); novo filtro de query IDBatch.
  • POST /hub/resource/{idtypecompanyintegration} — parâmetros de query IDOrdersCarrierCollectionList, LabelFormat e token documentados.
  • POST /purchase/feed/{idnfevents}/manifest — request body documentado: Event (210200 Confirmação, 210210 Ciência, 210220 Desconhecimento, 210240 Operação não Realizada) e Comments (mínimo 15 caracteres para o evento 210240).
  • Campos de resposta novos: IDCompanyIntegrationPix em BankAccount e CompanyIntegrationPix em BankAccountListItem; StatusColorCode (cor do status do pedido por empresa) em CollectionListOrderItem, PackingPickingListOrder, PickingListMovementItem e HubCarrierMapping; WarehouseName, Status, TypeOrder, StatusOrder e StatusColorCode em WarehouseHubItem.

🔄 Changed​

  • Enums revisados contra a base: IDStatusPurchase (0–12) em GET /purchase; categorias de pagamento TEF (22 Crédito, 23 Débito, 24 Pix) em POST /store-front/cashier/{idbankaccount}/payment.
  • 400 de POST/PUT /accounts/bank-account passa a listar a mensagem Integração Pix não existe.
  • Descrições de operação atualizadas em GET /orders/hub (busca textual e modo OrdersNotCreated), GET /sku/movement (modos de Type) e POST /purchase/feed/{idnfevents}/manifest.

🐛 Fixed​

  • Removido o parâmetro de query inexistente IDCompany de GET /orders/package (o handler não o lê).