Paazl voor ontwikkelaars

Generic Carrier Interface

Registratiebestand

Dit artikel bevat de technische details van het XML-bestand dat Paazl gebruikt om bestelinformatie naar een vervoerder te sturen. Het artikel Over de Generic Carrier-interface geeft je meer context over het gebruik van dit bestand.

Paazl verzendt een registratiebestand voor elke bevestigde webshopbestelling op het moment dat de bijbehorende verzendlabels worden gegenereerd via de webapp of een SOAP- of REST API-call.

Format bestandsnaam

De naam van een registratiebestand heeft het volgende format:

<naam generieke vervoerder>_<klantnummer>_<datum_tijd>.xml

Voorbeeld: TRUNKRS_20181010001_20190713_151036.xml

Barcodeformat

De barcode van een verzendlabel bevat het nummer van je contract met de betreffende webshop, gevolgd door een zescijferig getal (van 000000 tot 999999).

Elementspecificaties

Element	Type	Verplicht?	Omschrijving
`registration`	Complex	Verplicht	Bevat de details van een webshopbestelling.
`orders`	Complex	Verplicht	Bevat informatie over de bestellingen van een webshop.
`order`	Complex	Verplicht	De details van een specifieke bestelling.
`reference`	String	Verplicht	De referentie van een webshop voor een bestelling.
`serviceCode`	String	Verplicht	De unieke code van een vervoerder voor een van zijn diensten.
`accountNumber`	String	Verplicht	Het nummer van een contract dat een webshop heeft met een vervoerder. De betreffende webshop verstrekt dit nummer aan Paazl.
`preferredDeliveryDate`	Date	Verplicht	De datum die je klanten hebben geselecteerd tijdens het afrekenen.
`cod`	Complex	Optioneel	Bevat informatie over het remboursbedrag (Cash On Delivery).
`currency`	String	Optioneel	De ISO 4217-code van de betreffende valuta. De standaardwaarde is `EUR`.
`value`	Decimal	Optioneel	Het bedrag dat betaald moet worden bij ontvangst van de goederen.
`insurance`	Complex	Optioneel	Bevat informatie over het verzekerde bedrag.
`currency`	String	Optioneel	De ISO 4217-code van de betreffende valuta. De standaardwaarde is `EUR`.
`value`	Integer	Optioneel	De geldwaarde van een bestelling.
`shipper`	Complex	Verplicht	Bevat details van de partij die een bestelling heeft verzonden.
`companyName`	String	Optioneel	De naam van het bedrijf dat een bestelling verzendt.
`name`	String	Verplicht	De naam van de contactpersoon die de bestelling verzendt.
`nameOther`	String	Optioneel	Gebruik dit voor eventuele aanvullende naamsinformatie, zoals een afdeling.
`street`	String	Verplicht	De naam van de straat waar de verzender is gevestigd.
`streetNumber`	Integer	Verplicht	Het huisnummer van het adres van de verzender.
`streetNumberSuffix`	String	Optioneel	De huisnummertoevoeging (zoals de "-A" in "12-A") van het adres vanwaar een bestelling wordt verzonden.
`additionalAddressLine`	String	Optioneel	De tweede of volgende adresregels vanwaar een bestelling wordt verzonden, opgegeven als een of meerdere strings.
`postalCode`	String	Verplicht	De postcode van het adres vanwaar een bestelling wordt verzonden.
`town`	String	Verplicht	De stad of plaats van het adres van de verzender.
`country`	String	Verplicht	De ISO 3166-2-code voor het land van het adres van de verzender.
`return`	Complex	Verplicht	Bevat details van de partij waarnaar een bestelling wordt geretourneerd.
`companyName`	String	Verplicht	De bedrijfsnaam van de partij waarnaar een bestelling wordt geretourneerd.
`name`	String	Optioneel	De naam van de contactpersoon waarnaar een bestelling wordt geretourneerd.
`nameOther`	String	Optioneel	Gebruik dit voor eventuele aanvullende naamsinformatie, zoals een afdeling.
`street`	String	Verplicht	De naam van de straat waarnaar goederen worden geretourneerd.
`streetNumber`	Integer	Verplicht	Het huisnummer van het adres waarnaar goederen worden geretourneerd.
`streetNumberSuffix`	String	Optioneel	De huisnummertoevoeging (zoals de "-A" in "12-A") van het adres waarnaar een bestelling wordt geretourneerd.
`additionalAddressLine`	String	Optioneel	De tweede of volgende adresregels waarnaar een bestelling wordt geretourneerd, opgegeven als een of meerdere strings.
`postalCode`	String	Verplicht	De postcode van het adres waarnaar een bestelling wordt geretourneerd.
`town`	String	Verplicht	De stad of plaats van het adres waarnaar goederen worden geretourneerd.
`country`	String	Verplicht	De ISO 3166-2-code voor het land van het adres waarnaar een bestelling wordt geretourneerd.
`emailAddress`	String	Optioneel	Het e-mailadres van de partij waarnaar goederen worden geretourneerd.
`phoneNumber`	String	Optioneel	Het telefoonnummer van de partij waarnaar goederen worden geretourneerd.
`consignee`	Complex	Verplicht	Bevat details van de partij waarnaar een bestelling wordt verzonden (geadresseerde).
`companyName`	String	Optioneel	De naam van het bedrijf waarnaar een bestelling wordt verzonden.
`name`	String	Verplicht	De naam van de contactpersoon waarnaar een bestelling wordt verzonden.
`nameOther`	String	Optioneel	Gebruik dit voor eventuele aanvullende naamsinformatie, zoals een afdeling.
`street`	String	Verplicht	De naam van de straat waarnaar een bestelling wordt verzonden.
`streetNumber`	Integer	Verplicht	Het huisnummer van het adres waarnaar een bestelling wordt verzonden.
`streetNumberSuffix`	String	Optioneel	De huisnummertoevoeging (zoals de "-A" in "12-A") van het adres waarnaar een bestelling wordt verzonden.
`additionalAddressLine`	String	Optioneel	De tweede of volgende adresregels waarnaar een bestelling wordt verzonden, opgegeven als een of meerdere strings. Let op: Paazl verwerkt deze string niet om validaties uit te voeren op eventuele waarden die voor de andere adresparameters van de geadresseerde zijn opgegeven.
`postalCode`	String	Verplicht	De postcode van het adres waarnaar een bestelling wordt verzonden.
`town`	String	Verplicht	De stad of plaats van het adres waarnaar een bestelling wordt verzonden.
`country`	String	Verplicht	De ISO 3166-2-code voor het land van het adres waarnaar een bestelling wordt verzonden.
`emailAddress`	String	Optioneel	Het e-mailadres van de partij waarnaar een bestelling wordt verzonden.
`phoneNumber`	String	Optioneel	Het telefoonnummer van de partij waarnaar een bestelling wordt verzonden.
`notifications`	Complex	Optioneel	Bevat waarden over de notificatietypen en de bijbehorende e-mailadressen of telefoonnummers.
`notification`	Complex	Optioneel	Bevat waarden over de notificatietypen en de bijbehorende e-mailadressen of telefoonnummers.
`notificationType`	String	Optioneel	Het kanaal waarmee de informatie over de bezorgstatus wordt verzonden. Dit element heeft een van de volgende twee mogelijke waarden: `CONSIGNEE_EMAIL` `CONSIGNEE_PHONE`
`notificationValue`	String	Optioneel	De bezorgstatus van een zending.
`products`	Complex	Optioneel	Bevat informatie over de producten waaruit een bestelling bestaat.
`product`	Complex	Optioneel	Bevat informatie over een van de producten waaruit een bestelling bestaat.
`quantity`	Integer	Verplicht	Het aantal stuks van een specifiek producttype in een zending.
`length`	Integer	Optioneel	De lengte van een product in hele centimeters (cm).
`width`	Integer	Optioneel	De breedte van een product in hele centimeters (cm).
`height`	Integer	Optioneel	De hoogte van een product in hele centimeters (cm).
`volume`	Double	Optioneel	Het volume van een product in kubieke meter (m³), inclusief verpakking.
`weight`	Double	Verplicht	Het gewicht van een product in kilogram (kg).
`description`	String	Optioneel	De omschrijving die vereist is voor de douane.
`countryOfManufacture`	String	Optioneel	De ISO 3166-2-code voor het land waar de verzonden goederen zijn geproduceerd.
`unitPrice`	nonNegativeDecimal	Optioneel	De prijs van een product.
`unitPriceCurrency`	currencyCode	Optioneel	De ISO 4217-code van de betreffende valuta. De standaardwaarde is `EUR`.
`hsTariffCode`	String	Optioneel	De GS-code (HS code) voor de goederencategorie van het betreffende product.
`skuCode`	String	Optioneel	Een SKU (Stock Keeping Unit) is een uniek nummer dat gebruikt wordt om de bedrijfsvoorraad intern bij te houden. Het helpt specifiek om aanvullende eigenschappen te beschrijven voor vervoerders of de douane bij internationale export. Let op: SKU-codes zijn geen Universal Product Codes (UPC's).
`direction`	directionType	Optioneel	Heeft betrekking op omruilbestellingen (swap orders) waarbij sommige producten worden opgehaald bij een afhaallocatie en andere worden afgeleverd op het adres van de geadresseerde. Kan een van de volgende twee waarden hebben: `DELIVERY` `PICKUP`
`shipments`	Complex	Verplicht	Bevat barcodes die horen bij de verschillende zendingen waaruit een bestelling bestaat.
`shipment`	Complex	Verplicht	Bevat de barcodes die horen bij een van de zendingen waaruit een bestelling bestaat.
`packages`	Complex	Verplicht	Bevat de barcodes van de verschillende pakketten in een zending.
`package`	Complex	Verplicht	Bevat de barcode van een van de producten in een zending.
`barcode`	String	Verplicht	De door Paazl gegenereerde barcode van het label.
`additionalInstruction`	String	Optioneel	Als de vervoerder dit vereist, wordt deze instructie op het adreslabel gedrukt.
`version`	String	Verplicht	De versie van het registratiebestand die momenteel wordt gebruikt.

XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema targetNamespace="http://www.paazl.com/schemas/registration" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:registration="http://www.paazl.com/schemas/registration">

   <xs:element name="registration">
      <xs:complexType>
         <xs:sequence>
            <xs:element name="orders" type="registration:OrdersType" />
         </xs:sequence>
         <xs:attribute name="version" type="xs:string" use="required" />
      </xs:complexType>
   </xs:element>

   <xs:complexType name="OrdersType">
      <xs:sequence>
         <xs:element name="order" type="registration:OrderType" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="OrderType">
      <xs:sequence>
         <xs:element name="reference" type="xs:string" />
         <xs:element name="serviceCode" type="xs:string" />
         <xs:element name="accountNumber" type="xs:string" />
         <xs:element name="preferredDeliveryDate" type="xs:date" />
         <xs:element name="cod" type="registration:CodType" minOccurs="0" />
         <xs:element name="insurance" type="registration:InsuranceType" minOccurs="0" />
         <xs:element name="shipper" type="registration:ContactAndAddressType" />
         <xs:element name="return" type="registration:ContactAndAddressType" />
         <xs:element name="consignee" type="registration:ContactAndAddressType" />
         <xs:element name="notifications" type="registration:NotificationsType" />
         <xs:element name="products" type="registration:ProductsType" minOccurs="0" />
         <xs:element name="shipments" type="registration:ShipmentsType" />
         <xs:element name="additionalInstruction" type="xs:string" minOccurs="0" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="CodType">
      <xs:sequence>
         <xs:element name="currency" type="xs:string"/>
         <xs:element name="value" type="xs:decimal" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="InsuranceType">
      <xs:sequence>
         <xs:element name="currency" type="xs:string"/>
         <xs:element name="value" type="xs:int" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="ContactAndAddressType">
      <xs:sequence>
         <xs:element name="companyName" type="xs:string" minOccurs="0" />
         <xs:element name="name" type="xs:string" />
         <xs:element name="nameOther" type="xs:string" minOccurs="0" />
         <xs:element name="street" type="xs:string" />
         <xs:element name="streetNumber" type="xs:int" />
         <xs:element name="streetNumberSuffix" type="xs:string" minOccurs="0" />
         <xs:element name="additionalAddressLine" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
         <xs:element name="postalCode" type="xs:string" />
         <xs:element name="town" type="xs:string" />
         <xs:element name="country" type="xs:string" />
         <xs:element name="emailAddress" type="xs:string" minOccurs="0" />
         <xs:element name="phoneNumber" type="xs:string" minOccurs="0" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="ProductsType">
      <xs:sequence>
         <xs:element name="product" type="registration:ProductType" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="ProductType">
      <xs:sequence>
         <xs:element name="quantity" type="xs:int" />
         <xs:element name="length" type="xs:int" minOccurs="0" />
         <xs:element name="width" type="xs:int" minOccurs="0" />
         <xs:element name="height" type="xs:int" minOccurs="0" />
         <xs:element name="volume" type="xs:double" minOccurs="0" />
         <xs:element name="weight" type="xs:double" />
         <xs:element name="description" type="xs:string" minOccurs="0" />
         <xs:element name="countryOfManufacture" minOccurs="0" type="xs:string" />
         <xs:element name="unitPrice" minOccurs="0" type="registration:nonNegativeDecimal" />
         <xs:element name="unitPriceCurrency" minOccurs="0" default="EUR" type="registration:currencyCode" />
         <xs:element name="hsTariffCode" minOccurs="0" type="xs:string" />
         <xs:element name="skuCode" type="xs:string" minOccurs="0"/>
         <xs:element name="direction" minOccurs="0" type="registration:directionType" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="ShipmentsType">
      <xs:sequence>
         <xs:element name="shipment" type="registration:ShipmentType" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="ShipmentType">
      <xs:sequence>
         <xs:element name="packages" type="registration:PackagesType" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="PackagesType">
      <xs:sequence>
         <xs:element name="package" type="registration:PackageType" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="PackageType">
      <xs:sequence>
         <xs:element name="barcode" type="xs:string" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="NotificationsType">
      <xs:sequence>
         <xs:element name="notification" type="registration:NotificationType" maxOccurs="unbounded" />
      </xs:sequence>
   </xs:complexType>

   <xs:complexType name="NotificationType">
      <xs:sequence>
         <xs:element name="notificationType" type="registration:genericNotificationType" />
         <xs:element name="notificationValue" type="xs:string" />
      </xs:sequence>
   </xs:complexType>

   <xs:simpleType name="genericNotificationType">
      <xs:restriction base="xs:string">
         <xs:enumeration value="CONSIGNEE_EMAIL"/>
         <xs:enumeration value="CONSIGNEE_PHONE"/>
      </xs:restriction>
   </xs:simpleType>

   <xs:simpleType name="nonNegativeDecimal">
      <xs:restriction base="xs:decimal">
         <xs:minInclusive value="0"/>
      </xs:restriction>
   </xs:simpleType>

   <xs:simpleType name="currencyCode">
      <xs:restriction base="xs:string">
         <xs:length value="3"/>
         <xs:pattern value="[A-Z]{3}"/>
      </xs:restriction>
   </xs:simpleType>

   <xs:simpleType name="directionType">
      <xs:restriction base="xs:string">
         <xs:enumeration value="pickup"/>
         <xs:enumeration value="delivery"/>
      </xs:restriction>
   </xs:simpleType>

</xs:schema>

Voorbeelden

COD

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<registration xmlns="http://www.paazl.com/schemas/registration" version="1.0">
  <orders>
    <order>
      <serviceCode>PROD5</serviceCode>
      <cod>
        <currency>EUR</currency>
        <value>50.00</value>
      </cod>
      <shipperAddress>
        <companyName>Paazl</companyName>
        <street>Kerkstraat</street>
        <streetNumber>310</streetNumber>
        <postalCode>1017HC</postalCode>
        <town>Amsterdam</town>
        <country>NL</country>
      </shipperAddress>
      <returnAddress>
        <companyName>Paazl</companyName>
        <street>Kerkstraat</street>
        <streetNumber>310</streetNumber>
        <postalCode>1017HC</postalCode>
        <town>Amsterdam</town>
        <country>NL</country>
      </returnAddress>
      <consignee>
        <companyName>A Company BV</companyName>
        <name>My Name</name>
        <nameOther>Extra name field</nameOther>
        <street>Damrak</street>
        <streetNumber>70</streetNumber>
        <streetNumberSuffix>1</streetNumberSuffix>
        <postalCode>1012LM</postalCode>
        <town>Amsterdam</town>
        <country>NL</country>
      </consignee>
      <shipments>
        <shipment>
          <packages>
            <package>
              <barcode>1234500000100</barcode>
            </package>
          </packages>
        </shipment>
      </shipments>
      <additionalInstruction>Please leave parcel at number 20</additionalInstruction>
    </order>
  </orders>
</registration>

Verzekerd

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<registration xmlns="http://www.paazl.com/schemas/registration" version="1.0">
  <orders>
    <order>
      <serviceCode>PROD5</serviceCode>
      <insurance>
        <currency>EUR</currency>
        <value>150.00</value>
      </insurance>
      <shipperAddress>
        <companyName>Paazl</companyName>
        <street>Kerkstraat</street>
        <streetNumber>310</streetNumber>
        <postalCode>1017HC</postalCode>
        <town>Amsterdam</town>
        <country>NL</country>
      </shipperAddress>
      <returnAddress>
        <companyName>Paazl</companyName>
        <street>Kerkstraat</street>
        <streetNumber>310</streetNumber>
        <postalCode>1017HC</postalCode>
        <town>Amsterdam</town>
        <country>NL</country>
      </returnAddress>
      <consignee>
        <companyName>A Company BV</companyName>
        <name>My Name</name>
        <nameOther>Extra name field</nameOther>
        <street>Damrak</street>
        <streetNumber>70</streetNumber>
        <streetNumberSuffix>1</streetNumberSuffix>
        <postalCode>1012LM</postalCode>
        <town>Amsterdam</town>
        <country>NL</country>
      </consignee>
      <shipments>
        <shipment>
          <packages>
            <package>
              <barcode>1234500000100</barcode>
            </package>
          </packages>
        </shipment>
      </shipments>
      <additionalInstruction>Please leave parcel at number 20</additionalInstruction>
    </order>
  </orders>
</registration>

Recente zoekopdrachten

Paazl voor ontwikkelaars

Generic Carrier Interface

Registratiebestand

Format bestandsnaam

Barcodeformat

Elementspecificaties

XSD

Voorbeelden

COD

Verzekerd

Was dit artikel nuttig?

Recente zoekopdrachten

Populaire Artikelen

Artikelen

Onderwerpen

Tickets

Paazl voor ontwikkelaars

Generic Carrier Interface

Registratiebestand

Format bestandsnaam

Barcodeformat

Elementspecificaties

XSD

Voorbeelden

COD

Verzekerd

Was dit artikel nuttig?