Customer stickers
Supported customer sticker scenarios
- Receive customer sticker meta data;
- Receive customer stickers in PDF;
- Indicate which stickers are printed and placed.
For the business rules concerning stickers, please read Customer stickers.
Implementation requirements
If the following steps are implemented and validated by an implementation consultant, it's considered to be a correct implementation in the Implementation overview, visualised as a green checkmark.
| Workflow | Required endpoints | |
|---|---|---|
| 1 | Enable supplier organizations to receive customer sticker data of sales orders placed by customer organizations. | Receiving customer sticker data |
| 2 | Enable supplier organizations to receive customer sticker files in PDF, based on stickerId. | Receive customer sticker files |
| 3 | Enable supplier organizations to indicate which stickers have already been handled. The isHandled status signals to customer organizations that the sticker has been printed and placed and should therefore not be modified. When implementing the SetCustomerStickersIsHandled endpoint, you may choose to let the supplier set the isHandled status manually or to automatically set the isHandled status when stickers are printed. In either case, we recommend to add a feature to remove the isHandled status as well. If a grower is somehow unable to place the stickers, the customer organization will want to know. | Indicate which stickers are handled |
Why isHandled?
Stickers that are set to isHandled lead to a more efficient logistic and financial process for customer organizations. Customer organizations that know that stickers have been placed, will not have to schedule self-placement or invoicing of stickers afterwards. It also removes the necessity of having to directly contact the supplier organization about the status.
Receive customer sticker data
Purpose:
Receive instructions and order references for the received customer stickers.
Important note when syncing sticker data
A supplier may retrieve a sticker PDF with the GetCustomerStickerPdfById & GetCustomerStickerPdfByIds API Calls. When this happens, the
lastRequestedOnproperty is updated on the customer side. This allows the customer to see when stickers have been requested by the supplier.Even though the property is only updated on the customer side, a sequence bump on the supplier side is also triggered. Although this usually indicates an update, if you keep requesting the sticker data when this sequence bump is triggered, you will end up in an infinite loop.
This is why we recommend to only request the sticker data once when:
- The supplier actually needs the sticker data or;
- The sticker object is new / contains
stickerFileInformationfor the first time.
Process steps:
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Returns the maximum sequence number found in customerStickers. | GetCustomerStickersMaxSequence |
| 2 | Returns a list of max 1000 customers starting from a specified sequence number. | GetCustomerStickersBySequenceNumber |
Receive customer sticker files
Purpose:
Receive customer sticker files in PDF format.
Process steps:
| NR | Process step | API call / scenario |
|---|---|---|
| 1 A | Returns customer stickers in pdf format. | GetCustomerStickerPdfByIds |
| 1 B | Returns the customer sticker in pdf format by ID. | GetCustomerStickerPdfById |
Indicate which stickers are handled
Purpose:
Indicate to customer which stickers are handled.
Process steps:
| NR | Process step | API call / scenario |
|---|---|---|
| 1 | Indicate which stickers are handled. | SetCustomerStickersIsHandled |
Updated 10 days ago