API Reference
  1. Oway Carrier API
  2. Shipments

Request upload URL for signature or proof of delivery

post
https://api.oway.io/v1/carrier/shipments//upload

Returns a pre-signed URL for uploading a file directly to storage. Use HTTP PUT to upload the file to the returned URL with the specified content type.

Document types: SIGNATURE (signature image), PROOF_OF_DELIVERY (POD document)

Content types: image/png, image/jpeg, application/pdf

Upload flow:

  1. Call this endpoint to get a pre-signed URL
  2. PUT your file to the returned uploadUrl with Content-Type header matching contentType
  3. URL expires in 15 minutes
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 a pre-signed URL to upload a file (signature image or proof of delivery)

string
enum
required

Type of document being uploaded

Allowed:
string
enum
required

Content type of the file

Allowed:
string

Original filename

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?