RunBuggy

RunBuggy Orders API

The Order operations.

GitHub OpenAPI

Operations 10

POST /orders Create an order #
GET /orders Find orders #
GET /orders/{id} Retrieve an order #
PATCH /orders/{id} Update order #
POST /orders/{id}/cancel Cancel an order #
POST /orders/{id}/replace Replace an order #
GET /orders/{id}/full Retrieve an expanded order #
GET /orders/full Search expanded orders #
GET /orders/{id}/vehicle-transfer-orders List order's vehicle transfers #
POST /orders/quote Quote an order #

Documentation

📖
Documentation
https://docs.runbuggy.com/docs/shipping/1b7acf7f4d493-orders
📖
Documentation
https://docs.runbuggy.com/docs/shipping/78a3e6d30650c-companies
📖
Documentation
https://docs.runbuggy.com/docs/shipping/b6b6c2d4906e9-authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/runbuggy/refs/heads/main/openapi/runbuggy-orders-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/runbuggy-orders-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

runbuggy-orders-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Orders API
  description: '### [Create Orders](/docs/shipping/6fcc8c040ec03-create-an-order) to transfer vehicles.'
  termsOfService: https://runbuggy.com/terms/
  contact:
    name: Support
    email: support@runbuggy.com
  license:
    name: Copyright © RunBuggy 2023
    url: https://runbuggy.com/terms/
  version: '1.0'
servers:
- url: https://ng-staging.runbuggy.com/staging/api
tags:
- name: Orders
  description: The Order operations.
paths:
  /orders:
    post:
      tags:
      - Orders
      summary: Create an order
      description: Create an Order to transfer vehicles.
      operationId: createOrderUsingPOST
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
        '202':
          description: The request is being processed. See [Handling 202's](/docs/shipping/ea2a0d46dfc8d-handling-202-s).
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
        description: orderRequest
        required: true
    get:
      tags:
      - Orders
      summary: Find orders
      description: Retrieve paginated Orders.
      operationId: findOrderPaginatedUsingGET
      parameters:
      - name: size
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
  /orders/{id}:
    get:
      tags:
      - Orders
      summary: Retrieve an order
      description: Retrieve Order.
      operationId: getOrderUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
    patch:
      tags:
      - Orders
      summary: Update order
      description: Patch Order
      operationId: patchOrderUsingPATCH
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderPatchRequest'
        description: request
        required: true
  /orders/{id}/cancel:
    post:
      tags:
      - Orders
      summary: Cancel an order
      description: Cancel specified Order. If vehicles have shipped you may no longer cancel Order. 202 status code indicates the Cancelation request has been accepted and is processing. Check the Order resource for the status to change to "CANCELED".
      operationId: cancelOrderUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Request has been accepted and is being processed.
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancellationReason'
        description: cancellationReason
        required: true
  /orders/{id}/replace:
    post:
      tags:
      - Orders
      summary: Replace an order
      description: Cancels the original and creates a new one. To track the status, see the Order.replacement property of the order being replaced.
      operationId: replaceOrderUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
        description: replaceRequest
        required: true
  /orders/{id}/full:
    get:
      tags:
      - Orders
      summary: Retrieve an expanded order
      description: Retrieve an Order expanded with full Vehicle Transfer Orders.
      operationId: getFullOrderWithIdUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderFull'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
  /orders/full:
    get:
      tags:
      - Orders
      summary: Search expanded orders
      description: 'Search expanded orders using RSQL. For example: orders/full?query=created.date>2020-10-15T00:00:00Z;created.date<2020-10-21T00:00:00Z'
      operationId: getPaginatedFullOrdersUsingGET
      parameters:
      - name: query
        in: query
        description: Query Orders using RSQL.
        required: false
        schema:
          type: string
      - name: size
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageOrderFull'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
  /orders/{id}/vehicle-transfer-orders:
    get:
      tags:
      - Orders
      summary: List order's vehicle transfers
      description: List an Order's the Vehicle Transfer Orders.
      operationId: getOrderVehicleTransferOrdersUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VehicleTransferOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
  /orders/quote:
    post:
      tags:
      - Orders
      summary: Quote an order
      description: Quote an Order.
      operationId: quoteOrderUsingPOST
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderQuoteResponse'
        '202':
          description: The request is being processed. See [Handling 202's](/docs/shipping/ea2a0d46dfc8d-handling-202-s).
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      deprecated: false
      security:
      - Authorization: []
      servers:
      - url: https://ng-staging.runbuggy.com/staging/api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderQuoteRequest'
        description: orderQuoteRequest
        required: true
components:
  schemas:
    VehicleMeasurements:
      type: object
      title: VehicleMeasurements
      properties:
        curbWeight:
          type: number
          format: double
        grossVehicleWeightRating:
          type: number
          format: double
        height:
          type: number
          format: double
        length:
          type: number
          format: double
        width:
          type: number
          format: double
    DetailedDirectionsRequest:
      type: object
      title: DetailedDirectionsRequest
      properties:
        dropoff:
          $ref: '#/components/schemas/VehicleTransferOrderRequestLocation'
        pickup:
          $ref: '#/components/schemas/VehicleTransferOrderRequestLocation'
      required:
      - dropoff
      - pickup
    Replacement:
      type: object
      title: Replacement
      properties:
        created:
          $ref: '#/components/schemas/Created'
        message:
          type: string
        orderId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - SUCCESS
          - ERROR
    FareItem:
      type: object
      title: FareItem
      description: Order Fare Item
      properties:
        name:
          type: string
        description:
          type: string
        value:
          type: number
          format: double
    FareOptionsRequest:
      type: object
      title: FareOptionsRequest
      properties:
        name:
          type: string
          description: The name of the Fare option. The fare options are returned from the Quote operation.
          x-examples:
          - Gold
        options:
          type: array
          description: Fare options. We currently support "Enclosed" (case sensitive)
          items:
            type: string
      required:
      - name
    PageOrder:
      type: object
      title: PageOrder
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/Order'
        empty:
          type: boolean
        first:
          type: boolean
        last:
          type: boolean
        number:
          type: integer
          format: int32
        numberOfElements:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/Pageable'
        size:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/Sort'
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
      required:
      - content
      - empty
      - first
      - last
      - number
      - numberOfElements
      - pageable
      - size
      - sort
      - totalElements
      - totalPages
    Canceled:
      type: object
      title: Canceled
      properties:
        byUser:
          type: string
        date:
          type: string
          description: Datetime in ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
        reason:
          type: string
    Company:
      type: object
      title: Company
      properties:
        id:
          type: string
          x-examples:
          - c0ef80ce-2579-4682-af4f-c1d29457848a
        name:
          type: string
          x-examples:
          - Auto Land
        type:
          type: string
          enum:
          - DEALER
          - AUCTION
          x-examples:
          - DEALER
    InspectionSummary:
      type: object
      title: InspectionSummary
      properties:
        completed:
          $ref: '#/components/schemas/Created'
        created:
          $ref: '#/components/schemas/Created'
        id:
          type: string
        taskName:
          type: string
    OrderQuoteRequest:
      type: object
      title: OrderQuoteRequest
      properties:
        type:
          type: string
          enum:
          - BASIC
          description: See Order.type enumeration for possible values.
        vehicleTransferOrders:
          type: array
          items:
            $ref: '#/components/schemas/VehicleTransferOrderQuoteRequest'
      required:
      - type
      - vehicleTransferOrders
    AdditionalData:
      type: object
      title: AdditionalData
      properties:
        activity:
          $ref: '#/components/schemas/Activity'
        battery:
          $ref: '#/components/schemas/Battery'
        coords:
          $ref: '#/components/schemas/Coords'
        extras:
          $ref: '#/components/schemas/Extras'
        is_moving:
          type: boolean
        odometer:
          type: integer
          format: int32
        timestamp:
          type: string
          format: date-time
        uuid:
          type: string
    VehicleTransferOrderStatus:
      type: object
      title: VehicleTransferOrderStatus
      properties:
        error:
          type: string
          x-examples:
          - Error 123
        id:
          type: string
          x-examples:
          - 7e837a6c-1746-4da4-89e6-c87fae7df84d
      required:
      - id
    OrderResponse:
      type: object
      title: OrderResponse
      properties:
        id:
          type: string
          x-examples:
          - 7e837a6c-1746-4da4-89e6-c87fae7df84d
        created:
          $ref: '#/components/schemas/Created'
        notes:
          type: string
        referenceNumber:
          type: string
          x-examples:
          - '200001'
        status:
          type: string
        type:
          type: string
          enum:
          - BASIC
          - SWAP
          x-examples:
          - BASIC
        vehicleTransferOrders:
          type: array
          items:
            $ref: '#/components/schemas/VehicleTransferOrderStatus'
      required:
      - id
      - created
      - status
      - type
      - vehicleTransferOrders
    CompanyRequestRequiredName:
      type: object
      title: Company
      properties:
        id:
          type: string
          x-examples:
          - c0ef80ce-2579-4682-af4f-c1d29457848a
        name:
          type: string
          x-examples:
          - Auto Land
        type:
          type: string
          enum:
          - DEALER
          - AUCTION
          x-examples:
          - DEALER
      required:
      - id
      - name
    EstimatedTimeToArrival:
      type: object
      title: EstimatedTimeToArrival
      properties:
        start:
          type: string
          description: Start of ETA window of time. ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
        end:
          type: string
          description: End of ETA window of time. Datetime in ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
        initial:
          type: string
          description: Datetime in ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
        accuracy:
          type: string
        calculated:
          type: string
          format: date-time
        status:
          type: string
    OrderFull:
      type: object
      title: OrderFull
      properties:
        id:
          type: string
        referenceNumber:
          type: string
        completedDate:
          type: string
          format: date-time
        created:
          $ref: '#/components/schemas/Created'
        owner:
          $ref: '#/components/schemas/Company'
        payer:
          $ref: '#/components/schemas/Company'
        canceled:
          $ref: '#/components/schemas/Canceled'
        dedicatedTransporter:
          $ref: '#/components/schemas/Company'
        driverLocations:
          type: array
          items:
            $ref: '#/components/schemas/LastDriverLocation'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        fare:
          type: array
          items:
            $ref: '#/components/schemas/FareItem'
        labels:
          type: object
          additionalProperties:
            type: string
        notes:
          type: string
        preferredStatusExpiration:
          type: string
        preferredTransporters:
          type: array
          items:
            $ref: '#/components/schemas/Company'
        replacement:
          $ref: '#/components/schemas/Replacement'
        status:
          type: string
        transportationOrders:
          type: array
          items:
            $ref: '#/components/schemas/TransportationOrder'
        type:
          type: string
          enum:
          - BASIC
        vehicleTransferOrders:
          type: array
          items:
            $ref: '#/components/schemas/VehicleTransferOrder'
    Item:
      type: object
      title: Item
      properties:
        amount:
          type: number
          format: double
        name:
          type: string
    Event:
      type: object
      title: Event
      properties:
        dateTime:
          type: string
          description: Datetime in ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
        name:
          type: string
    Contact:
      type: object
      title: Contact
      properties:
        name:
          type: string
          x-examples:
          - Ed Jones
        phone:
          type: string
          x-examples:
          - '4804804480'
    VehicleTransferOrder:
      type: object
      title: VehicleTransferOrder
      description: A Vehicle Transfer Order.
      properties:
        id:
          type: string
          x-examples:
          - 7a765a49-6b21-4368-937e-8ce4981d8eff
        referenceNumber:
          type: string
          x-examples:
          - 2000232-123432
        created:
          $ref: '#/components/schemas/Created'
        vehicle:
          $ref: '#/components/schemas/Vehicle'
        directions:
          $ref: '#/components/schemas/DetailedDirections'
        fare:
          $ref: '#/components/schemas/Fare'
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        notes:
          type: string
          x-examples:
          - Notes about this vehicle transfer.
        orderId:
          type: string
          x-examples:
          - ABC123-LMNOP
        payer:
          $ref: '#/components/schemas/Company'
        reconciliationCode:
          type: string
          x-examples:
          - RBCON2020
        states:
          $ref: '#/components/schemas/States'
        status:
          type: string
          enum:
          - DRAFT
          - READY
          - AVAILABLE
          - CLAIMED
          - UNCLAIMED
          - APPROVED
          - ASSIGNED
          - REJECTED
          - ACCEPTED
          - DRIVER_ARRIVED
          - PICKED_UP
          - SIGNATURE_ON_PICKUP
          - PROVIDED_ETA_DROPOFF
          - UNLOADED
          - DELIVERED
          - CANCELED
          - COMPLETE
          - ERROR
          description: See the Vehicle Transfer Order Statuses guide for detailed information.
        timeline:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        transporter:
          $ref: '#/components/schemas/Company'
        dedicatedTransporter:
          $ref: '#/components/schemas/Company'
        canceled:
          $ref: '#/components/schemas/Canceled'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        labels:
          type: array
          items:
            type: object
        canCancel:
          type: boolean
        inspections:
          type: array
          items:
            $ref: '#/components/schemas/InspectionSummary'
        preferredTransporters:
          type: array
          items:
            $ref: '#/components/schemas/Company'
      required:
      - id
      - referenceNumber
      - created
      - vehicle
      - directions
      - fare
      - orderId
      - status
    TransportationOrder:
      type: object
      title: TransportationOrderExt
      properties:
        id:
          type: string
        referenceNumber:
          type: string
        created:
          $ref: '#/components/schemas/Created'
        canceled:
          $ref: '#/components/schemas/Canceled'
        directions:
          type: array
          items:
            $ref: '#/components/schemas/Direction'
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        status:
          type: string
        transporter:
          $ref: '#/components/schemas/Company'
        type:
          type: string
          enum:
          - BASIC
        vehicleTransferOrders:
          type: array
          items:
            $ref: '#/components/schemas/VehicleTransferOrderIds'
    Created:
      type: object
      title: Created
      properties:
        byCompany:
          $ref: '#/components/schemas/Company'
        byUser:
          type: string
          description: User ID
          x-examples:
          - 7ae99113-09fd-4838-917a-a7d9636c2f8c
        byUserFullName:
          type: string
        date:
          type: string
          description: Datetime in ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
    Direction:
      type: object
      title: Direction
      properties:
        distance:
          $ref: '#/components/schemas/Distance'
        dropOff:
          $ref: '#/components/schemas/Location'
        dropOffPickup:
          $ref: '#/components/schemas/Location'
        pickup:
          $ref: '#/components/schemas/Location'
        sequence:
          type: integer
          format: int32
    Distance:
      type: object
      title: Distance
      properties:
        distanceInMeters:
          type: integer
          format: int64
        distanceInMiles:
          type: number
          format: double
        durationInSeconds:
          type: integer
          format: int64
    Battery:
      type: object
      title: Battery
      properties:
        charging:
          type: boolean
        level:
          type: number
          format: double
    VehicleTransferOrderRequest:
      type: object
      title: VehicleTransferOrderRequest
      properties:
        directions:
          $ref: '#/components/schemas/DetailedDirectionsRequest'
        gatePasses:
          type: array
          items:
            $ref: '#/components/schemas/TempFile'
        notes:
          type: string
        payer:
          $ref: '#/components/schemas/Company'
        reconciliationCode:
          type: string
          x-examples:
          - PARKING_LOT
        vehicle:
          $ref: '#/components/schemas/Vehicle'
      required:
      - directions
      - vehicle
    CompanyRequest:
      type: object
      title: Company
      properties:
        id:
          type: string
          x-examples:
          - c0ef80ce-2579-4682-af4f-c1d29457848a
        name:
          type: string
          x-examples:
          - Auto Land
        type:
          type: string
          enum:
          - DEALER
          - AUCTION
          x-examples:
          - DEALER
      required:
      - id
    VehicleTransferOrderRequestLocation:
      type: object
      title: VehicleTransferOrderRequestLocation
      properties:
        address:
          type: string
          minLength: 1
        auctionCode:
          type: string
        contact:
          $ref: '#/components/schemas/Contact'
        dealerCode:
          type: string
        geolocation:
          $ref: '#/components/schemas/Geolocation'
        name:
          type: string
        notes:
          type: string
        type:
          type: string
          enum:
          - business
          - personal
        windows:
          type: array
          items:
            $ref: '#/components/schemas/Window'
      required:
      - address
    Error:
      type: object
      title: Error
      description: A common Error object.
      properties:
        code:
          type: string
          enum:
          - INVALID_VEHICLE_TRANSFER_ORDER
          - INVALID_ADDRESS
          - INVALID_VEHICLE
          x-examples:
          - INVALID_VEHICLE_TRANSFER_ORDER
        message:
          type: string
          description: The error message.
          x-examples:
          - A vehicle requested has an invalid VIN.
        field:
          type: string
          x-examples:
          - vin
      required:
      - code
    VehicleTransferOrderIds:
      type: object
      title: VehicleTransferOrderIds
      properties:
        id:
          type: string
          x-examples:
          - f7a7a77e-1afb-47b9-8d19-92591590ed33
      required:
      - id
    States:
      type: object
      title: States
      properties:
        accepted:
          $ref: '#/components/schemas/State'
        claimed:
          $ref: '#/components/schemas/State'
        delivered:
          $ref: '#/components/schemas/StateLocation'
        pickedUp:
          $ref: '#/components/schemas/StateLocation'
    Fare:
      type: object
      title: Fare
      properties:
        amount:
          type: number
          format: double
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item'
        name:
          type: string
        options:
          type: array
          items:
            type: string
        promotionCode:
          type: string
          x-examples:
          - RBCON19
    Pageable:
      type: object
      title: Pageable
      properties:
        offset:
          type: integer
          format: int64
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        paged:
          type: boolean
        sort:
          $ref: '#/components/schemas/Sort'
        unpaged:
          type: boolean
    Sort:
      type: object
      title: Sort
      properties:
        empty:
          type: boolean
        sorted:
          type: boolean
        unsorted:
          type: boolean
    TruckSpecifications:
      type: object
      title: TruckSpecifications
      properties:
        rearAxle:
          type: string
    State:
      type: object
      title: State
      properties:
        time:
          type: string
          description: Datetime in ISO 8601 format.
          format: ISO 8601 datetime
          x-examples:
          - '2020-12-05T21:18:47+00:00'
    DetailedDirections:
      type: object
      title: DetailedDirections
      properties:
        distance:
          $ref: '#/components/schemas/Distance'
        dropoff:
          $ref: '#/components/schemas/Location'
        pickup:
          $ref: '#/components/schemas/Location'
    Activity:
      type: object
      title: Activity
      properties:
        confidence:
          type: integer
          format: int32
        type:
          type: string
    Vehicle:
      type: object
      title: Vehicle
      description: When creating an order, there are 2 options for providing the Vehicle information. [See here](/docs/shipping/ace1edcc412ad-vehicle-request-requirements)
      properties:
        color:
          type: string
          x-examples:
          - Blue
        isOperational:
          type: boolean
          x-examples:
          - true
        isOverSized:
          type: boolean
          x-examples:
          - false
        make:
          type: string
          x-examples:
          - BMW
        model:
          type: string
          x-examples:
          - M3
        notes:
          type: string
          x-examples:
          - She's a beauty.
        odometer:
          type: integer
          format: int32
        stockNumber:
          type: string
          x-examples:
          - '1234'
        truckSpecifications:
          $ref: '#/components/schemas/TruckSpecifications'
        type:
          type: string
        vehicleMarket:
          type: string
          enum:
          - LIGHT
          - MEDIUM
          - HEAVY
        vehicleMeasurements:
          $ref: '#/components/schemas/VehicleMeasurements'
        vin:
          type: string
          x-examples:
          - 2C3KA53G68H269241
        year:
          type: integer
          format: int32
      required:
      - vin
    TempFile:
      type: object
      title: TempFile
      properties:
        resourcePath:
          type: string
    Order:
      type: object
      title: Order
      properties:
        id:
          type: string
          x-examples:
          - 151ff45d-9fcc-4df6-b221-cd7fcb1d7614
        referenceNumber:
          type: string
          x-examples:
          - S-000035994
        vehicleTransferOrders:
          type: array
          items:
            $ref: '#/components/schemas/VehicleTransferOrderIds'
        created:
          $ref: '#/components/schemas/Created'
        owner:
          $ref: '#/components/schemas/Company'
        payer:
          $ref: '#/components/schemas/Company'
        canceled:
          $ref: '#/components/schemas/Canceled'
        labels:
          type: array
          items:
            type: string
        notes:
          type: string
          x-examples:
          - Big May 1st delivery.
        status:
          type: string
        type:
          type: string
          enum:
          - BASIC
          - SWAP
        completedDate:
          type: string
          format: date-time
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        fare:
          type: array
          items:
            $ref: '#/components/schemas/FareItem'
        dedicatedTransporter:
          $ref: '#/components/schemas/Company'
        preferredStatusExpiration:
          type: string
        preferredTransporters:
          type: array
          items:
            $ref: '#/components/schemas/Company'
        replacement:
          $ref: '#/components/schemas/Replacement'
      required:
      - id
      - referenceNumber
      - 

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/runbuggy/refs/heads/main/openapi/runbuggy-orders-api-openapi.yml