Skip to content

List of all delivery notes

Request

Using this endpoint, you can get list of all delivery notes with detailed info of each delivery note (like in Delivery note detail endpoint) asynchronously.

See how Asynchronous requests work on our developer's portal.

Response will be in jsonlines format with each delivery note taking one line of output file.

One delivery note in response has the same format as delivery note detail response. See Delivery note snapshot schema for more details.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
creationTimeFromstring

Export delivery notes created after date

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

Export delivery notes created before date

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

Export delivery notes updated after date

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

Export delivery notes updated before date

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

Export delivery notes with code after given value

Example:codeFrom=0000000006
codeTostring

Export delivery notes with code befor given value

Example:codeTo=0000000006
orderCodeFromstring

Export delivery notes with order code after given value

Example:orderCodeFrom=2017000010
orderCodeTostring

Export delivery notes with order code before given value

Example:orderCodeTo=2017000010
customerGuidstring

Export delivery notes with given customer

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

Filtering according to document validity

Example:isValid=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/delivery-notes/snapshot?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&codeFrom=0000000006&codeTo=0000000006&orderCodeFrom=2017000010&orderCodeTo=2017000010&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&isValid=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

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