Shipper API

Read merged appointment requirement for a stop

Returns the effective AppointmentRequirement for one stop, computed as the merge of the place-level default and the order-level override using a "more-strict wins" rule. The _merged diagnostic block in the response shows per-field provenance (PLACE | ORDER | PLACE_AND_ORDER | NONE).

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

Request

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

Path parameters

orderNumberstring required

Order number (PRO)

stop'PICKUP' | 'DELIVERY' required

pickup | delivery

Response

Merged appointment requirement. Fields are null when neither place nor order has data for that field; _merged is always present and shows source of each field.

channel'PHONE' | 'EMAIL' | 'PORTAL'

Channel for booking the appointment

portalUrlstring

Portal URL when channel is PORTAL

instructionsstring

Free-text instructions

referenceNumbersstring[]

Reference numbers

leadTimeHoursinteger

Minimum advance notice in hours

appointmentRequiredboolean

Whether the merged effective appointmentRequired is true (OR of place-level and order-level booleans).

Example response

{
  "contacts": [
    {
      "name": "Maria Lopez",
      "email": "maria@aqua.com",
      "phone": "+15555550101",
      "role": "Warehouse Manager"
    }
  ]
}

Changes

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