Tax document

Attach the number and link of the issued e-Archive / e-Invoice / fiscal receipt to the order.

For delivery and online sales the tax document is issued by the business that performs the service; the platform only invoices its own commission. When your POS issues the document, you feed its number and link to PUT /orders/{id}/invoice. The endpoint is the same for restaurants and Çarşı businesses.

Endpoints on this page

Each row links to the full definition in the API reference — fields, response codes and the try-it console.

PUT/orders/{id}/invoice

This endpoint does not issue documents

It only records the details of a document you issued. Issuing, retaining and complying with the regulations is the business's responsibility; we attach that information to the order record.

The distinction is legal, not cosmetic. If the endpoint is read as "issue an invoice", a POS could close the order without ever producing the document, leaving a sale with no tax document behind it.

Retention and link availability

The link you submit must remain reachable for the document's statutory retention period. For commercial books and documents that period is ten years (Turkish Commercial Code art. 82). The document stays with you and we keep no copy; if the link breaks, neither the customer nor the platform can reach it.

The link is probed when written and re-checked weekly. The response carries link.reachable; an unreachable link is not rejected (you may publish the document after we record it) but is flagged with warnings: ["invoice_url_unreachable"]. When the weekly check finds a broken link, the business's management is notified; resubmit to the same endpoint to refresh it.

Response

{
  "invoice": { "number": "GIB2026000000123", "url": "https://ornek-entegrator.example/belge/GIB2026000000123.pdf", "at": "2026-01-31T14:31:02.000Z" },
  "link": { "reachable": true, "httpStatus": 200, "checkedAt": "2026-01-31T14:31:03.000Z" }
}

The submitted document is returned in the order object as the invoice field (number, url, at). The link in the response exists only when invoiceUrl was sent.

Fields

Alan	Tip	Açıklama
`invoiceNumber`	string	The document number (e-Archive / e-Invoice / fiscal receipt no).
`invoiceUrl`	string (https)	`https://` is required; the link must stay reachable for the retention period of the document (ten years for an invoice, Turkish Commercial Code art. 82).

At least one is required; if neither is present the response is 400 bad_request. Sending both is best: the number for the record, the link for the customer. The link must start with https://.

Body

{
  "invoiceNumber": "GIB2026000000123",
  "invoiceUrl": "https://ornek-entegrator.example/belge/GIB2026000000123.pdf"
}

Resending and clearing

Resending overwrites with the latest value — you do not need to cancel the order to correct a wrong number. To clear a field, send an empty string.

Omitting a field and sending an empty string mean different things: an omitted field is preserved, an empty string clears it. Without this distinction, a request updating only the link would also clear the number.

When to call it

The moment you issue the document. Do not wait for the order status: the customer should be able to see the document at any point in the order flow, not only after delivery.

For cash-on-delivery the document is usually issued at hand-over; for online payments it can be issued as soon as the order is confirmed. The rule is the same in both cases: feed it the moment you issue it.