An order object contains the following fields:
| Attribute | Type | Description |
|---|---|---|
| id | String | Order ID (the unique identifier for the order) |
| uuid | String | Unique order identifier generated by us |
| name | String | The full name of the customer who made the order (purchaser/sender) |
| String | The email address of the customer who made the order (purchaser/sender) | |
| recipient_name | String | The full name of the video message's recipient (likely also your package recipient) |
| recipient_email | String | The email address of the video message's recipient (likely also your package recipient) |
| recipient_phone | String | The cell phone number of the video message's recipient (likely also your package recipient) |
| record_url | String | Web address where a user can record and save their video message |
| playback_url | String | Web address where the recipient can view their video message |
| send_method | String | The customer's chosen method of sending the video message, either "email" or "text" |
| send_trigger | String | The customer's chosen option of when to send the video; either "package" for when the package is delivered or "date" if the customer chooses to have the video delivered on a specific date instead |
| send_on | DateTime | The date and time that the customer has chosen to send the video (this field is only applicable if a customer chooses to send the video message on a specific date) |
| carrier | String | The shipping carrier for the package. Must be one of UPS, FedEx, or USPS |
| tracking_number | String | The tracking number of the package |
| delivered | Boolean | The status of the package delivery |
| video_title | String | The title of the video created by the customer |
| video_duration | Int | The duration of the video recorded or uploaded by the customer, in milliseconds |
| video_processed | Boolean | The status of the video being processed after the customer has recorded or uploaded |
| price | Int | The price, in cents, that was charged to the customer for the Vift Video Gift Message. For accounts using a revenue share payment plan, this price will be used for billing. For accounts using a license fee payment plan, it is not applicable. |
| status | String | The status of the order |
| created_at | DateTime | The date and time of when the order was created |
| updated_at | DateTime | The date and time of when the order was updated |
| recorded_at | DateTime | The date and time of when the order was recorded |
| delivered_at | DateTime | The date and time of when the order (physical package associated with the video) was delivered |
| sent_at | DateTime | The date and time of when the video message was sent to the recipient |
| viewed_at | DateTime | The date and time of when the video message was first viewed by the recipient |
JSON Representation
{
"id": "YOUR_ORDER_ID",
"uuid": "d41dfd35-461f-4e04-816b-d6bcf5ed30a7",
"name": "John Doe",
"email": "[email protected]",
"recipient_name": "Jane Doe",
"recipient_email": "[email protected]",
"recipient_phone": null,
"record_url": "https://vift.com/record/d41dfd35-461f-4e04-816b-d6bcf5ed30a7",
"playback_url": "https://vift.com/watch/d41dfd35-461f-4e04-816b-d6bcf5ed30a7",
"send_method": "email",
"send_trigger": "package",
"send_on": null,
"carrier": "UPS",
"tracking_number": "1Z999AA10123456784",
"delivered": "1",
"video_title": "My Vift Video",
"video_duration": "30072",
"video_processed": "1",
"status": "delivered",
"created_at": "2015-01-01T00:00:00Z",
"updated_at": "2015-01-01T02:00:00Z",
"recorded_at": "2015-01-01T01:00:00Z",
"delivered_at": "2015-01-01T02:00:00Z",
"sent_at": "2015-01-01T02:00:03Z",
"viewed_at": "2015-01-01T02:12:00Z"
}