HomeAPI Reference9. Delivery options Object Definitions

9. Delivery options Object Definitions

If you use the endpoint delivery_options you get two objects. DeliveryOptions Object and PickupOptions Object. OpeningHours Object contains the opening hours of pickup locations.

9.A DeliveryOptions Object Definition

DeliveryOptions Object contains possible delivery options. Besides these options would also be able to bring the customer has two other choices: only_recipient and signature. These two options could offer you as long as the address is in the Netherlands. Morning and Evening delivery types always use only_recipient.

9.A.1 Overview

date
Data type: date
Required: n/a.

time
Data type: DeliveryOptionTime
Required: n/a.

9.A.2 Example

{
  "date": "2017-02-01",
  "time": [
    {
      "start": "08:00:00",
      "end": "12:00:00",
      "price": {
        "currency": "EUR",
        "amount": 1000
      },
      "price_comment": "morning",
      "comment": "",
      "type": 1
    },
    {
      "start": "11:30:00",
      "end": "13:30:00",
      "price": {
        "currency": "EUR",
        "amount": 0
      },
      "price_comment": "standard",
      "comment": "",
      "type": 2
    }
  ]
}

9.B PickupOptions Object Definition

PickupOptions Object contains possible PostNL locations.

9.B.1 Overview

date
Data type: date
Required: n/a.

time
Data type: PickupOptionTime
Required: n/a.

location
Data type: string
Required: n/a.

street
Data type: string
Required: n/a.

number
Data type: string
Required: n/a.

postal_code
Data type: string
Required: n/a.

city
Data type: string
Required: n/a.

start_time
Data type: time
Required: n/a.

price
Data type: integer
Required: n/a.

price_comment
Data type: string
Required: n/a.

comment
Data type: string
Required: n/a.

phone_number
Data type: string
Required: n/a.

opening_hours
Data type: string
Required: n/a.

distance
Data type: string
Required: n/a.

latitude
Data type: coordinates
Required: n/a.

longitude
Data type: coordinates
Required: n/a.

location_code
Data type: string
Required: n/a.

9.B.2 Example

{
  "date": "2017-02-01",
  "time": [
    {
      "start": "16:00:00",
      "type": 4,
      "price": {
        "amount": 0,
        "currency": "EUR"
      }
    },
    {
      "start": "08:30:00",
      "type": 5,
      "price": {
        "amount": 125,
        "currency": "EUR"
      }
    }
  ],
  "location": "Staples Office Centre",
  "street": "Jacobus Spijkerdreef",
  "number": "10",
  "postal_code": "2132PZ",
  "city": "Hoofddorp",
  "start_time": "08:30:00",
  "price": 125,
  "price_comment": "retailexpress",
  "phone_number": "023-5576310",
  "comment": "Dit is een Business Point. Post en pakketten die u op werkdagen vóór de lichtingstijd afgeeft, bezorgen we binnen Nederland de volgende dag.",
  "opening_hours": {
    "monday": [
      "08:00-18:30"
    ],
    "tuesday": [
      "08:00-18:30"
    ],
    "wednesday": [
      "08:00-18:30"
    ],
    "thursday": [
      "08:00-18:30"
    ],
    "friday": [
      "08:00-18:30"
    ],
    "saturday": [
      "08:00-17:00"
    ],
    "sunday": [ ]
  },
  "distance": "1934",
  "latitude": "52.286582",
  "longitude": "4.682377",
  "location_code": "173187"
}

9.C OpeningHours Object Definition

9.C.1 Overview

monday
Data type: array of string
Required: n/a.

tuesday
Data type: array of string
Required: n/a.

wednesday
Data type: array of string
Required: n/a.

thursday
Data type: array of string
Required: n/a.

friday
Data type: array of string
Required: n/a.

saterday
Data type: array of string
Required: n/a.

sunday
Data type: array of string
Required: n/a.

9.C.2 Example

{
  "monday": [
    "08:00-18:30"
  ],
  "tuesday": [
    "08:00-18:30"
  ],
  "wednesday": [
    "08:00-18:30"
  ],
  "thursday": [
    "08:00-18:30"
  ],
  "friday": [
    "08:00-18:30"
  ],
  "saturday": [
    "08:00-17:00"
  ],
  "sunday": [ ]
}

9.D DeliveryOptionTime Object Definition

9.D.1 Overview

start
Data type: time
Required: n/a.

end
Data type: time
Required: n/a.

price
Data type: price
Required: n/a.

price_comment
Data type: string
Required: n/a.

comment
Data type: string
Required: n/a.

type
Data type: integer
Required: n/a.

9.D.2 Example

{
  "start": "08:00:00",
  "end": "12:00:00",
  "price": {
    "currency": "EUR",
    "amount": 1000
  },
  "price_comment": "morning",
  "comment": "",
  "type": 1
}

9.E PickupOptionTime Object Definition

9.E.1 Overview

start
Data type: time
Required: n/a.

type
Data type: integer
Required: n/a.

price
Data type: price
Required: n/a.

9.E.2 Example

{
  "start": "16:00:00",
  "type": 4,
  "price": {
    "amount": 0,
    "currency": "EUR"
  }
}
Edit this page
Last updated: 
Contributors Richard Perdaan