pos > possale

Restores a previously parked sale (Saved Sale Entry) to an active POS Sale on the POS unit assigned to the API user in User Setup. The Saved Sale Entry is deleted. Ticket identity is preserved across the park/resume round-trip. To resume the sale on a different unit, assign a different POS Unit to the API user in User Setup. Returns 404 if the parked sale does not exist. Returns 400 when: the API user has no User Setup record; the API user has no POS Unit assigned in User Setup; the resolved POS Unit is not open for sales; or loading the saved sale data fails (the active POS Sale is rolled back).

post/{tenant}/{environment}/{company}/pos/sale/{saleId}/resume

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

saleIdstring uuid required

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

Headers

x-api-versionstring date

Used for API versioning. More details.

Response

Response with status 201

saleIdstring uuid required

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

receiptNostring required
posUnitstring required
posStorestring required
datestring date required
startTimestring date-time required
customerNostring required
salespersonCodestring required
vatBusinessPostingGroupstring required
genBusinessPostingGroupstring required
totalSalesAmountInclVatnumber double

Total amount of all sale lines including VAT (only present when withLines=true)

totalPaymentAmountnumber double

Total amount of all payment lines (only present when withLines=true)

Changes

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      for the path request parameter saleId, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      api operation id resume-pos-sale removed and replaced with pos_possale_resumePOSSale