Home
GuidesChangelog
HomeLog In
Guides
These docs are for v2023.1. Click to read the latest docs for v2024.2.

Batches

Suggest Edits

Supported scenarios

  • Get batches;
  • Create Batches;
  • Update Batches.

For the business rules concerning batches, please read Batches.


Get Batches

Purpose:
Get Batches with an available quantity from Floriday in supplier application.

Prerequisites:

  • The supplier application has the latest update of organizations;
  • The supplier application has the latest update of warehouses;
  • The supplier application has the latest update of trade-items;
  • The user has inserted or changed its current batch available quantity for a period on a warehouse in Floriday.

Process steps:

NRProcess stepAPI call / scenario
Get max sequence number found in Batches.GetBatchesMaxSequence
1AGet changed batch since last sequence number. Repeat step until all batches are synchronised.GetBatchesBySequenceNumber
1BGet batches based on trade-items with an available quantity, a packingconfiguration on a warehouse location.GetBatches
1CGet a batch by batchID based on a trade-item with an available quantity, a packingconfiguration on a warehouse location.GetBatchById
2The retrieved batches are processed in the supplier application.
3 (optional)A batch photo is retrieved.Get photo by URL
4 (optional)The retrieved batch photos are processed in the supplier application.


Create Batches

Purpose:
Create a Batch with an available quantity in Floriday.

Prerequisites:

  • The supplier application has the latest update of warehouses.
  • The user has inserted trade items in the Floriday catalog.
  • The user has created batches in the supplier application.

Process steps:

NRProcess stepAPI call / scenario
1 (optional)Create a batch image and get mediaId + Floriday URLAddImage
2Create a new batch of a trade item with an unique batchId tradeItemId and batch details including one optional batch imageURL.AddBatch
The batch is created in Floriday.


Update Batches

Purpose:
Update (correct) a Batch with an available quantity in Floriday.

Prerequisites:

  • The supplier application has the latest update of warehouses.
  • The supplier application has the latest update of trade items.
  • The user has inserted and changed its current batch available quantity for trade-items on a warehouse location in the supplier application.

Process steps:

NRProcess stepAPI call / [scenario]
1Update available quantity of a batch.EditBatch
The batch quantity is updated in Floriday.

Updated almost 2 years ago