Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Pickup requests

List all pickup requests

Returns a list of pickup requests.

get/pickup_requests

Query parameters

idinteger

ID for the pickup request to be included in the filter

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

Carrier code to be included in the filter.

per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

Response

Successful.

idinteger

ID of the pickup request

carrier_codestring

Carrier code for the carrier the pickup is requested for.

confirmation_numberstring

Reference number for the pickup request. This should used as reference if contacting the carrier about the pickup.

status'unconfirmed' | 'confirmed' | 'error' | 'cancelled'

Current status of the pickup request.

datestring date

Requested pickup date.

ready_bystring date-time

Requested pickup from this time. Ignore the date part of the date-time.

closed_bystring date-time

Requested pickup before this time. Ignore the date part of the date-time.

package_locationstring

Where on the address the packages should be picked up.

number_of_piecesinteger

Number of pieces that should be picked up.

weightstring

Total weight of all shipments in the pickup request.

is_residentialboolean

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

Example response

[
  {
    "id": 15242,
    "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"
    },
    "confirmation_number": "123C21B215M",
    "status": "confirmed",
    "date": "2019-02-13",
    "ready_by": "2000-01-01T08:00:00.000Z",
    "closed_by": "2000-01-01T15:00:00.000Z",
    "package_location": "At the front door.",
    "number_of_pieces": 3,
    "weight": "47000"
  }
]