Get Deliveries by ExternalId

GET 
https://api.goodsdelivery.io/v1/deliveries/externalId/:externalId

Authorization: x-api-key

name: x-api-keytype: apiKeyscopes: brandin: header

Get Deliveries by ExternalId

Request

Path Parameters

externalId stringrequired

external Id.

Responses

200

Object with list of deliveries

application/json

Schema

Schema

pagesCount numberrequired
page numberrequired
objectsCount numberrequired
objects object[]required
Array [
jobDetails objectrequired
id stringrequired
shortId stringrequired
externalId stringrequired
brandId stringrequired
brandName stringrequired
brandLogoUrl stringrequired
consumer objectrequired
firstName stringrequired
lastName stringrequired
phone phone
Phone is required when email is not provided
email email
Email is required when phone is not provided
pickUp objectrequired
name string
Company name
address1 stringrequired
address2 string
city stringrequired
zipCode stringrequired
state stringrequired
2 letter state code - ISO 3166-2
country stringrequired
2 letter country code - ISO 3166-2
note string
Address note - how to get there, etc.
coordinates object
lat numberrequired
lng numberrequired
dropOff objectrequired
name string
Company name
address1 stringrequired
address2 string
city stringrequired
zipCode stringrequired
state stringrequired
2 letter state code - ISO 3166-2
country stringrequired
2 letter country code - ISO 3166-2
note string
Address note - how to get there, etc.
coordinates object
lat numberrequired
lng numberrequired
serviceType ServiceTyperequired
Possible values: [SAME_DAY, NEXT_DAY, SCHEDULED]
Determine the delivery date, including pick-up and drop-off times.
contactlessPreferred boolean
addons Addon[]
Possible values: [EXTRA_INSURANCE, SIGNATURE_REQUIRED, WITHOUT_LABEL]
Add-ons for the delivery service
packagesTotalValueUsd number
packages object[]
Array [
volumeFt3 number
Volume of the package in cubic foot (ft3), if known
weightLbs number
Package weight in pounds (lbs), if known.
lengthIn number
Length of the pack in inches, if known.
widthIn number
Width of the pack in inches, if known.
heightIn number
Height of the pack in inches, if known.
]
savedCo2Kg number
Estimated amount of CO2 the delivery will save the environment
createdAt string
updatedAt string
deliveryDetails objectrequired
pickUpTimeSlot objectrequired
earliest stringrequired
latest stringrequired
dropOffTimeSlot objectrequired
earliest stringrequired
latest stringrequired
courier object
name string
phone string
photo string
vehicleType string
vehicleImage string
realTimeCoordinates object
lat numberrequired
lng numberrequired
status objectrequired
currentStatus stringrequired
eta date-time
Future date string with estimated time of arrival
trackingUrl stringrequired
totalStops number
stopNumber number
courierAtStop number
historyDetails objectrequired
earlierStatuses object[]
Array [
status stringrequired
changedAt date-timerequired
courierName string
courierPhotoUrl string
]
failedAttempts number
completionDetails object
completionTime date-timerequired
proofOfDelivery objectrequired
photoUrls string[]
signatureUrl string
coordinatesAtCompletion objectrequired
lat numberrequired
lng numberrequired
completionNote string
feedback string
rating number
]

Example (from schema)

{
  "pagesCount": 0,
  "page": 0,
  "objectsCount": 0,
  "objects": [
    {
      "jobDetails": {
        "id": "string",
        "shortId": "string",
        "externalId": "string",
        "brandId": "string",
        "brandName": "string",
        "brandLogoUrl": "string",
        "consumer": {
          "firstName": "string",
          "lastName": "string",
          "phone": "string",
          "email": "user@example.com"
        },
        "pickUp": {
          "name": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "zipCode": "string",
          "state": "string",
          "country": "string",
          "note": "string",
          "coordinates": {
            "lat": 0,
            "lng": 0
          }
        },
        "dropOff": {
          "name": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "zipCode": "string",
          "state": "string",
          "country": "string",
          "note": "string",
          "coordinates": {
            "lat": 0,
            "lng": 0
          }
        },
        "serviceType": "SAME_DAY",
        "contactlessPreferred": true,
        "addons": [
          "EXTRA_INSURANCE"
        ],
        "packagesTotalValueUsd": 0,
        "packages": [
          {
            "volumeFt3": 0,
            "weightLbs": 0,
            "lengthIn": 0,
            "widthIn": 0,
            "heightIn": 0
          }
        ],
        "savedCo2Kg": 0,
        "createdAt": "string",
        "updatedAt": "string"
      },
      "deliveryDetails": {
        "pickUpTimeSlot": {
          "earliest": "string",
          "latest": "string"
        },
        "dropOffTimeSlot": {
          "earliest": "string",
          "latest": "string"
        },
        "courier": {
          "name": "string",
          "phone": "string",
          "photo": "string",
          "vehicleType": "string",
          "vehicleImage": "string",
          "realTimeCoordinates": {
            "lat": 0,
            "lng": 0
          }
        },
        "status": {
          "currentStatus": "string",
          "eta": "2024-06-06T14:00:40.045Z",
          "trackingUrl": "string",
          "totalStops": 0,
          "stopNumber": 0,
          "courierAtStop": 0
        }
      },
      "historyDetails": {
        "earlierStatuses": [
          {
            "status": "string",
            "changedAt": "2024-06-06T14:00:40.045Z",
            "courierName": "string",
            "courierPhotoUrl": "string"
          }
        ],
        "failedAttempts": 0
      },
      "completionDetails": {
        "completionTime": "2024-06-06T14:00:40.045Z",
        "proofOfDelivery": {
          "photoUrls": [
            "string"
          ],
          "signatureUrl": "string"
        },
        "coordinatesAtCompletion": {
          "lat": 0,
          "lng": 0
        },
        "completionNote": "string",
        "feedback": "string",
        "rating": 0
      }
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.goodsdelivery.io/v1/deliveries/externalId/:externalId' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.goodsdelivery.io/v1

Auth

Security Scheme

APIKeyHeaderAuthorizationHeader

APIKeyHeader

Parameters

externalId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!