SHshipoway
Shipper API

Read generated appointment PDF

Returns the generated appointment PDF snapshot for one stop. The PDF is built at carrier acceptance (cover sheet + merged supporting documents) and re-generated on subsequent shipper-driven updates. Returns 404 before generation has occurred.

get/v1/shipper/shipment/{orderNumber}/appointment/{stop}/pdf

Request

  • Base URL
    https://api.oway.io
  • URL
    https://api.oway.io/v1/shipper/shipment/{orderNumber}/appointment/{stop}/pdf
  • Auth
    HTTP bearer and API key in header x-oway-api-key

Path parameters

orderNumberstring required
stop'PICKUP' | 'DELIVERY' required

Response

Returns the application/pdf bytes for this stop.

Changes

No recorded changes to this operation across all 1 revision of this API.