SHshipoway
Carrier API

Accept a bundle

Changed on

Accept a bundle of offers. You can optionally exclude specific offers from the bundle using offerIdsToExclude.

Carrier tracking data (reference number, driver info) provided in the request body is applied to all accepted offers in the bundle.

State requirement: The bundle must be in OPEN status.

put/v1/carrier/bundles/{bundleId}/accept

Request

  • Base URL
    https://api.oway.io
  • URL
    https://api.oway.io/v1/carrier/bundles/{bundleId}/accept
  • Auth
    HTTP bearer and API key in header x-oway-api-key

Path parameters

bundleIdstring required

Bundle ID

Request body

offer_ids_to_excludestring[]

List of offer IDs to exclude from the bundle acceptance

carrier_referencestring

Carrier's internal reference number for this bundle

driver_namestring

Name of the assigned driver

driver_phonestring

Phone number of the assigned driver

vehicle_idstring

Identifier of the vehicle assigned to this bundle

Example request

{
  "offer_ids_to_exclude": [
    "507f1f77bcf86cd799439011"
  ],
  "carrier_reference": "CARRIER-BATCH-001",
  "driver_name": "John Smith",
  "driver_phone": "+1-555-0100",
  "vehicle_id": "TRUCK-42"
}

Response

Bundle accepted successfully

idstring

Unique bundle identifier

status'OPEN' | 'EXPIRED' | 'DECLINED' | 'SUBSET_ACCEPTED' | 'ACCEPTED'

Current bundle status

created_atstring date-time

When this bundle was created

updated_atstring date-time

When this bundle was last updated

Example response

{
  "id": "507f1f77bcf86cd799439012",
  "offers": [
    {
      "id": "507f1f77bcf86cd799439012",
      "carrier_reference": "CARRIER-TRK-789",
      "order": {
        "order_number": "Y73Q0",
        "order_status": "CONFIRMED",
        "description": "Electronics - 2 pallets shrink-wrapped",
        "total_pallet_count": 2,
        "total_pounds_weight": 1200,
        "po_number": "PO-2026-4521",
        "ref_number": "REF-8834",
        "components": [
          {
            "pallet_count": 1,
            "pounds_weight": 600,
            "pallet_dimensions": [
              48,
              40,
              60
            ],
            "freight_class": "70"
          }
        ],
        "created_at": "2026-01-15T08:00:00Z",
        "updated_at": "2026-01-15T10:30:00Z"
      },
      "pickup": {
        "name": "Fairgrounds Distribution Center",
        "address1": "1531 Junipero Avenue",
        "address2": "Dock 5",
        "city": "Long Beach",
        "state": "CA",
        "zip_code": "90804",
        "country": "US",
        "phone_number": "+18087857650",
        "contact_person": "Mike Johnson",
        "open_time": "10:00",
        "close_time": "16:00",
        "notes": "Dock 3, enter from back of building",
        "appointment_required": true
      },
      "delivery": {
        "name": "Fairgrounds Distribution Center",
        "address1": "1531 Junipero Avenue",
        "address2": "Dock 5",
        "city": "Long Beach",
        "state": "CA",
        "zip_code": "90804",
        "country": "US",
        "phone_number": "+18087857650",
        "contact_person": "Mike Johnson",
        "open_time": "10:00",
        "close_time": "16:00",
        "notes": "Dock 3, enter from back of building",
        "appointment_required": true
      },
      "tracking": {
        "order_number": "ZKYQ5",
        "order_status": "PICKED_UP",
        "actual_pickup_date": "2024-12-23T10:30:00Z",
        "actual_delivery_date": "2024-12-25T14:00:00Z",
        "estimated_pickup_date": "2024-12-23T09:00:00Z",
        "estimated_delivery_date": "2024-12-25T12:00:00Z"
      },
      "payout": {
        "total_in_cents": 125000
      },
      "currency": "USD",
      "assigned_driver": {
        "name": "John Smith",
        "phone": "+15551234567",
        "vehicle_id": "TRUCK-42"
      },
      "pickup_confirmation": {
        "pickup_time": "2026-01-15T10:30:00Z",
        "address": "123 Main St, San Francisco, CA 94102",
        "latitude": 37.7749,
        "longitude": -122.4194,
        "driver_name": "John Smith",
        "signed_by": "Jane Doe",
        "notes": "Picked up from dock 3",
        "recorded_at": "2026-01-15T10:35:00Z"
      },
      "delivery_confirmation": {
        "delivery_time": "2026-01-15T14:30:00Z",
        "address": "456 Market St, Oakland, CA 94607",
        "latitude": 37.7749,
        "longitude": -122.4194,
        "signed_by": "Recipient Name",
        "signature_image_url": "https://storage.oway.io/signatures/sig-12345.png",
        "proof_of_delivery_url": "https://storage.oway.io/pod/pod-12345.pdf",
        "notes": "Delivered to front desk",
        "recorded_at": "2026-01-15T14:35:00Z"
      },
      "pickup_pin": "1234",
      "delivery_pin": "5678",
      "deadline": "2026-01-15T12:00:00Z",
      "created_at": "2026-01-15T08:00:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "created_at": "2026-01-15T08:00:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Changes