API Reference
  1. Oway Carrier API
  2. Shipments

Confirm shipment pickup

put
https://api.oway.io/v1/carrier/shipments//pickup

Confirm that the shipment has been picked up. Transitions the order to IN_TRANSIT status.

Required fields: pickupTime is required. All other fields (location, coordinates, signedBy, notes) are optional but recommended.

State requirement: The shipment must be in ACCEPTED status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Shipment identifier (offerId, orderNumber, or carrierReference)

Body Params

Request body for confirming shipment pickup

date-time
required

Time the shipment was picked up

location
object

Location where the pickup occurred

coordinates
object

GPS coordinates of the pickup location

string
length between 0 and 255

Name of the driver who performed the pickup

string
length between 0 and 255

Name of the person who signed at pickup

string
length between 0 and 1000

Additional notes about the pickup

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?