API Reference

Update an existing shipment

patch
https://api.protectplus.io/shipments/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
Body Params

string | null
string | null
string | null
date-time | null
date-time | null
items
array of objects | null
items
servicelevel
object | null
ship_to
object | null
string | null
totals
object | null
Headers
string
enum
Defaults to application/json
Allowed:
Responses

fields_changed array listing which fields were actually
modified by this patch (useful for audit logs).

tracking_number or carrier in body — these are
immutable; identity flows via the URL path only.
  • No updatable fields supplied — the body must include at
    least one editable field. The detail will mention "no
    updatable fields".
  • Field-level validation failure (e.g. eta not ISO 8601,
    items not an array, metadata not a string).

    • detail is "token expired", re-mint via
    POST /auth/v1/token and retry with the new bearer.

    POST /shipments.

    type values:

    Updated about 1 month ago

    Language
    Credentials
    Bearer
    JWT
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json
    application/problem+json

    Updated about 1 month ago