Skip to main content
PUT
/
fulfillments
/
events
/
{eventId}
Update Fulfillment Event
curl --request PUT \
  --url https://staging-api.puppetvendors.com/fulfillments/events/{eventId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "lineItemId": "<string>",
  "status": "<string>",
  "happenedAt": "<string>",
  "city": "<string>",
  "province": "<string>",
  "country": "<string>",
  "message": "<string>"
}
'
import requests

url = "https://staging-api.puppetvendors.com/fulfillments/events/{eventId}"

payload = {
"lineItemId": "<string>",
"status": "<string>",
"happenedAt": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"message": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lineItemId: '<string>',
status: '<string>',
happenedAt: '<string>',
city: '<string>',
province: '<string>',
country: '<string>',
message: '<string>'
})
};

fetch('https://staging-api.puppetvendors.com/fulfillments/events/{eventId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/fulfillments/events/{eventId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'lineItemId' => '<string>',
'status' => '<string>',
'happenedAt' => '<string>',
'city' => '<string>',
'province' => '<string>',
'country' => '<string>',
'message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://staging-api.puppetvendors.com/fulfillments/events/{eventId}"

payload := strings.NewReader("{\n \"lineItemId\": \"<string>\",\n \"status\": \"<string>\",\n \"happenedAt\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"message\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://staging-api.puppetvendors.com/fulfillments/events/{eventId}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lineItemId\": \"<string>\",\n \"status\": \"<string>\",\n \"happenedAt\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"message\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/fulfillments/events/{eventId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lineItemId\": \"<string>\",\n \"status\": \"<string>\",\n \"happenedAt\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Update an existing fulfillment event. lineItemId is required in the body to identify the parent line item.

Path Parameters

eventId
string
required
Event ObjectId.

Request Body

lineItemId
string
required
Parent line item ObjectId.
status
string
One of in_transit, out_for_delivery, delivered, failed_delivery.
happenedAt
string
ISO 8601 timestamp.
city
string
province
string
country
string
message
string

Response

200
{
  "success": true,
  "data": {
    "_id": "507f1f77bcf86cd799439020",
    "status": "delivered"
  }
}

Example

curl -X PUT "https://staging-api.puppetvendors.com/fulfillments/events/507f1f77bcf86cd799439020" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "lineItemId": "507f1f77bcf86cd799439015",
    "status": "delivered"
  }'