Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fullfillment

Update goods' details

patch
/fulfillment/{countrycode}/goods/{objectId}

This endpoint allows modifying details of an existing goods. Only the fields that need to be changed should be included in the request body (partial update), for example updating the name, price, or shelf life of a product.

🔸All fields are optional, but at least one field must be provided to perform an update. On success, the API returns the updated goods fields.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the goods are registered.

Example: pl
objectIdstringRequired

Unique identifier of the goods to be updated.

Example: 1b34e39f-5805-4510-94ca-1d88ea14739a
Body

Request body for updating goods. Only the fields that need to be changed should be provided. At least one field must be present.

goodsUnitNamestring · min: 2 · max: 255Optional

Product name.

goodsUnitFullNamestring · min: 2 · max: 255Optional

Full product name.

pricenumber · float · min: 0.01 · max: 1000000Optional

Price per unit of the product.

inventExpireDaysinteger · min: 1 · max: 15000 · nullableOptional

Shelf life in days or null if not applicable.

Responses
201

Request successful. Goods details were updated.

application/json
goodsUnitNamestringOptional

Product name.

goodsUnitFullNamestringOptional

Full product name.

pricenumber · floatOptional

Price per unit of the product.

inventExpireDaysinteger · nullableOptional

Shelf life in days or null if not applicable.

patch
/fulfillment/{countrycode}/goods/{objectId}

Update Barcode Details

patch
/fulfillment/{countrycode}/barcodes/{objectBarcodeId}

This endpoint is used to update the parameters of an existing barcode in the system by its unique identifier.

Only the fields that need to be updated should be included in the request body.

🔸All fields are optional, but at least one field must be provided to perform the update. On success, the API returns the updated barcode object.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the barcode is registered.

Example: pl
objectBarcodeIdstringRequired

Unique identifier of the barcode to be updated.

Example: 3279cadb-daeb-4c62-a2fa-8fdb105c85a4
Body

Request body for updating barcode details. Only the fields that need to be changed should be provided. At least one field must be present.

measureUnitNamestring · enumOptional

Unit of measurement.

Example: pcsPossible values:
includesinteger · min: 1 · max: 1000000Optional

Number of units in the package.

weightnumber · float · min: 0.01 · max: 1000000Optional

Weight of the barcode package in kilograms.

lengthnumber · float · min: 0.01 · max: 1000000Optional

Package length in centimeters.

heightnumber · float · min: 0.01 · max: 1000000Optional

Package height in centimeters.

widthnumber · float · min: 0.01 · max: 1000000Optional

Package width in centimeters.

Responses
201

Barcode successfully updated.

application/json
measureUnitNamestringOptional

Unit of measurement.

includesintegerOptional

Number of units in the package.

weightnumber · floatOptional

Weight of the barcode package in kilograms.

lengthnumber · floatOptional

Package length in centimeters.

heightnumber · floatOptional

Package height in centimeters.

widthnumber · floatOptional

Package width in centimeters.

patch
/fulfillment/{countrycode}/barcodes/{objectBarcodeId}

Update Inbound Plan

patch
/fulfillment/{countrycode}/inbound-plans/{documentId}

This endpoint is used to update the parameters of an existing inbound delivery plan by its unique identifier.

The inbound plan must be in status 1 (New). Only the fields that need to be changed should be included in the request body.

🔸All fields are optional, but at least one field must be provided to perform an update. On success, the API returns the updated inbound plan object.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the inbound plan is registered.

Example: pl
documentIdstringRequired

Unique identifier of the inbound plan.

Example: 392d0fdd-0f79-4d6c-8c05-cd3bc76432bd
Body

Request body for updating an inbound plan. Only the fields that need to be changed should be provided. At least one field must be present.

destWarehousestringOptional

Destination warehouse code.

deliveryTypeinteger · enumOptional

Delivery type(1 — Supplier delivery, 3 — Nova Post return, 7 — Nova Post delivery).

Possible values:
additionalInfostring · min: 2 · max: 255Optional

Additional information or comments.

Responses
201

The inbound plan was successfully updated.

application/json
statusstringOptional

Current status of the inbound plan.

destWarehousestringOptional

Destination warehouse code.

deliveryTypeintegerOptional

Delivery type.

additionalInfostringOptional

Additional notes or comments.

patch
/fulfillment/{countrycode}/inbound-plans/{documentId}

Update Client Order Details

patch
/fulfillment/{countrycode}/orders/{documentId}

This endpoint is used to update the parameters of an existing client order that is currently in status 13 (Incomplete).

The request allows modifying general order parameters, the list of items, and if delivery is via Nova Post setting or updating the Waybill Number.

🔸All fields are optional, but at least one field must be provided to execute an update.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the order is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the client order.

Example: 7fe65529-5cd1-4333-93a8-c072aae70edc
Body

Request body for updating a client order. Only the fields that need to be changed should be provided. At least one field must be present.

destWarehousestringOptional

Code of the warehouse for dispatch.

deliveryTypeinteger · enumOptional

Delivery type (2 = Nova Post, 5 = Pickup).

Possible values:
waybilNumberstring · nullableOptional

Waybill number. Required if deliveryType = 2.

additionalInfostring · min: 2 · max: 255Optional

Additional info or comment.

Responses
201

The client order was successfully updated. The response contains the updated order object.

application/json
statusstringRequired

Status of the order (13 = Incomplete).

destWarehousestringRequired

Code of the warehouse for dispatch.

additionalInfostringOptional

Additional notes or comments.

deliveryTypeintegerRequired

Type of delivery (2 = Nova Post, 5 = Pickup).

waybilNumberstring · nullableOptional

Waybill number (required if deliveryType = 2).

patch
/fulfillment/{countrycode}/orders/{documentId}

Check Inbound Plan Status

get
/fulfillment/{countrycode}/inbound-plans/status

This endpoint is used to retrieve the statuses of one or more inbound plans.

It supports filtering via query parameters such as document IDs, external numbers, warehouse codes, and date range.

🔹If no filter parameters are provided, the response returns the most recent inbound plans.

🔸 This GET request does not return an error if incorrect, non-existent, or partially invalid filter values are used. In such cases, the system will:

  • Ignore invalid or empty filter values without returning an error.

  • Return an empty documents array if no inbound plans match the query conditions.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where inbound plans are registered.

Example: pl
Query parameters
pageintegerOptional

Page number (each page returns up to 25 records).

Example: 1
documentIds[]string · uuid[]Optional

List of inbound plan IDs.

externalNumbers[]string[]Optional

List of inbound plan external numbers.

warehouseIds[]string[]Optional

List of warehouse codes.

startDatestring · date-timeOptional

Start date of search (ISO 8601).

Example: 2025-05-05T00:00:00Z
endDatestring · date-timeOptional

End date of search (ISO 8601).

Example: 2025-05-10T00:00:00Z
Responses
201

Data retrieved successfully.

application/json
pageintegerOptional

Current page number.

pagesintegerOptional

Total number of pages.

get
/fulfillment/{countrycode}/inbound-plans/status
201

Data retrieved successfully.

Create Inbound Plan

post
/fulfillment/{countrycode}/inbound-plans

This endpoint allows creating a new inbound plan to receive goods at the specified warehouse. A plan may contain one or more goods positions.

On success, the API returns the created inbound plan with its unique identifier and initial status.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the inbound plan is created.

Example: pl
Body

Request body for creating an inbound plan. All required fields must be provided.

externalNumberstring · min: 2 · max: 72Required

Document number in the client's system.

guidstring · min: 2 · max: 72Optional

Unique document ID in the client's system.

destWarehousestring · min: 2 · max: 255Required

Destination warehouse code.

deliveryTypeinteger · enumRequired

Delivery type (1 — Supplier, 3 — Return, 7 — Nova Post).

Possible values:
additionalInfostring · min: 2 · max: 255Optional

Additional information or comment.

Responses
201

Request successful. Inbound plan was created.

application/json
documentIdstringRequired

Unique identifier of the inbound plan.

statusstringRequired

Current status of the inbound plan.

externalNumberstringRequired

External number of the inbound plan.

guidstringRequired

GUID reference for the plan.

destWarehousestringRequired

Destination warehouse.

deliveryTypeintegerRequired

Delivery type.

additionalInfostringOptional

Additional comment or description.

post
/fulfillment/{countrycode}/inbound-plans

Cancel Inbound Plan

patch
/fulfillment/{countrycode}/inbound-plans/{documentId}/cancel

This endpoint cancels an existing inbound plan that is currently in status 1 (New).

Once canceled, the inbound plan transitions to status 10 (Canceled) and is excluded from any further processing.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the inbound plan is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the inbound plan.

Example: e52937bd-bdbc-499c-bbf8-2cbfeab51ee5
Responses
patch
/fulfillment/{countrycode}/inbound-plans/{documentId}/cancel

Create Goods

post
/fulfillment/{countrycode}/goods/multiple

This endpoint is used to create a goods record that can be added to an Inbound Plan or an Order.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code for which the goods are being created.

Example: pl
Body
Responses
201

Request successful. Goods were created.

application/json
post
/fulfillment/{countrycode}/goods/multiple

Create Barcode

post
/fulfillment/{countrycode}/goods/{objectId}/barcodes/multiple

This endpoint is used to create one or more barcodes associated with a specific good. The barcode data is provided as an array, allowing multiple barcodes to be created in a single request.

On success, the API returns all created barcodes with their unique identifiers and the parameters specified in the request.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the goods are registered.

Example: pl
objectIdstringRequired

Unique identifier of the goods for which barcodes are created.

Example: 7c5438ad-0ee6-11f0-9f10-42010adefd36
Body
Responses
201

Barcode(s) successfully created.

application/json
post
/fulfillment/{countrycode}/goods/{objectId}/barcodes/multiple

Add Goods to Inbound Plan

post
/fulfillment/{countrycode}/inbound-plans/{documentId}/details

This endpoint allows adding one or more goods items to an already created inbound plan that is in status 1 (New).

The operation expands the list of goods within the existing inbound plan without creating a new document.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the inbound plan is registered.

Example: pl
documentIdstringRequired

Unique identifier of the inbound plan.

Example: e52937bd-bdbc-499c-bbf8-2cbfeab51ee5
Body

Request body for adding goods to an existing inbound plan. The details array must contain at least one product item.

Responses
201

The inbound plan was successfully updated.

application/json
post
/fulfillment/{countrycode}/inbound-plans/{documentId}/details

Delete Goods from Inbound Plan

post
/fulfillment/{countrycode}/inbound-plans/{documentId}/details/multiple-delete

This endpoint allows deleting one or more goods from an existing inbound plan that is in status 1 (New).

The operation removes specified product items from the inbound plan without deleting the plan itself.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the inbound plan is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the inbound plan.

Example: e52937bd-bdbc-499c-bbf8-2cbfeab51ee5
Body

Request body for deleting goods from an inbound plan. The details array must contain at least one product item.

Responses
201

The inbound plan was successfully updated.

application/json
post
/fulfillment/{countrycode}/inbound-plans/{documentId}/details/multiple-delete

Create Order

post
/fulfillment/{countrycode}/orders

This endpoint is used to create a new customer order for shipping goods from the warehouse.

Two delivery scenarios are supported:

  • Nova Post delivery — an international express waybill number must be specified, which the client generates beforehand.

  • Customer pickup — the order is created without specifying an international express waybill.

If the request is properly formed and all requirements are met, the order is created with one of the following statuses:

  • 1 (New) — when all products are available in stock

  • 13 (Incomplete) — when some products are partially unavailable

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the order is created.

Example: pl
Body

Request body for creating a customer order. All required fields must be provided.

externalNumberstring · min: 2 · max: 72Required

Customer's internal order number.

destWarehousestring · min: 2 · max: 255Required

Warehouse code.

deliveryTypeinteger · enumRequired

Delivery type(2 — Nova Post, 5 — Customer pickup).

Possible values:
waybilNumberstringOptional

International express waybill number.

additionalInfostring · min: 2 · max: 255Optional

Additional information or comment.

Responses
201

Request successful. Returns the full order object with documentId and initial status.

application/json
documentIdstringRequired

Unique identifier of the customer order.

statusstringRequired

Status of the order.

externalNumberstringRequired

Customer's order number.

destWarehousestringRequired

Warehouse code.

additionalInfostringOptional

Additional notes or comments.

deliveryTypeintegerRequired

Delivery type.

waybilNumberstring · nullableOptional

Waybill number.

post
/fulfillment/{countrycode}/orders

Get Order Details

get
/fulfillment/{countrycode}/orders/{documentId}/details

This endpoint is used to retrieve detailed information about a specific client order by its documentId.

The response returns the full breakdown of ordered items, including planned and actual quantities, product condition, and serial numbers (if applicable).

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the order is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the client order.

Example: 22be2de9-47ae-4438-9cec-d55a0d4bd387
Responses
201

Data successfully retrieved. The response returns the full breakdown of the order.

application/json
documentIdstring · uuidRequired

Unique identifier of the order.

externalNumberstringRequired

External (client-side) order number.

get
/fulfillment/{countrycode}/orders/{documentId}/details

Add Goods to Client Order

post
/fulfillment/{countrycode}/orders/{documentId}/details

This endpoint is used to add new goods to an existing client order that is currently in status 13 (Incomplete).

If the added goods are available in sufficient quantity, the order status is automatically changed to 1 (New).

This allows editing an existing order and resuming its processing without creating a new document.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the order is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the client order.

Example: e2d29580-457f-4562-88bf-b5e28aea9f88
Body

Request body for adding goods to an existing client order. At least one product item must be provided.

Responses
201

Order details updated.

application/json
documentIdstringRequired

Unique identifier of the customer order.

statusintegerRequired

Current status of the order (13 = Incomplete).

post
/fulfillment/{countrycode}/orders/{documentId}/details

Check Order Status

get
/fulfillment/{countrycode}/orders/status

This endpoint is used to retrieve information about the statuses of one or more client orders, with optional filtering parameters.

🔹If no filter parameters are provided, the response returns the most recent client orders.

🔸This GET request does not return an error when incorrect, non-existent, or partially invalid filter values are used. In such cases, invalid or empty filters are ignored and an empty array is returned if no orders match the criteria.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the orders are registered.

Example: pl
Query parameters
pageintegerOptional

Page number (each page includes up to 25 objects).

Example: 1
documentIdsstring · uuid[]Optional

List of order identifiers.

externalNumbersstring[]Optional

List of client order numbers.

warehouseIdsstring[]Optional

List of warehouse codes.

startDatestring · date-timeOptional

Start date in ISO 8601 format.

Example: 2025-05-05T00:00:00Z
endDatestring · date-timeOptional

End date in ISO 8601 format.

Example: 2025-05-05T23:59:59Z
Responses
201

Request successful. Returns an array of client orders that match the filtering criteria.

application/json
pageintegerRequired

Current page number.

pagesintegerRequired

Total number of pages.

get
/fulfillment/{countrycode}/orders/status
201

Request successful. Returns an array of client orders that match the filtering criteria.

Cancel Client Order

patch
/fulfillment/{countrycode}/orders/{documentId}/cancel

This endpoint is used to cancel a previously created client order that is currently in status 13 (Incomplete).

Once canceled, the order transitions to status 10 (Canceled) and is excluded from any further processing.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the client order is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the client order.

Example: 7fe65529-5cd1-4333-93a8-c072aae70edc
Responses
201

The client order was successfully canceled. Returns the documentId and new status ("10") of the canceled order.

application/json
documentIdstringRequired

Unique identifier of the client order.

statusinteger · enumRequired

Current status of the order.

Possible values:
patch
/fulfillment/{countrycode}/orders/{documentId}/cancel

Delete Goods from Client Order

post
/fulfillment/{countrycode}/orders/{documentId}/details/multiple-delete

This endpoint is used to delete one or more product items from a client order that is currently in status 13 (Incomplete).

If an item with insufficient stock is removed from such an order, the order status is automatically changed to 1 (New). This allows updating the order and sending it for processing without creating a new document.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the order is registered.

Example: pl
documentIdstring · uuidRequired

Unique identifier of the client order.

Example: 7921dccd-9004-472e-a410-c9573a5edadd
Body

Request body for deleting goods from a client order. At least one item must be provided.

Responses
201

The client order was successfully updated. Returns the updated order status.

application/json
documentIdstringRequired

Unique identifier of the client order.

statusintegerRequired

Current status of the order.

post
/fulfillment/{countrycode}/orders/{documentId}/details/multiple-delete

Check Stock Remains

get
/fulfillment/{countrycode}/stock-remains

This endpoint is used to retrieve information on current stock remains of goods in the fulfillment warehouse(s).

It allows the client to check how many units of each goods are:

  • stored in stock,

  • reserved in active orders,

  • available for new orders.

Filters can be applied by product, warehouse, condition, or date. If no filters are provided, all stock remains for the client’s goods across all warehouses are returned.

Invalid or unknown filter values are ignored and do not cause errors.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; overflow text is hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values demonstrating a valid response.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
countrycodestringRequired

Country code where the fulfillment warehouses are located.

Example: pl
Query parameters
pageintegerOptional

Page number (each page returns up to 25 records).

Example: 1
objectIds[]string · uuid[]Optional

List of goods IDs (UUID) to filter by.

objectArts[]string[]Optional

List of product article numbers (SKUs) to filter by.

objectTitle[]string[]Optional

List of product names to filter by.

warehouseIds[]string[]Optional

Warehouse codes to filter by. If empty, all warehouses are included.

remainDatestring · date-timeOptional

Date up to which to consider all receipts. Stock is calculated as of this date/time. Format: YYYY-MM-DD or full ISO 8601 timestamp.

Example: 2025-05-05T00:00:00Z
conditionstring · enumOptional

Filter by stock condition:

  • 0 — good (saleable),
  • 1 — damaged (unsaleable). If omitted, all conditions are included.
Possible values:
Responses
201

Data retrieved successfully. Returns current stock remains per goods and warehouse.

application/json
pageintegerOptional

Current page number.

pagesintegerOptional

Total number of pages.

get
/fulfillment/{countrycode}/stock-remains
PreviousWebhooksNextPayment for services and goods

Last updated