Create a new order

Log in to see full request history

Create a new order with a POST request to /orders. Include a JSON object containing a unique order id. A successful request will return the order object that was created.

Order IDs

You are responsible for providing a unique Order ID. You must continue to use this Order ID in all further requests that pertain to the resource that was requested. The benefit of being able to choose your own Order ID is that you do not need to store a unique identifier that was generated by us to access your own resources.

An attempt to create a new order with an Order ID that already exists will result in a 409 Conflict HTTP Response with a corresponding message in JSON format.

Sample Request:

curl -i https://api.vift.com/orders \ -u YOUR_APP_ID:YOUR_API_KEY \ -H "Content-Type: application/json" \ -X POST \ -d '{ "id": "YOUR_ORDER_ID", "name": "John Doe", "email": "john@doe.com", "recipient_name": "Jane Doe", "recipient_email": "jane@doe.com", "price": 195 }'
Body Params
string
required

Order ID (REQUIRED)

string

Name of customer (purchaser/sender) (OPTIONAL)

string

Email address of customer (purchaser/sender) (OPTIONAL)

string

The full name of the video message's recipient (likely also your package recipient) (OPTIONAL)

string

The email address of the video message's recipient (likely also your package recipient) (OPTIONAL)

int32

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. In a license fee payment plan, it is not applicable (OPTIONAL)

Responses

Language
Credentials
:
Click Try It! to start a request and see the response here! Or choose an example:
application/json