Create Sale Line Addon | NaviPartner | NP Retail API Documentation

curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./pos/sale/0d200aa6-aacd-4b78-b673-c4fb7461f5ea/saleline/9519f75d-4b4f-5c73-b560-b95de7ff0174/addon \
     -H "x-np-api-key: <NaviPartner API Key>" \
     -H "Content-Type: application/json" \
     -d '{
  "parentLineId": "8408f65c-3a3f-4a62-a459-a94fd6ff9063",
  "addonNo": "ADDON001",
  "addonLineNo": 1,
  "quantity": 2
}'

{
  "saleId": "bcc8ec51-906b-4a57-9680-1d120dd55b01",
  "receiptNo": "12345678",
  "posUnit": "QR_FOOD_APP",
  "posStore": "STORE01",
  "date": "2024-01-01",
  "startTime": "2024-01-01T17:00:00Z",
  "customerNo": "C12345",
  "salespersonCode": "SP001",
  "vatBusinessPostingGroup": "DOMESTIC",
  "refreshedSaleLines": [
    {
      "id": "8408f65c-3a3f-4a62-a459-a94fd6ff9063",
      "sortKey": 10000,
      "type": "Item",
      "code": "ITEM-001",
      "variantCode": "",
      "description": "Premium Widget",
      "quantity": 2,
      "unitPrice": 50,
      "discountPct": 0,
      "discountAmount": 0,
      "vatPercent": 25,
      "amountInclVat": 125,
      "amount": 100,
      "unitOfMeasure": "PCS",
      "isAddon": false
    }
  ],
  "refreshedPaymentLines": [],
  "deletedSaleLines": [],
  "deletedPaymentLines": [],
  "totalSalesAmountInclVat": 125,
  "totalPaymentAmount": 0
}

Creates an addon line for an existing sale line. The API consumer must provide a unique GUID for the addon line ID. Use this endpoint when you need to add addons after the parent line has been created. Returns the saleId and a refresh object with SystemIds of updated entities and totals.

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.

saleIdUUIDRequired

The id of a POS sale. This can be provided by the API consumer when creating a new sale.

addonLineIdUUIDRequired

The unique GUID for this new addon line

Request

This endpoint expects an object.

parentLineIdUUIDRequired

The SystemId of the parent sale line this addon applies to

addonNostringRequired

The addon configuration number

addonLineNointegerRequired

The specific line within the addon configuration

quantitydoubleOptional

Quantity of the addon (defaults to 1)

selectedOptionLineNointegerOptional

For Select-type addons, the selected option line number

Response

This endpoint returns an object.

saleIdUUID

The id of a POS sale. This can be provided by the API consumer when creating a new sale.

receiptNostring

posUnitstring

posStorestring

datedate

startTimedatetime

customerNostring

salespersonCodestring

vatBusinessPostingGroupstring

refreshedSaleLineslist of objects

Full objects for all sale lines that were created or modified

refreshedPaymentLineslist of objects

Full objects for all payment lines that were created or modified

deletedSaleLineslist of strings

Array of SystemIds (UUIDs) for sale lines that were deleted

deletedPaymentLineslist of strings

Array of SystemIds (UUIDs) for payment lines that were deleted

totalSalesAmountInclVatdouble

Total amount of all sale lines including VAT

totalPaymentAmountdouble

Total amount of all payment lines

Authentication

Path parameters

Headers

Request

Response