Skip to main content
This is the right section for you if you are acting as a warehouse or fulfilment provider and want to tell your customers about changes to their stock. Examples are stock adjustments, transfers between storage locations, and the consumption or output of a work order. Throughout this guide you will learn how to send stock movements to the Procuros API. PHP examples are included but you will likely also want to look at the relevant API calls in the API reference.

Process

These are usually the steps taken when sending a stock movement to Procuros:
  1. Check, if this document should be sent via Procuros (see: Enabled Trade Partners)
  2. Verify this document has not already been sent (see: Tracking Document Status)
  3. Build the transaction payload to be sent via Procuros.
  4. Send the transaction payload via the Procuros API

Authentication

You will need an API token to authenticate. We use a bearer token which has to be included in each request you send to the API. Please read the Authentication section of our API reference for a detailed description.

Error Handling

The API will return a 2xx status code for successful requests. Anything else indicates an error. Please read the Errors section of our API reference for a detailed description plus examples of how to handle them.

Send stock movements

The API call Send transaction is used to create transactions, including stock movements. The following fields are required:
  • type (Transaction type. In this case STOCK_MOVEMENT)
  • content.header.stockMovementIdentifier
  • content.header.stockMovementDate
  • content.header.goodsOwner or content.header.technicalRecipient, with at least one identifier
All other fields are optional. Your trade partner can require more fields. Procuros sends the stock movement to the technicalRecipient. If you do not set a technicalRecipient, Procuros sends it to the goodsOwner. Each entry in items is one movement. Use these fields to describe it:
  • type: the business reason of the movement, for example ADJUSTMENT or TRANSFER.
  • action: the effect on the stock, for example DECREMENT or MOVE.
  • fromLocation and toLocation: the storage locations the goods leave and go to.
  • sourceDocumentType, sourceDocumentIdentifier and sourceDocumentLineIdentifier: the document that caused the movement, for example a WORK_ORDER.
All details can be found in the STOCK_MOVEMENT schema as described in the API reference. An example request would look like:

Mark Document Status

Finally, as per the instructions mentioned under Tracking Document Status you must now track the status of the document locally, based on the returned HTTP response. The document should be marked with either status TRANSMITTED or NO_ACTION. If there is an error with the document and it is not accepted, do not mark it with a status so it may be retried. For more information on retrying failed documents, please see: Retrying Documents. For example: