CompuDime API docs

Reference / Schemas

DeliveryRoute

One delivery route of the store with two counts. Counts only: never a list of the customers or the invoices behind them.

Type: object.

NameTypeDescription
customersintegerCustomers assigned to the route. The register's anonymous walk-in and remote-customer placeholder accounts are never counted. At least 0.
openInvoicesintegerHow many open invoices the route carries, exactly as the store's POS agent counts them; the API does not recompute it. The rule today: an invoice is open when its due date is today or later (the store's calendar) and the POS has recorded no delivery-done time for it; the POS status is not consulted. A pickup order never receives a delivery-done time, so it counts as open until its due date has passed. CompuDime is reviewing this rule and may refine it at the store agent; the field, its type and its meaning (open invoices on the route) stay as published. Absent, never 0, when the store's POS cannot answer the rule. At least 0.
routestringThe route as the store spells it; two spellings that differ only in case are one route.

No other fields appear.