API Reference
  1. Oway Carrier API
  2. Shipments

Confirm shipment delivery

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

Confirm that the shipment has been delivered. Transitions the order to DELIVERED status and initiates carrier payout.

Required fields: deliveryTime is required. Proof of delivery fields (signedBy, signatureImageUrl, proofOfDeliveryUrl) are optional but recommended.

State requirement: The shipment must be in ACCEPTED or PICKED_UP 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 delivery

date-time
required

Time the shipment was delivered

location
object

Location where the delivery occurred

coordinates
object

GPS coordinates of the delivery location

string
length between 0 and 255

Name of the person who signed for the delivery

string
length between 0 and 2048

URL to the signature image

string
length between 0 and 2048

URL to the proof of delivery document

string
length between 0 and 1000

Additional notes about the delivery

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?