Delivery Note

Delivery Note schema

id long Delivery note ID πŸ“Ά EQUALS,ENUM

_branchId integer Branch ID πŸ“Ά EQUALS,ENUM

_cloudId integer Cloud ID

currency string(3) Currency from xml element DEASDV.DOCUMENT.CURRENCY

created timestamp? Created date and time from xml element DEASDV.DOCUMENT.CREATED πŸ“Ά EQUALS,ENUM,NUMBER πŸ”½ BOTH

deleted boolean Delivery note deleted πŸ“Ά EQUALS,ENUM πŸ”½ BOTH

documentId string(180) Document ID from xml attribute DEASDV.DOCUMENT.id πŸ“Ά EQUALS,ENUM,STRING

documentNumber string(18) Document number from xml element DEASDV.DOCUMENT.DOCUMENT_NUMBER

expeditionDate timestamp? Expedition date and time from xml element DEASDV.DOCUMENT.EXPEDITION_DATE πŸ“Ά EQUALS,ENUM,NUMBER πŸ”½ BOTH

status integer Status

supplierName string(180) Supplier name from xml element DEASDV.DOCUMENT.SUPPLIER.NAME

text string Text from xml element DEASDV.DOCUMENT.TEXT

type enum Type from xml element DEASDV.DOCUMENT.TYPE

url string(256) URL

versionDate timestamp? Last modification date and time πŸ“Ά EQUALS,ENUM,NUMBER πŸ”½ BOTH

DeliveryNote type

// representation like string
DELIVERY_NOTE, RETURN

DeliveryNote response

[
{
"_branchId": <integer>,
"_cloudId": <integer>,
"created": <timestamp>,
"currency": <string>,
"deleted": <boolean>,
"documentId": <string>,
"documentNumber": <string>,
"expeditionDate": <timestamp>,
"id": <string>,
"status": <integer>,
"supplierName": <string>,
"text": <string>,
"type": <enum>,
"url": <string>,
"versionDate": <timestamp>
},
{
...
}
...
]

Delivery note XML file structure

This is a simplified structure only. For the complete format of the document please see the XSD below.

<DEASDV>
<DOCUMENT id="Document UUID" >
<CREATED><!-- RFC 3339 --></CREATED>
<EXPEDITION_DATE><!-- RFC 3339 --></EXPEDITION_DATE>
<TEXT><!-- custom string --></TEXT>
<CURRENCY><!-- ISO 4217 CODE --></CURRENCY>
<DOCUMENT_NUMBER><!-- custom string --></DOCUMENT_NUMBER>
​
<SUPPLIER id="Supplier UUID">
...
</SUPPLIER>
<ITEM>
<SKU><!-- internal SKU to match product with --></SKU>
<PRODUCT_NAME lang="cs"><!-- product name --></PRODUCT_NAME>
<DESCRIPTION><!-- long product description --></DESCRIPTION>
<AMOUNT><!-- number --></AMOUNT>
<UNIT><!-- see below --></UNIT>
<PRICE_WITHOUT_VAT><!-- number --></PRICE_WITHOUT_VAT>
<PRICE_WITH_VAT><!-- number --></PRICE_WITH_VAT>
<VAT_RATE><!-- percent rate such as 15.0 --></VAT_RATE>
<SALE_INFO>
...
</SALE_INFO>
<BARCODES>
...
</BARCODES>
<IMGURL>
...
</IMGURL>
</ITEM>
<ITEM>
...
</ITEM>
...
</DOCUMENT>
<DOCUMENT>
... <!-- the next document -->
</DOCUMENT>
</DEASDV>

Supported units (UNIT)

  • Piece, Points

  • Milligram, Gram, Decagram, Kilogram, Pound, Ounce, Quintal, Tone

  • Millimeter, Centimeter, Meter, Kilometer, Inch, Mile

  • SquareMeter, SquareFoot

  • Milliliter, Centiliter, Deciliter, Liter, UsGallon, UkGallon, CubicFoot, Hectoliter, CubicMeter

  • Second, Minute, Hour, Day, Week, Month, Year

Maximum size of the xml files is set to 60MB. The complete description of the xml file structure can be found in the attached file below:

post
Upload delivery note

https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId/delivery-note-uploads
Upload the delivery note XML file to the server for verification and further processing. For each XML element DEASDV.DOCUMENT a DeliveryNote entity is returned in a list in the response. If TYPE in DEASDV.DOCUMENT is RETURN, then ITEM.AMOUNT must be a negative number or zero and ITEM.PRICE_WITHOUT_VAT, ITEM.PRICE_WITH_VAT and ITEM.VAT_RATE must be NULL (not present under the ITEM node).
Request
Response
Request
Path Parameters
cloudId
required
integer
​
branchId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Content-Type
required
string
multipart/form-data; boundary=:boundary (:boundary can be any value that won't appear in the HTTP data sent to the server, f.e. 12345678-abcd-1234-cdef-1234567890ab)
Body Parameters
file
required
object
Delivery note XML file. You must set file content type: application/xml; charset=:charset (:charset must be a valid charset used to encode the file, f.e. UTF-8, ISO-8859-2, etc.)
Response
200: OK
​
400: Bad Request
​

Below you can see how to correctly configure the request Body in Postman.

get
Get delivery notes

https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
page
optional
integer
​
limit
optional
integer
​
filter
optional
string
​
sort
optional
string
​
Response
200: OK
JSON
JSON
[
{
response schema
},
...
]
400: Bad Request
​
404: Not Found
​

get
Get delivery note

https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId
Request
Response
Request
Path Parameters
deliveryNoteId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

options
Options delivery notes

https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

options
Options delivery note

https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId
Request
Response
Request
Path Parameters
deliveryNoteId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
​
Response
200: OK
​