Orders API

Interactive API Explorer

Endpoints Overview

Draft Booking Management

• POST /v2/drafts/{orderDraftId}/book-on-interval - Book a draft on a schedule interval
• GET /v2/drafts/{orderDraftId}/booking - Get booking details for a draft
• POST /v2/drafts/{orderDraftId}/cancel-booking - Cancel booking for a draft

Order Booking Management

• POST /v2/orders/{orderId}/book-on-interval - Book an order on a schedule interval
• GET /v2/orders/{orderId}/booking - Get booking details for an order
• POST /v2/orders/{orderId}/cancel-booking - Cancel booking for an order

Document Management

• POST /v2/orders/attach-documents - Attach documents to an order or draft

Order Operations

• POST /v2/orders/cancel-orders - Cancel orders by external ID
• POST /v2/orders/replan-cancelled - Replan a cancelled order by external ID

Tracking Links

• POST /v2/orders/tracking-link - Reserve a tracking link for an order
• DELETE /v2/orders/tracking-link/{code} - Delete a tracking link reservation

Vehicle Type Management

• GET /v2/orders/vehicle-type - Get vehicle type by external ID
• PUT /v2/orders/vehicle-type - Set vehicle type for an order

Completion Proof

• GET /v2/orders/{orderId}/completion-proof - Get completion proof for an order

Driver Restrictions

• GET /v2/orders/{orderId}/prohibited-drivers - Get list of prohibited drivers for an order
• PUT /v2/orders/{orderId}/prohibited-drivers - Add a prohibited driver to an order
• DELETE /v2/orders/{orderId}/prohibited-drivers/{driverId} - Remove a prohibited driver

Authentication

Authorization: apikey YOUR_API_KEY_HERE

Base URLs

• Production: https://app.zenderatms.com/api/
• Staging: https://staging.zenderatms.com/api/

Key Data Models

Schedule Interval

Represents a bookable time slot with the following properties:

• intervalId: Unique identifier for the interval
• orderTypes: List of order types that can be booked
• fromToZones: Zone pairs for pickup and delivery
• freightLevels: Available freight levels
• pickupEarliest/Latest: Pickup time window
• deliveryEarliest/Latest: Delivery time window
• totalAvailableSlots: Maximum bookable orders
• bookedSlots: Currently booked orders

Completion Proof

Provides proof of delivery with two types:

• In-Person Proof: Includes signature, signee name, comments, and images
• Contactless Proof: Similar to in-person but for contactless deliveries

Tracking Link Reservation

• trackingLink: The full URL for tracking
• code: Unique code for the tracking link
• expirationHours: Optional expiration time for the link

Common Request Headers

Content-Type: application/json
Authorization: apikey YOUR_API_KEY_HERE

Example: Book Order on Interval

curl -X POST "https://app.zenderatms.com/api/v2/orders/123/book-on-interval" \
  -H "Authorization: apikey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "intervalId": 456
  }'

Example: Reserve Tracking Link

curl -X POST "https://app.zenderatms.com/api/v2/orders/tracking-link" \
  -H "Authorization: apikey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "ORDER_123",
    "expirationHours": 48
  }'

Example: Cancel Orders

curl -X POST "https://app.zenderatms.com/api/v2/orders/cancel-orders" \
  -H "Authorization: apikey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalIds": ["ORDER_123", "ORDER_456"]
  }'

Error Handling

The API uses standard HTTP status codes and returns error details in the response:

{
  "code": 404,
  "message": "Order not found",
  "details": []
}

Common error scenarios:

• ORDER_OR_DRAFT_NOT_FOUND: The specified order or draft doesn’t exist
• DOCUMENT_NOT_FOUND: Referenced document not found
• ORDER_NOT_FOUND: Order with given external ID not found