Get Sales Document | NaviPartner | NP Retail API Documentation

1 import requests 2 3 url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ecommerce/documents/e2cfea9f-385e-4d83-8b50-42256885b03a" 4 5 headers = {"x-np-api-key": "<NaviPartner API Key>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "externalNo": "WEBP000000001", 3 "id": "4ca28ccc-e84b-4788-973c-c8ce5a59383b", 4 "documentType": "order", 5 "creationStatus": "created", 6 "postingStatus": "invoiced", 7 "currencyCode": "DKK", 8 "currencyExchangeRate": 1, 9 "externalDocumentNo": "WEBORD-123", 10 "locationCode": "", 11 "yourReference": "REF-789", 12 "pricesExcludingVat": false, 13 "captureProcessingStatus": "pending", 14 "lastCaptureErrorMessage": "", 15 "sellToCustomer": { 16 "no": "CUST-10001", 17 "name": "Acme Corporation", 18 "name2": "Corporation", 19 "address": "123 Main Street", 20 "address2": "Suite 400", 21 "postCode": "10001", 22 "county": "New York", 23 "city": "New York", 24 "countryCode": "US", 25 "contact": "Jane Doe", 26 "email": "jane.doe@acme.com", 27 "phone": "+1-555-123-4567", 28 "ean": "1234567890123", 29 "vatRegistrationNo": "US123456789", 30 "invoiceEmail": "invoices@acme.com", 31 "customerTemplate": "DOMESTIC", 32 "configurationTemplate": "CUST000001" 33 }, 34 "shipToCustomer": { 35 "name": "John Smith", 36 "name2": "Smith Enterprises", 37 "address": "456 Shipping Avenue", 38 "address2": "Floor 2", 39 "postCode": "10002", 40 "county": "New York", 41 "city": "New York City", 42 "countryCode": "US", 43 "contact": "John Smith" 44 }, 45 "shipment": { 46 "shipmentMethod": "", 47 "shipmentService": "" 48 }, 49 "payments": [ 50 { 51 "id": "3c4543d0-d43e-f011-a8fe-b571460f09c4", 52 "paymentMethodType": "paymentGateway", 53 "externalPaymentMethodCode": "adyen_cc", 54 "externalPaymentType": "mc", 55 "paymentReference": "Z3ZR6HT5BNVPZQT5", 56 "paymentAmount": 2000, 57 "parToken": "", 58 "pspToken": "", 59 "cardBrand": "", 60 "maskedCardNumber": "", 61 "cardExpiryDate": "", 62 "cardAliasToken": "", 63 "capturedPaymentAmount": 0, 64 "customFields": { 65 "myCustomField1": "myCustomField1Value", 66 "myCustomField2": "myCustomField2Value" 67 } 68 }, 69 { 70 "id": "be02c86c-44fb-4c59-8dd2-84bfa136be93", 71 "paymentMethodType": "voucher", 72 "externalPaymentMethodCode": "", 73 "externalPaymentType": "", 74 "paymentReference": "2807000107658", 75 "paymentAmount": 500, 76 "parToken": "", 77 "pspToken": "", 78 "cardBrand": "", 79 "maskedCardNumber": "", 80 "cardExpiryDate": "", 81 "cardAliasToken": "", 82 "capturedPaymentAmount": 0, 83 "customFields": { 84 "myCustomField1": "myCustomField1Value", 85 "myCustomField2": "myCustomField2Value" 86 } 87 } 88 ], 89 "comments": [ 90 { 91 "id": "59a2cbc4-503d-f011-a8fe-b571460f09c4", 92 "comment": "This is a comment." 93 } 94 ], 95 "salesDocumentLines": [ 96 { 97 "id": "241e349d-2a3e-f011-a8fe-b571460f09c4", 98 "type": "item", 99 "no": "1100", 100 "variantCode": "", 101 "barcodeNo": "", 102 "description": "test item", 103 "unitPrice": 2000, 104 "quantity": 2, 105 "unitOfMeasure": "", 106 "vatPercent": 25, 107 "lineAmount": 2000, 108 "requestedDeliveryDate": "2025-06-01", 109 "invoicedQuantity": 0, 110 "invoicedAmount": 0, 111 "captured": true, 112 "virtualItemProcessStatus": "processed", 113 "virtualItemProcessErrorMessage": "", 114 "customFields": { 115 "myCustomField1": "myCustomField1Value", 116 "myCustomField2": "myCustomField2Value" 117 } 118 } 119 ], 120 "customFields": { 121 "myCustomField1": "myCustomField1Value", 122 "myCustomField2": "myCustomField2Value" 123 } 124 }

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.

documentIdUUIDRequired

Response

This endpoint returns an object.

externalNostring

idUUID

documentTypeenum

Allowed values:

creationStatusenum

Allowed values:

postingStatusenum

Allowed values:

currencyCodestring

currencyExchangeRatedouble

externalDocumentNostring

locationCodestring

yourReferencestring

pricesExcludingVatboolean

captureProcessingStatusenum

Allowed values:

lastCaptureErrorMessagestring

sellToCustomerobject

shipToCustomerobject

shipmentobject

paymentslist of objects

commentslist of objects

salesDocumentLineslist of objects

customFieldsobject or null

This section allows you to add custom fields as key-value pairs. You can handle these fields by subscribing to our extension publishers and implementing custom serialization logic.

Authentication

Path parameters

Headers

Response