2490 API Get

Introduction

The purpose of this service is to provide URLs to the proof of delivery/collection documentation held for a given reference of your own.

Parameters

Parameter

Details

Required

Parameter

Details

Required

CustomerCode

The Customer Code of the account

Mandatory

SiteCode

The Site Code of the account

Mandatory

DocRef

Document Reference (your reference)

Mandatory

Example

http://<pathtoapi>/service/POD/CustomerCode/XYZ/SiteCode/AB/DocRef/ORD001

Response

Response will contain URL for document, you have to call the URL with access token

Sample
<I> <URL>http://<pathtoapi>/service/Document/GUID/962d4e84-3dd8-4921-bcce-4a74e7f9b394</URL> </I>

Details





Description

Example





Description

Example

I



Table of results





URL

URL to the document - can repeat

http://<pathtoapi>/Document/Token/VG9rZW4=/Secret/U2VjcmV0/GUID/962d4e84-3dd8-4921-bcce-4a74e7f9b394

I







Response Codes

Common response codes

Code

Message

Code

Message

204

No delivery found in the live system for the parameters provided, if this is not a current delivery then it may have been archived.

204

No delivery found for the parameters provided.

204

Delivery found but has not yet been confirmed delivered.

204

Delivery found, confirmed delivered but POD could not be prepared due to missing electronic signature or absence of POD scan.



Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.