Skip to content

Logistics API

The test-estate safety rule: stand the test estate up only beside a test instance, never a production deployment. Its systems are throwaway test services with published credentials: change-me is every test credential. They are still encrypted and still ask for a login, because FACE refuses a connection that is not (see Connector security). Use a scratch machine or a scratch cluster.

Grade D · dataset: API (the vendor’s response payloads) · type logisticsapi

What it is

A generic logistics REST connection: the system setting says which kind of system stands behind it. In the test estate it is a WMS feed of advance ship notices (ASNs) and their lines. The connector reference is Logistics systems of record.

Grade

D. Dataset and model: the quickstart dataset and its expected model ship. There is no vendor system to stand up for this type; load the dataset and fetch it.

See the grade table for all 32 types.

Settings and credentials

From the connection catalogue. Settings are ordinary fields on the connection record. Credentials are kept in a sealed bundle and never returned.

Names
Typelogisticsapi
Settingssystem, provider, base_url, resource, site_id, auth_mode, api_key_header, token_url, scope, page_size, max_records, lookback_minutes
Credentialsapi_key, token, password, client_secret

The test connection

WMS advance ship notices

SettingTest value
systemwms
providergeneric_rest
base_urlhttps://wms.quillmere.invalid/api
resourceasns
site_idALL
auth_modeapi_key
api_key_headerX-Api-Key
page_size100
max_records1000
lookback_minutes129600

Credentials: api_key. In the test estate, every credential is change-me. Credentials are write-only: they go into the sealed credential bundle and are never returned.

Stand up the test system

The safety rule at the top of this page comes first: a scratch machine or a scratch cluster, never a production or platform one.

  1. Download logisticsapi.zip and unzip it. It holds paginated REST responses in a generic shape, and expected.json. These types are for a customer’s own systems of record, so no vendor is imitated.
  2. There is no system to stand up from this bundle. Load the records into the system of record you want to test against, or open them next to expected.json.
  3. Add the connection in Settings › Integrations › Systems with the settings above, pointed at that system’s base URL. base_url and, for OAuth, token_url must be https://: FACE refuses http:// and a bare host.

What FACE finds

This connection is configured as system=wms, resource=asns. FACE’s registry resolves the oms, wms, whs, yms, tms and ims spellings to its logistics REST connector. A connection stored under the canonical spelling logisticsapi reaches the same connector and takes its system from the system setting; an empty system is reported as a configuration error. The expected model is the record shape.

DatasetKindDomainPrimary keyRowsFields
asnsrest_resourcereceivingasn_id245
asns.linesnested_arrayreceivingnone473

expected.json in the download has the full model: every field with its logical type, the source’s native type and nullability.

How it joins the Quillmere universe

This source carries 5 of the universe’s shared keys. The same ID means the same thing in every source: a shipment here is the same shipment in the database, the event bus, the GPS track and the claim PDF.

Universe entityFields hereAlso in
asnasns.asn_idpostgres, whs
dockasns.dock_idcctv, excel, files, kafka, postgres, sensorgateway, whs, yms
epcasns.lines.epcsrfid
shipmentasns.shipment_idbigquery, d365, databricks, document, excel, files, github, guidewire, iot, kafka, mqtt, mysql, objectstore, postgres, redshift, salesforce, sap, servicenow, sharepoint, tms, whs, yms
skuasns.lines.sku_idims, inventory, oms, postgres, sap, snowflake

Evidence it holds for the planted anomalies:

  • ANOM-6, An RFID read with no matching ASN. logisticsapi/api_asns.json in logisticsapi.zip: no ASN line carries 303400000051AEFF00000999. The absence is the evidence.

See all connectors at once for the walkthrough across every source.

Download

This is one of 25 zips: the 7 streaming types ship as replay recordings instead.

What is in the zip
  • logisticsapi/api_asns.json
  • logisticsapi/expected.json

The whole universe is universe.json. manifest.json lists every download with its size and SHA-256, and SHA256SUMS is the same list for sha256sum -c.