api

Examples

Retrieve shipment tracking: success

GET /v3-testing/shipments/<apiShipmentId>/tracking HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <JWT>HExpr6Vb1YQssymTrBUIi1Ymu9QEB8
User-Agent: PostmanRuntime/7.26.8
Postman-Token: 27068add-7328-41b7-abe6-da43ce6710ca
Host: api.parcelvalue.eu
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
HTTP/1.1 200 OK
Date: Wed, 16 Mar 2022 15:04:08 GMT
Server: Apache
Content-length: 290
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/vnd.api+json
{"jsonapi":{"version":"1.0"},"data":{"type":"tracking","id":"<apiShipmentId>","attributes":{"carrierShipmentId":"<carrierShipmentId>","trackingHash":"<trackingHash>","trackingStatus":2,"trackingDate":"2022-03-16 16:00:00"}}}

Retrieve shipment tracking: success

No tracking events. trackingStatus and trackingDate have no value

GET /v3-testing/shipments/<apiShipmentId>/tracking HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <JWT>HExpr6Vb1YQssymTrBUIi1Ymu9QEB8
User-Agent: PostmanRuntime/7.26.8
Postman-Token: 86aa80a9-5080-4afa-a680-1419017cd143
Host: api.parcelvalue.eu
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
HTTP/1.1 200 OK
Date: Wed, 16 Mar 2022 15:01:15 GMT
Server: Apache
Content-length: 276
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/vnd.api+json
{"jsonapi":{"version":"1.0"},"data":{"type":"tracking","id":"<apiShipmentId>","attributes":{"carrierShipmentId":"<carrierShipmentId>","trackingHash":"<trackingHash>","trackingStatus":null,"trackingDate":null}}}

Retrieve shipment tracking: error

Shipment not found, status 404. This can mean the shipment with the requested id does not exist in the system, or that the shipment was not yet processed (in the case of scheduled processing).

GET /v3-testing/shipments/X<apiShipmentId>/tracking HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <JWT>HExpr6Vb1YQssymTrBUIi1Ymu9QEB8
User-Agent: PostmanRuntime/7.26.8
Postman-Token: 0367ef65-7b78-4ee8-84f5-12748be46e23
Host: api.parcelvalue.eu
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
HTTP/1.1 404 Not Found
Date: Wed, 16 Mar 2022 15:06:24 GMT
Server: Apache
Content-length: 118
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/vnd.api+json
{"jsonapi":{"version":"1.0"},"errors":[{"status":404,"title":"Not Found","detail":"Error retrieving shipment data."}]}

README