Fulfillment REST API Change Summary
1. Integration Update Recommendations (Mandatory Adaptation)
As the implemented changes update the API contract specifications, clients must update their integration solutions according to the changes described below to ensure stable operation.
Please note: these changes are not backward compatible.
Order endpoint restructuring: Single order creation via
/ordershas been removed. Batch order creation via/orders/multiplehas been added.Identifier standardization (id / ids): A global identifier standardization has been implemented. The API no longer uses prefixed identifiers (
documentId,objectBarcodeId,documentIds,warehouseIds). Instead, the unifiedidis used for individual objects and path parameters, whileidsanddestWarehousesare used for arrays/lists and warehouse identifiers.Delivery type mapping changes (Delivery Type Enums): In all order endpoints,
1now represents Nova Post Shipment, and2represents Pickup. Code2has changed its business meaning (it now represents Pickup instead of Nova Post Shipment), and the previous code5is no longer supported.Typographical error fix: The parameter name has been corrected from
waybilNumbertowaybillNumber(with two l characters).Migration to warehouse business codes:
destWarehouseshas been introduced instead ofwarehouseIds. It accepts warehouse business codes as strings (for example,"Boyarka").Status field data type change in responses: In the order status endpoint, the
statusfield type has been changed fromstringtointeger(returns the status ID).Goods barcode creation: Units of measurement are no longer required when generating or creating a goods barcode.
2. Functional Logic Changes (Stock Remains)
Barcode independence: Product information is returned regardless of whether a product has a barcode.
Differentiated stock remains logic: Without product-specific filters (
ids,objectArts,objectTitles), the system returns only products with actual stock available (> 0). When product-specific filters are provided, the requested products are returned regardless of whether their stock quantities are zero.
3. Validation and Data Normalization Updates
Automatic normalization (Trimming): All incoming string values are trimmed of leading and trailing whitespace, and empty strings are converted to
null.Strict JSON payload validation: If a request body contains additional or undocumented properties, the system returns 422 Unprocessable Entity.
Data consistency: GUID uniqueness is validated within a single request. Conditional field requirements have been introduced (for example,
quantityis required whenobjectIdis provided).
4. Changes to JSON Payload and Query Parameter Formats
Root-level Array: Arrays for batch operations must be passed directly as a root-level array (
[...]) without an enclosing object.Query parameters in GET requests: Comma-separated array values are no longer supported in GET requests. Array parameters must be specified by repeating the parameter name, for example:
?ids[]=val1&ids[]=val2.
Last updated