Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Pickup requests

Create a pickup request

Creates a pickup request and processes the booking at the carrier.

post/pickup_requests

Request body

carrier_code'fed_ex' | 'ups' | 'dhl_express' | 'geodis' | 'dhl_freight_se' | 'post_nord' | 'bring' required

Carrier code for the carrier the pickup should be requested for.

package_locationstring required

Where on the address the packages should be picked up.

ready_bystring date-time required

When shipments are ready for pickup. Pickup date is taken from the date given here.

closed_bystring date-time required

When shipments should be picked up by. The date part is ignored.

shipment_idsinteger[] required

IDs of the shipments you wish to be picked up.

is_residentialboolean

Only used for UPS. Whether the pickup address is residential or not.

Example request

{
  "carrier_code": "ups",
  "pickup_address": {
    "company_name": "Min Virksomhed ApS",
    "address1": "Strandvejen 6B",
    "zipcode": "5240",
    "city": "Odense NØ",
    "country_code": "DK",
    "contact_name": "Hans Hansen",
    "contact_phone": "70400407"
  },
  "package_location": "At the front door",
  "ready_by": "2019-02-14T08:00:00.000Z",
  "closed_by": "2019-02-14T15:00:00.000Z",
  "shipment_ids": [
    12515122
  ]
}

Response

Successful.