SHshipoway
Shipper API

Cancel a shipment by order number

Cancels an existing shipment using its order number (PRO number). Shipments can only be cancelled when they are in a cancellable state (e.g., before pickup).

put/v1/shipper/shipment/{orderNumber}/cancel

Request

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

Path parameters

orderNumberstring required

Order number (5-character alphanumeric code, commonly called PRO number)

Response

Shipment cancelled successfully

idstring

Unique identifier for the order

companyIdstring

Company ID that owns this order

userIdstring

User ID who created this order

orderNumberstring

Human-readable PRO number for the shipment (5-character alphanumeric)

orderStatus'INITIALIZED' | 'CONFIRMED' | 'ACCEPTED' | 'ASSIGNED' | 'PICKED_UP' | 'IN_TRANSIT' | 'DELIVERED' | 'CANCELLED' | 'REJECTED'

Current status of the order

totalPriceInCentsinteger

Total price of the order in cents (USD)

createdAtstring date-time

Time when the order was created (ISO 8601 format)

updatedAtstring date-time

Time when the order was last updated (ISO 8601 format)

Example response

{
  "id": "67b6c5fcfbf1be6b24127646",
  "companyId": "67c0dfa95bff090747660465",
  "userId": "679410f5b074882a64b9ea7f",
  "orderNumber": "ZKYQ5",
  "orderStatus": "CONFIRMED",
  "totalPriceInCents": 125000,
  "createdAt": "2025-02-20T17:31:10.430Z",
  "updatedAt": "2025-02-27T22:51:49.865Z"
}

Changes

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