Upload a supporting document for an appointment

post

https://api.oway.io/v1/shipper/shipment/{orderNumber}/appointment/{stop}/document/{documentType}

Multipart upload of a supporting document for one stop on an order. Allowed content types: application/pdf, image/jpeg, image/png. Images are wrapped to single-page PDF on upload. Max size 10 MB. Replaces any existing document of the same (stop, type).

documentType must be one of: PACKING_SLIP, CUSTOMER_BOL. APPOINTMENT_DOCUMENT is system-only and returns 400 if attempted.

Mutability: writes against an order past ACCEPTED return 409 order_accepted_appointment_locked.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Document uploaded; body is the persisted document metadata.

400Bad request. Includes attempts to upload APPOINTMENT_DOCUMENT (reason: appointment_document_not_user_uploadable).

404Order does not exist or does not belong to your company.

409Order is past ACCEPTED; appointment data is locked.

413File exceeds the 10 MB upload limit.

415Unsupported content type. Allowed: application/pdf, image/jpeg, image/png.