Returns & Delivery Intelligence API
Read supplied orders, addresses, carrier events, and return rates, and calculate only the comparisons those records support.
Classify a supplied carrier code or order status only when it matches a documented token. Any other code stays unrecognized, and no tracking scan is added.
Group supplied failed, undeliverable, refused, or returned orders by postcode, address, or carrier. A pattern needs at least three orders. One failure is not a carrier finding.
Check that the supplied lines, city, postcode, and country are present, and compare a postcode with a published shape for nine country codes. The check does not confirm that a carrier can deliver.
Apply one matching caller-supplied rate to a return. A missing rate is not estimated, currencies are not converted, and the result is not a refund.
Count supplied return reasons exactly as written. A reason is a pattern only at three or more returns. The reason text is not rewritten and no refund is granted.
Subtract the supplied promise timestamp from the supplied delivery timestamp. A missing timestamp is not filled in, and the comparison is not a carrier guarantee.
Add the supplied day count to the supplied delivered or ordered date and compare a return request with that end date. No day count is assumed, and an inside date is not a refund entitlement.
Combine supplied exceptions, failed-order groups, address structure, return rates, promise variance, and the return window. The report does not contact a carrier or grant a refund.