Orders

Complete an action item

Changed on

Completes one action item on a vehicle and returns the resulting vehicle. The body carries only the fields that action needs, and an action that needs none takes an empty object; there is no partial success.

post/orders/{order}/vehicles/{vehicle}/action-items/{action}

Request

  • Base URL: https://api.ekho.com
  • URL: https://api.ekho.com/orders/{order}/vehicles/{vehicle}/action-items/{action}
  • Auth: HTTP bearer

Path parameters

orderstring required
Example:Tn6Kv2sBjW8pRc4yLm9D
vehiclestring required
Example:Wd5Fy9nJcQ3rXt7bLm2P
action'assign-vin' | 'assign-motorcycle-engine-number' | 'mark-production-complete' | 'mark-in-transit-to-buyer' | 'mark-pickup-scheduled' | 'mark-pickup-fulfilled' required

The action item to complete.

Example:assign-vin

Request body

vinstring

Vehicle identification number.

engine_numberstring

Motorcycle engine number.

estimated_delivery_dateinteger

Epoch ms the vehicle is expected to reach the buyer.

vehicle_tracking_referencestring

Carrier tracking number or link.

contact_numberstring

A number the buyer can call about the shipment.

company_namestring

Name of the fulfillment company.

Response

The vehicle as it stands after the action.

Example response

{
  "data": {
    "id": "Wd5Fy9nJcQ3rXt7bLm2P"
  }
}

Changes

  • 819b111dc3bcRevision changes
    • breaking

      the //// response's property type changed from string to integer for status

  • 87f98453866fRevision changes
    • info

      added the required property // to the response with the status