/orders/:id

Update an existing order

Update an existing order with a PUT request to the resource url.

Use a PUT request to update an order's customer details, carrier and tracking information, delivery status, or price.

Sample Request

The following request uses Standard Carrier Shipping by providing the carrier name and tracking number for a package. Vift tracks the package and sends the video message to the recipient when the carrier marks the package as delivered.

Shell

curl -i https://api.vift.com/orders/YOUR_ORDER_ID \
		 -u YOUR_APP_ID:YOUR_API_KEY \
		 -H "Content-Type: application/json" \
     -X PUT \
     -d '{
           "carrier": "UPS",
           "tracking_number": "1Z999AA10123456784"
         }'

Sample Request

The following request uses Custom Shipment Tracking to mark a package as delivered, which triggers the video message to be sent to the recipient.

Shell

curl -i https://api.vift.com/orders/YOUR_ORDER_ID \
     -u YOUR_APP_ID:YOUR_API_KEY \
		 -H "Content-Type: application/json" \
     -X PUT \
     -d '{
           "delivered": 1
         }'

Sample Request

The following requests updates the price charged to the customer for the Vift Video Gift Message. For Vift accounts using the revenue share plan, this price is used to calculate your account's monthly billing.

📘

Note: All prices must be in cents.

In the following sample request, the customer was charged $5.50 for the Vift Video Gift Message.

Shell

curl -i https://api.vift.com/orders/YOUR_ORDER_ID \
     -u YOUR_APP_ID:YOUR_API_KEY \
		 -H "Content-Type: application/json" \
     -X PUT \
     -d '{
           "price": 550
         }'