Find Sales Documents

Beta

GET

https://api.npretail.app/:tenant/:environment/:company/ecommerce/documents

GET

/:tenant/:environment/:company/ecommerce/documents

curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ecommerce/documents \
     -H "x-np-api-key: <NaviPartner API Key>" \
     --data-urlencode email=jane.doe@acme.com \
     -d pageSize=2

200Example Find Sales Documents Response

{
  "morePages": true,
  "nextPageKey": "eyJ2aWV3IjoiU09SVElORyguLi4pIn0",
  "nextPageURL": "https://api.npretail.app/ecommerce/documents?email=jane.doe%40acme.com&pageKey=eyJ2aWV3IjoiU09SVElORyguLi4pIn0",
  "salesDocuments": [
    {
      "id": "4ca28ccc-e84b-4788-973c-c8ce5a59383b",
      "externalNo": "WEBP000000001",
      "externalDocumentNo": "WEBORD-123",
      "documentType": "order",
      "creationStatus": "created",
      "postingStatus": "invoiced",
      "captureProcessingStatus": "processed",
      "currencyCode": "DKK",
      "createdAt": "2026-09-09T08:14:22Z",
      "createdDocumentNo": "SO-104213",
      "postedDocumentNos": [
        "PSI-100871"
      ],
      "sellToCustomer": {
        "no": "C00432",
        "name": "Jane Doe",
        "email": "jane.doe@acme.com",
        "phone": "+4512345678"
      }
    }
  ]
}

Returns the incoming e-commerce sales documents that match one e-mail address, newest first. Pass exactly one of email (matched against the document’s sell-to e-mail) or invoiceEmail (matched against the document’s sell-to invoice e-mail). The match is case-insensitive on a bare address. Hits are compact summaries by default; withDetails=true returns the full SalesDocumentDTO without its payments array.

Returns the incoming e-commerce sales documents that match one e-mail address, newest first. Pass exactly one of email (matched against the document's sell-to e-mail) or invoiceEmail (matched against the document's sell-to invoice e-mail). The match is case-insensitive on a bare address. Hits are compact summaries by default; withDetails=true returns the full SalesDocumentDTO without its payments array.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Query parameters

emailstringOptional

The sell-to e-mail address to search for. Exactly one of email and invoiceEmail may carry a value; passing neither, or both with a value, returns 400. Max. length 80 symbols.

invoiceEmailstringOptional

The sell-to invoice e-mail address to search for. Exactly one of email and invoiceEmail must be given. Max. length 80 symbols.

withDetailsbooleanOptional

Pass true to receive full SalesDocumentDTO items instead of the compact summary shape.

pageSizeintegerOptional

Documents per page. Defaults to 100, which is also the maximum. A value below 1 falls back to the default, a higher value is capped at 100, and a non-numeric value returns 400.

pageKeystringOptional

Continuation key taken from a previous response's nextPageKey.

Response

This endpoint returns an object.

morePagesboolean

True when further pages follow. Pass nextPageKey to retrieve them.

nextPageKeystring

Continuation key for the next page, blank on the last page.

nextPageURLstring

Ready-made URL for the next page, blank on the last page.

salesDocumentslist of objects

Authentication

Path parameters

Headers

Query parameters

Response