Proof Of Delivery

Endpoint

Production URL :
https://sct-tracking-data-api.services.simacan.com/api/v1/proofofdelivery
Staging URL :
https://sct-tracking-data-api-stg.services.simacan.com/api/v1/proofofdelivery

A proof of delivery can be sent to this endpoint. For example that the package is delivered, or the package is delivered at the neighbours. The format should be strict to the XML Schema Definition

Responses

Key	Description
200	Ok
204	No Content Indicates that your request was successful. However we will not be sending you any data
400	Bad Request You will receive this status, when the data you’ve delivered is not in the correct XML format. You will see an entity describing what went wrong
401	Unauthorized Whenever you will get a 401 status, you have either provided the wrong credentials or none at all. Check if you bearer token has not expired
403	Forbidden You will receive this status, when you successfully supplied credentials, but your username does not have the necessary permissions for the resource
404	Not Found Whenever you will get a 404, you are probably using a malformed or incorrect URL

XML Schema Definition

Copy

Copied

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0.1"
           targetNamespace="http://api.transportcloud.io/schemas/carrier/v1/realisation"
           xmlns:tc="http://api.transportcloud.io/schemas/carrier/v1/realisation"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:element name="proofOfDelivery" type="tc:proofOfDelivery"/>

    <xs:complexType name="proofOfDelivery">
        <xs:sequence>
            <xs:element name="externalDeviceId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="shipmentId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="timestamp" type="xs:dateTime"/>
            <xs:element name="deliveryStatus" type="tc:deliveryStatus"/>
            <xs:element name="deliveryRemark">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="250"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="heading" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:double">
                        <xs:minInclusive value="0.0"/>
                        <xs:maxInclusive value="360.0"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="x" type="xs:double" minOccurs="0"/>
            <xs:element name="y" type="xs:double" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>

    <xs:simpleType name="deliveryStatus">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Bezorgd. Overhandigd aan klant."/>
            <xs:enumeration value="Bezorgd. Volgens bezorgnotitie, locatie:"/>
            <xs:enumeration value="Bezorgd. Overhandigd aan buren, adres:"/>
            <xs:enumeration value="Niet bezorgd. Klant niet thuis."/>
            <xs:enumeration value="Bezorgd. Burenbezorging op adres:"/>
            <xs:enumeration value="Niet bezorgd. Klant en 5buren niet thuis."/>
            <xs:enumeration value="Niet bezorgd. Klant wil levering niet aannemen."/>
            <xs:enumeration value="Niet bezorgd. Andere reden:"/>
            <xs:enumeration value="Deels bezorgd. Toelichting:"/>
            <xs:enumeration value="Incompleet bezorgd: Het missende product is:"/>
            <xs:enumeration value="Lading opgehaald. Vertrek van hub."/>
            <xs:enumeration value="DELIVERY_OPTION_1"/>
            <xs:enumeration value="DELIVERY_OPTION_2"/>
            <xs:enumeration value="DELIVERY_OPTION_3"/>
            <xs:enumeration value="DELIVERY_OPTION_4"/>
            <xs:enumeration value="DELIVERY_OPTION_5"/>
            <xs:enumeration value="DELIVERY_OPTION_6"/>
            <xs:enumeration value="DELIVERY_OPTION_7"/>
            <xs:enumeration value="DELIVERY_OPTION_8"/>
            <xs:enumeration value="DELIVERY_OPTION_9"/>
            <xs:enumeration value="PICKUP_OPTION_1"/>
            <xs:enumeration value="PICKUP_OPTION_2"/>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>