Kind
There are multiple kinds of expected deliveries available in Shipup.
| Type | Description |
|---|---|
merchant | The expected delivery set when uploading tracker data (via API or FTP) |
carrier | The expected delivery as provided by the carrier |
promise | The expected delivery computed using the promise settings configured in Shipup for the specified carrier service |
sde_live | The expected delivery computed by our SDE algorithm, taking into account the current status and events of the parcel |
You can configure which one you want displayed inside the Shipup settings, using a fallback system if one isn't available.
In the API, the fields prefixed by displayable_expected_delivery will always relate to the highest priority set, you can see which one it corresponds to using displayable_expected_delivery_kind
Exact date vs window
Expected delivery can come in two ways:
- Exact date: the date provided is a single date, or a date with a time by which it should be delivered.
promiseandsde_livewill always have an exact date. - Window: a range during which the parcel should be delivered. It can be a date range, or a time range within a single day (in case of scheduled delivery for instance).
carrier expected deliveries can be either exact dates or windows depending on the data provided by the carrier itself.
merchant expected deliveries will be an exact date or a window depending on the data provided by the merchant.
Retrieving expected delivery
In the API, the fields available are the following:
| Field name | Description |
|---|---|
displayable_expected_delivery_date | The date (without time) of the expected delivery. In case of window, will return the end of the window |
displayable_expected_delivery_datetime | The date with time of the expected delivery. In case of window, will return the end of the window. Might be null |
displayable_expected_delivery_start_date | The date of the beginning of the window. If no window then will be null |
displayable_expected_delivery_start_datetime | The date with time of the beginning of the window. If no window or no time available then will be null |
displayable_expected_delivery_end_date | The date of end the the window or of the exact date. |
displayable_expected_delivery_end_datetime | The date with time of end the the window or of the exact date. Might be null |
Examples
| Situation | Fields available |
|---|---|
| Exact date | displayable_expected_delivery_date and displayable_expected_delivery_end_date |
| Exact date with time | displayable_expected_delivery_date, displayable_expected_delivery_datetime, displayable_expected_delivery_end_date, displayable_expected_delivery_end_datetime |
| Date range | displayable_expected_delivery_date, displayable_expected_delivery_start_date, displayable_expected_delivery_end_date |
| Day window | All fields |