Skip to main content

Document Imports

For more detail on the Universal import, see Universal Import

Document import methods​

New Import​

Imports a BOM into a new conception of a Retail Ops Document.

Method​

POST/api/externals/v1/import/document/{documentTypeID}/{documentID}

Arguments​

  • documentTypeID (long): (provided in the path): ID of the Document type of the Document in which to do the import
  • documentID (long): (provided in the path): ID of the Document in which to do the import
  • connectionID (long): ConnectionID of the front that need to be informed of the import status
  • configurationSessionID (long): Current configuration session ID

Body​

BOM to be imported (cf. Universal BOM Format).

Response​

{
  "success": boolean,
  "message": string,
  "conceptionID": int
}

Update​

Updates an existing conception with the provided BOM.
Updating a conception replaces all the document lines of the conception with those provided in the new BOM.
We try to keep discounts by linking the old lines with the new ones using plannerUniqueID.

Method​

PUT/api/externals/v1/import/document/{documentTypeID}/{documentID}/{conceptionID}

Arguments​

  • documentTypeID (long): (provided in the path): ID of the Document type of the Document in which to do the import
  • documentID (long): (provided in the path): ID of the Document in which to do the import
  • conceptionID (long): (provided in the path): ID of the Document conception that will be updated by the import
  • connectionID (long): ConnectionID of the front that need to be informed of the import status
  • configurationSessionID (long): Current configuration session ID

Body​

BOM to be imported (cf. Universal BOM Format).

Response​

{
  "success": boolean,
  "message": string,
}