Update delivery instructions

PATCH/v1/shipments/{shipment_id}Update delivery instructions

Parameters

shipment_idstringpathrequired

pattern ^shp_[a-z0-9]{20}$

Request body

required

application/merge-patch+json

objectUpdateShipmentRequest

minProperties 1

delivery_instructionsnull | string

maxLength 500

metadataobject

Example request

{
  "delivery_instructions": "string",
  "metadata": {
    "additionalProp1": "string"
  }
}

Responses

objectShipment

created_atstring · date-timerequired

delivery_instructionsnull | string

idstringrequired

metadataobject

objectvaluerequired

const "shipment"

parcelsarray of objectrequired

Show child attributes

Show array items

contentsarray of object

maxItems 50

Show child attributes

maxItems 50

Show array items

customs_codenull | string

descriptionstringrequired

quantityintegerrequired

minimum 1

unit_valueobjectrequired

Show child attributes

amountstringrequired

pattern ^[0-9]+(\.[0-9]{2})$

currencystringrequired

pattern ^[A-Z]{3}$

height_cmnumberrequired

exclusiveMinimum 0

length_cmnumberrequired

exclusiveMinimum 0

weight_gramsintegerrequired

minimum 1

width_cmnumberrequired

exclusiveMinimum 0

recipientobjectrequired

Show child attributes

citystringrequired

companynull | string

countrystringrequired

pattern ^[A-Z]{2}$

line1stringrequired

line2null | string

namestringrequired

minLength 1

phonenull | string

postal_codestringrequired

regionnull | string

referencestringrequired

senderobjectrequiredAddress ↑

servicestringrequired

one of "economy", "express", "same_day"

statusstringrequired

one of "draft", "label_purchased", "in_transit", "out_for_delivery", "delivered", "exception", "canceled"

tracking_numberstringrequired

updated_atstring · date-timerequired

Example response

{
  "created_at": "2026-09-04T08:15:30Z",
  "delivery_instructions": "string",
  "id": "shp_00000000000000000001",
  "metadata": {
    "additionalProp1": "string"
  },
  "object": "shipment",
  "parcels": [
    {
      "contents": [
        {
          "customs_code": "610910",
          "description": "Synthetic cotton shirt",
          "quantity": 2,
          "unit_value": {
            "amount": "12.50",
            "currency": "XTS"
          }
        }
      ],
      "height_cm": 12,
      "length_cm": 30.5,
      "weight_grams": 1750,
      "width_cm": 20
    }
  ],
  "recipient": {
    "city": "Exampleton",
    "company": "Northstar Supplies",
    "country": "ZZ",
    "line1": "14 Fictional Quay",
    "line2": "Unit 7",
    "name": "Rowan Example",
    "phone": "+00000000000",
    "postal_code": "EX4 2PL",
    "region": "Test Province"
  },
  "reference": "synthetic-order-1042",
  "sender": {
    "city": "Exampleton",
    "company": "Northstar Supplies",
    "country": "ZZ",
    "line1": "14 Fictional Quay",
    "line2": "Unit 7",
    "name": "Rowan Example",
    "phone": "+00000000000",
    "postal_code": "EX4 2PL",
    "region": "Test Province"
  },
  "service": "economy",
  "status": "canceled",
  "tracking_number": "PE-000000000001",
  "updated_at": "2026-09-04T08:16:12Z"
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Examples

shipment_idrequiredpath parameter

curl -X PATCH 'https://api.parcel-events.example/v1/shipments/string' \
  -H 'Content-Type: application/json' \
  -d '{"delivery_instructions":"string","metadata":{"additionalProp1":"string"}}'

const response = await fetch('https://api.parcel-events.example/v1/shipments/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"delivery_instructions":"string","metadata":{"additionalProp1":"string"}}),
});
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/shipments/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.parcel-events.example/v1/shipments/string",
    headers={"Content-Type": "application/json"},
    data='{"delivery_instructions":"string","metadata":{"additionalProp1":"string"}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"delivery_instructions":"string","metadata":{"additionalProp1":"string"}}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.parcel-events.example/v1/shipments/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/shipments/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/shipments/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/shipments/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.parcel-events.example/v1/shipments/string");
request.Content = new StringContent("{\"delivery_instructions\":\"string\",\"metadata\":{\"additionalProp1\":\"string\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "created_at": "2026-09-04T08:15:30Z",
  "delivery_instructions": "string",
  "id": "shp_00000000000000000001",
  "metadata": {
    "additionalProp1": "string"
  },
  "object": "shipment",
  "parcels": [
    {
      "contents": [
        {
          "customs_code": "610910",
          "description": "Synthetic cotton shirt",
          "quantity": 2,
          "unit_value": {
            "amount": "12.50",
            "currency": "XTS"
          }
        }
      ],
      "height_cm": 12,
      "length_cm": 30.5,
      "weight_grams": 1750,
      "width_cm": 20
    }
  ],
  "recipient": {
    "city": "Exampleton",
    "company": "Northstar Supplies",
    "country": "ZZ",
    "line1": "14 Fictional Quay",
    "line2": "Unit 7",
    "name": "Rowan Example",
    "phone": "+00000000000",
    "postal_code": "EX4 2PL",
    "region": "Test Province"
  },
  "reference": "synthetic-order-1042",
  "sender": {
    "city": "Exampleton",
    "company": "Northstar Supplies",
    "country": "ZZ",
    "line1": "14 Fictional Quay",
    "line2": "Unit 7",
    "name": "Rowan Example",
    "phone": "+00000000000",
    "postal_code": "EX4 2PL",
    "region": "Test Province"
  },
  "service": "economy",
  "status": "canceled",
  "tracking_number": "PE-000000000001",
  "updated_at": "2026-09-04T08:16:12Z"
}

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Search documentation

Parameters

Request body

Responses

Documentation menu