Estimated delivery date responses

The estimated delivery dates API possible responses:

Status	Meaning	Description
200	OK	Successful delivery estimate response
400	Bad Request	The request is malformed or required parameters are missing
403	Forbidden	The API key given does not match a valid merchant account
500	Internal Server Error	An unknown error occurred, or there is a problem with the input parameters

Examples

Example responses:

Successful delivery estimate response

[
  {
    "service_level": "standard",
    "estimated_delivery_days": 4
  },
  {
    "service_level": "express",
    "estimated_delivery_days": 3
  },
  {
    "service_level": "priority",
    "estimated_delivery_days": 2
  },
  {
    "service_level": "on_demand",
    "estimated_delivery_days": 1
  }
]

Filtered service levels response

When specific service levels are requested:

[
  {
    "service_level": "standard",
    "estimated_delivery_days": 5
  },
  {
    "service_level": "express",
    "estimated_delivery_days": 2
  }
]

Limited availability response

When only certain service levels are available for the route:

[
  {
    "service_level": "standard",
    "estimated_delivery_days": 6
  }
]

Failed delivery estimate responses

422 response for missing required parameters:

{
  "error": "Invalid request",
  "details": [
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "undefined",
      "path": ["to_postcode"],
      "message": "Required"
    }
  ]
}