Address checks

View as Markdown

The check of an order’s delivery address and the decisions taken on it.

1 operation, generated from the OpenAPI file. Authentication and the base URL are described in the API overview.

GET `/api/address-checks/orders/{id}/`

Retrieve an order’s address check

Operation ID address_checks_orders_retrieve. Authentication: ApiKeyAuth.

Parameters

Name	In	Type	Required	Description
`id`	path	integer	Yes

Responses

Status	Description	Body
`200`		`AddressCheck` (`application/json`)

Example

curl "https://api.horizonlogistics.eu/api/address-checks/orders/{id}/" \
  -H "Authorization: Api-Key $HORIZON_API_KEY"

Schemas

The objects the operations above send and receive. Fields of a nested object are listed under their parent (address.city, lines[].sku); a nested named object links to its own entry.

AddressCheck

Field	Type	Required	Description
`effective`	`CheckedAddress`	Yes
`order_id`	integer	Yes
`enabled`	boolean	Yes	Address checks are switched on for the account.
`current`	boolean	Yes	The latest check is of the order’s address as it is now.
`record`	any, nullable	Yes	The latest check, or null when the address was never checked. Its `input_hash` identifies the address checked.
`summary`	`AddressCheckSummary`, nullable	Yes
`effective_source`	string (enum)	Yes	Where the address the carrier gets comes from.; `original` - original; `corrected` - corrected; `accepted` - accepted; `kept` - kept; `edited` - edited. One of: `original`, `corrected`, `accepted`, `kept`, `edited`.
`actions`	`AddressCheckActions`	Yes	The decisions available now.
`has_label`	boolean	Yes
`automation_held`	boolean	Yes	An automatic label waits for a decision on the address.

AddressCheckActions

Field	Type	Required	Description
`accept`	boolean	Yes
`keep`	boolean	Yes
`reset`	boolean	Yes
`recheck`	boolean	Yes

AddressCheckSummary

Field	Type	Required	Description
`status`	string (enum)	Yes	`valid` - valid; `corrected` - corrected; `needs_review` - needs_review; `invalid` - invalid; `unchecked` - unchecked; `confirmed` - confirmed.
`blocking`	boolean	Yes	The check holds the order’s label.
`reason_codes`	array of string	Yes
`has_suggestion`	boolean	Yes
`resolution`	string, nullable	Yes	The decision taken on the address, if any.
`checked_at`	string (date-time), nullable	Yes
`stale`	boolean	Yes	The address changed since it was checked.
`depth`	string	Yes
`shippable`	boolean	Yes

CheckedAddress

Field	Type	Required	Description
`recipient_name`	string	Yes
`company`	string	Yes
`address1`	string	Yes
`address2`	string	Yes
`city`	string	Yes
`postal_code`	string	Yes
`province_code`	string	Yes
`province_name`	string	Yes
`country`	string	Yes
`phone`	string	Yes