> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/tracking/track/waybill.md). # Waybill Build a waybill document from a tracker's tracks over a period, returned as a DOCX file. A waybill is a printable trip document built from a tracker's tracks over a period, returned as a DOCX file rather than as JSON. The call has a side effect worth knowing about: it stores the waybill number it used, which [Waybill settings](/docs/navixy-api/user-api/resources/tracking/track/waybill/settings.md) then reads back. A number consisting only of digits is incremented before being stored, so consecutive waybills carry on a sequence. Waybills are a tariff feature and need the `app_fleet` feature on every tracker in the request. ## API actions API base path: `/track/waybill`. *** ## Download waybill > Build a waybill for the tracker's tracks over a period and return it as a DOCX file.\ > \ > \*\*This call has a side effect\*\*: it stores the waybill number, which \`track/waybill/settings/read\` then returns. A number consisting only of digits is incremented before being stored, so the next waybill can carry on the sequence.\ > \ > Its track defaults differ from \`track/list\`: \`include\_gsm\_lbs\` defaults to \`false\` and \`cluster\_single\_reports\` to \`true\`, because that produces a cleaner document. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Tracks","description":"The trips a tracker made, the points behind them, the geofences and places they passed through, and waybills built from them. All resources under the /track/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/track/waybill/download":{"post":{"tags":["Tracks"],"summary":"Download waybill","description":"Build a waybill for the tracker's tracks over a period and return it as a DOCX file.\n\n**This call has a side effect**: it stores the waybill number, which `track/waybill/settings/read` then returns. A number consisting only of digits is incremented before being stored, so the next waybill can carry on the sequence.\n\nIts track defaults differ from `track/list`: `include_gsm_lbs` defaults to `false` and `cluster_single_reports` to `true`, because that produces a cleaner document.","operationId":"trackWaybillDownload","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.","minimum":1},"from":{"type":"string","description":"Start of the period, in `YYYY-MM-DD HH:MM:SS` format, in the account's timezone."},"to":{"type":"string","description":"End of the period, in `YYYY-MM-DD HH:MM:SS` format. Must be after `from`."},"number":{"type":"string","description":"Waybill number. 1 to 10 characters from letters, digits, spaces and `- _ № # ? %`.","maxLength":10,"pattern":"^[A-Za-zА-Яа-я\\s0-9\\-_№#?%]{1,10}$"},"series":{"type":"string","description":"Optional. Waybill series. Same 1 to 10 character rule as `number`.","maxLength":10,"pattern":"^[A-Za-zА-Яа-я\\s0-9\\-_№#?%]{1,10}$"},"type":{"type":"string","description":"Optional. Default `form3`. Which waybill form to produce. `form3` is the passenger-car form 3, `form3ext` its extended variant for longer periods, and `form4c` and `form4cext` the freight forms.","enum":["form3","form3ext","form4c","form4cext"]},"fill_history":{"type":"boolean","description":"Optional. Default `true`. When `false`, only the driver, garage and vehicle details are filled in, with no trips or parkings."},"fill_odometer":{"type":"boolean","description":"Optional. When `true`, mileage readings are written into the document's odometer fields."},"filter":{"type":"boolean","description":"Optional. Default `true`. Drop tracks that are too short by length and number of points."},"split":{"type":"boolean","description":"Optional. Default `true`. When `false`, all tracks are merged into one."},"include_gsm_lbs":{"type":"boolean","description":"Optional. **Default `false` here**, unlike `track/list`. When `true`, GSM LBS tracks are included."},"cluster_single_reports":{"type":"boolean","description":"Optional. **Default `true` here**, unlike `track/list`. When `false`, one-point trips are not grouped by coordinate."}},"required":["tracker_id","from","to","number"]}}}},"responses":{"200":{"description":"The waybill as a DOCX file","content":{"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schema":{"type":"string","description":"The DOCX document.","format":"binary"}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: the tracker's plan does not include the `app_fleet` feature.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 208: the tracker exists but is blocked, normally because its tariff ended.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` #### Errors These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes): * 236 - Feature unavailable due to tariff restrictions, when one of the trackers is on a tariff without the `app_fleet` feature. ## More in this section #### Waybill settings | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------ | | [`/track/waybill/settings/read`](/docs/navixy-api/user-api/resources/tracking/track/waybill/settings.md#post-track-waybill-settings-read) | POST | Read last waybill number | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/tracking/track/waybill.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.