Skip to content

List of delivery notes

Request

The list of delivery notes supports the Paging.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
isValidboolean

filtering according to document validity

Example:isValid=true
orderCodestring

filtering according to number of order

Example:orderCode=2018000012
creationTimeFromstring

filtering delivery notes created after date

Example:creationTimeFrom=2014-09-05T00:00:00%2B0000
creationTimeTostring

filtering delivery notes created before date

Example:creationTimeTo=2019-09-05T00:00:00%2B0000
changeTimeFromstring

filtering delivery notes updated after date

Example:changeTimeFrom=2014-09-05T00:00:00%2B0000
changeTimeTostring

filtering delivery notes updated before date

Example:changeTimeTo=2019-09-05T00:00:00%2B0000
customerGuidstring

filtering delivery notes with given customer

Example:customerGuid=443cad54-73bc-11e8-8216-002590dad85e
itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 100.

Example:itemsPerPage=50
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/delivery-notes?isValid=true&orderCode=2018000012&creationTimeFrom=2014-09-05T00%3A00%3A00%252B0000&creationTimeTo=2019-09-05T00%3A00%3A00%252B0000&changeTimeFrom=2014-09-05T00%3A00%3A00%252B0000&changeTimeTo=2019-09-05T00%3A00%3A00%252B0000&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&itemsPerPage=50&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "deliveryNotes": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}