Changelog
Back to All

v1.018

about 15 hours ago

v1.018

License Plate Number (LPN) abstraction for Receiving. The Receiving API now speaks a generic, typed LPN vocabulary ({ type, value }, where type is currently always SSCC) alongside the existing SSCC-specific fields. Every change is additive and backward-compatible: the existing sscc and identifiers fields keep working unchanged and are now deprecated in favour of lpn / lpns. The deprecated fields will be removed in a future release once consumers have migrated.

🚀 New Endpoints

None

🛠 Schema & Property Updates

  • Create Receiving (POST /v1/integrations/receiving) — receiving line items accept a new optional lpn object (type, value). It is preferred over the deprecated sscc string and is silently ignored when carton_key or loose_units_pallet_key is set.
  • Create Receiving (POST /v1/integrations/receiving) — cartons[] and pallets[] accept a new optional lpns array (items: { type, value }), superseding identifiers. When both lpns and identifiers are supplied, lpns wins. At most one entry per type.
  • Get Receiving (GET /v1/integrations/receiving) and Receivings List (GET /v1/integrations/receivings-list) — receiving line items now also return the lpn object; cartons[] and pallets[] now also return lpns. The existing sscc and identifiers fields continue to be returned with identical data.
  • The reusable identifier object schema was renamed from PublicApiReceivingPackagingIdentifierOutput to PublicApiLpnOutput. The object shape is unchanged (type, value).

📖 Documentation & Constraints Changes

  • Create Receiving — the lpn request property documents that it is preferred over the deprecated sscc, and cartons[].lpns / pallets[].lpns document the "at most one per type" rule. The deprecated sscc and identifiers descriptions now point callers to lpn / lpns.

⚠️ Deprecated

  • Receiving line sscc (request and response) — use lpn ({ type, value } with type=SSCC) instead. Still fully supported; scheduled for removal after consumers migrate.
  • cartons[].identifiers / pallets[].identifiers (request and response) — use cartons[].lpns / pallets[].lpns instead. Identical data and behaviour; still fully supported and scheduled for removal after consumers migrate.

No endpoints, fields, types, or required-status were removed or changed — fully backward-compatible.