Returns shipment information by ID (public, no auth required)

Get shipment by ID (public access for return portal)

GET /public/shipments/id/{shipmentId}

Returns shipment information by ID (public, no auth required)

cURL

curl --request GET \
  --url https://api.zippendo.com/public/shipments/id/{shipmentId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "reference": "<string>",
  "status": "<string>",
  "recipientName": "<string>",
  "recipientEmail": "<string>",
  "createdAt": "<string>",
  "orgId": "<string>",
  "orderLines": [
    {
      "quantity": 123,
      "sku": "<string>",
      "description": "<string>",
      "unitPrice": 123,
      "currency": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT access token or API token (prefixed with zipp_)

Path Parameters

shipmentId · string · required

Shipment ID

Response

200

application/json

Default Response

id · string · required

reference · string · required

status · string · required

recipientName · string | null · required

recipientEmail · string | null · required

createdAt · string · required

orgId · string · required

orderLines · object[] · required

Show child attributes