Skip to content

Detail of shipment

Request

Returns detail of a single shipment identified by its GUID.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
guidstringrequired

Shipment GUID.

Example:93bc0dbe-7481-11e8-8216-002590dad85e
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/shipments/93bc0dbe-7481-11e8-8216-002590dad85e \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json; charset=utf-8
dataobjectrequired
errorsArray of objects or null(Errors)required
Response
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "orderCode": "2024000008",
    "sender": { … },
    "recipient": { … },
    "carrierAddress": { … },
    "status": "requested",
    "shipmentType": "standard",
    "serviceCode": "logistics-ppl-parcel-cz-private-home-delivery",
    "cod": { … },
    "value": { … },
    "customer": { … },
    "packages": [ … ],
    "note": "This is a note"
  },
  "errors": [
    { … }
  ]
}