Skip to main content

Warehouses API

List Warehouses

GET /api/v1/manager-core/warehouses

Get all warehouses.


Create Warehouse

POST /api/v1/manager-core/warehouses

Request Body:

ParameterTypeRequiredValidation
namestringYesmax:255, min:1, unique:warehouses,name
typeintegerYesin:1,2,3
company_idstringYesmax:255, min:1
country_idstringYesmax:255, min:1

Get Warehouse

GET /api/v1/manager-core/warehouses/{id}

Update Warehouse

PUT /api/v1/manager-core/warehouses/{id}

Request Body:

ParameterTypeRequiredValidation
namestringYesmax:255, min:1
country_idstringYesmax:255, min:1
typeintegerNoin:1,2,3
shopobjectNoarray

Delete Warehouse

DELETE /api/v1/manager-core/warehouses/{id}

Parameters:

  • id (path) - Warehouse ID

Warehouse Map

Get Map

GET /api/v1/manager-core/warehouses/{id}/map

Parameters:

  • id (path) - Warehouse ID

Save Map

POST /api/v1/manager-core/warehouses/{id}/map

Parameters:

  • id (path) - Warehouse ID

Request Body:

ParameterTypeRequiredValidation
layoutobjectYesMap layout data

Set Slot Size

POST /api/v1/manager-core/warehouses/map/slot-size

Request Body:

ParameterTypeRequiredValidation
widthnumberYesSlot width
heightnumberYesSlot height

Get Row

GET /api/v1/manager-core/warehouses/{id}/map/row/{rowId}

Parameters:

  • id (path) - Warehouse ID
  • rowId (path) - Row ID

Unallocated Inventory

GET /api/v1/manager-core/warehouses/{id}/map/unallocated-inventory

Parameters:

  • id (path) - Warehouse ID

Warehouse Barcode

GET /api/v1/manager-core/warehouses/barcode/{warehouse}

Parameters:

  • warehouse (path) - Warehouse ID

Warehouse Stock Export

GET /api/v1/manager-core/warehouses/stock/{warehouse}/{currency}/{products}-{materials}/xlsx

Parameters:

  • warehouse (path) - Warehouse ID
  • currency (path) - Currency code
  • products (path) - Include products (0 or 1)
  • materials (path) - Include materials (0 or 1)

Income Management

List Incomes

GET /api/v1/manager-core/warehouses/income

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerNoexists:warehouses,id
warehouse_fromintegerNoexists:warehouses,id
fromdateNo-
todateNo-
typearrayNo-
partnersarrayNo-
categoriesarrayNo-
statusarrayNo-
characteristicsarrayNo-

List Manual Incomes

GET /api/v1/manager-core/warehouses/income/manual

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerNoexists:warehouses,id
fromdateNo-
todateNo-
typearrayNo-
partnersarrayNo-
categoriesarrayNo-
statusarrayNo-
characteristicsarrayNo-

Search Income

POST /api/v1/manager-core/warehouses/income/search

Request Body:

ParameterTypeRequiredValidation
typestringYes-
statusstringYes-
warehouse_idintegerNo-
warehouse_outcome_idintegerNo-
partner_idintegerNo-
outgoing_idintegerNo-

Get Income Details

GET /api/v1/manager-core/warehouses/income/{id}

Parameters:

  • id (path) - Income ID

Query Parameters:

ParameterTypeRequiredValidation
orderobjectNoSorting order

Add Income

POST /api/v1/manager-core/warehouses/income

Request Body:

ParameterTypeRequiredValidation
warehouse_idintegerYesexists:warehouses,id
typeintegerYesin:2,4,5,6,9
partner_idintegerConditional*exists:crm_items,id (*required_if:type,2 or 5)
warehouse_outgoing_idintegerConditional*exists:warehouses,id (*required_if:type,6)
income_idintegerNoexists:warehouse_operations,id
multiple_deliverybooleanNo-
itemsarrayYesarray, min:1
items.*.idintegerYesexists:product_variants,id
items.*.quantitynumberYesnumeric, gt:0
items.*.descriptionstringNo-
items.*.slot_numberstringNo-
items.*.problem_category_idintegerNo-

Set Item to Packaging

POST /api/v1/manager-core/warehouses/income/{id}/packaging

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id
quantityintegerNomin:1, max:200, gte:0
slot_numberstringNo-

Close Item

POST /api/v1/manager-core/warehouses/income/{id}/close

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id

Collect All

POST /api/v1/manager-core/warehouses/income/{id}/collect-all

Cancel Income

POST /api/v1/manager-core/warehouses/income/cancel

Request Body:

ParameterTypeRequiredValidation
rowsarrayYesArray of income row IDs

Delete Income

DELETE /api/v1/manager-core/warehouses/income

Request Body:

ParameterTypeRequiredValidation
rowsarrayYesArray of income row IDs

Delete Income Items

DELETE /api/v1/manager-core/warehouses/income/{id}

Parameters:

  • id (path) - Income ID

Request Body:

ParameterTypeRequiredValidation
rowsarrayYesArray of item IDs

Income Export

GET /api/v1/manager-core/warehouses/income/{id}/export/{exportType}
GET /api/v1/manager-core/warehouses/income/export/{exportType}
GET /api/v1/manager-core/warehouses/income/manual/export/{exportType}

Parameters:

  • exportType (path) - Export format: xlsx, xls, ods, pdf, csv

Outgoing Management

List Outgoing

GET /api/v1/manager-core/warehouses/outgoing

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerNoexists:warehouses,id
warehouse_tointegerNoexists:warehouses,id
fromdateNo-
todateNo-
typearrayNo-
partnersarrayNo-
categoriesarrayNo-
statusarrayNo-
characteristicsarrayNo-

Get Outgoing Details

GET /api/v1/manager-core/warehouses/outgoing/{id}

Parameters:

  • id (path) - Outgoing ID

Add Outgoing

POST /api/v1/manager-core/warehouses/outgoing

Request Body:

ParameterTypeRequiredValidation
warehouse_idintegerYesexists:warehouses,id
typeintegerYesin:1,3,4,7,8
warehouse_income_idintegerConditional*exists:warehouses,id (*required_if:type,1)
partner_idintegerConditional*exists:crm_items,id (*required_if:type,3)
itemsarrayYesarray, min:1
items.*.idintegerYesexists:product_variants,id
items.*.quantitynumberYesnumeric, gt:0
items.*.descriptionstringNo-
items.*.slot_numberstringNo-
items.*.problem_category_idintegerNo-

Add Outgoing Item

POST /api/v1/manager-core/warehouses/outgoing/add-items

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:warehouse_operations,id
itemsarrayYesarray, min:1
items.*.idintegerYesexists:product_variants,id
items.*.quantitynumberYesnumeric, gt:0
items.*.descriptionstringNo-
items.*.slot_numberstringNo-
items.*.problem_category_idintegerNo-

Update Outgoing

POST /api/v1/manager-core/warehouses/outgoing/{id}

Request Body:

ParameterTypeRequiredValidation
pretty_idstringNo-
titlestringNo-
delivery_pricenumberNo-
delivery_price_currencystringNo-

Change Quantity

POST /api/v1/manager-core/warehouses/outgoing/{id}/quantity

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id
quantitynumberYesnumeric, gt:0

Change Price

POST /api/v1/manager-core/warehouses/outgoing/{id}/price

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id
amountnumberYesnumeric, gt:0
currencystringYesexists:currencies,code

Change Deadline

POST /api/v1/manager-core/warehouses/outgoing/{id}/deadline

Request Body:

ParameterTypeRequiredValidation
itemintegerNoexists:items,id
deadline_datestringYesmin:5, max:40

Change Partner

POST /api/v1/manager-core/warehouses/outgoing/{id}/partner

Request Body:

ParameterTypeRequiredValidation
partnerintegerYesexists:crm_items,id

Set to Package

POST /api/v1/manager-core/warehouses/outgoing/{id}/packaging

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id
quantityintegerNomin:1, max:200, gte:0

Generate Invoice

POST /api/v1/manager-core/warehouses/outgoing/{id}/invoice

Request Body:

ParameterTypeRequiredValidation
payment_methodintegerNo-
currencystringNo-

Add Delivery Code

POST /api/v1/manager-core/warehouses/outgoing/{id}/delivery

Request Body:

ParameterTypeRequiredValidation
trackingstringNostring, min:3
methodmixedNo-
packagesintegerNomin:1
couriermixedNo-
auto_deliverybooleanNo-

Set Active

POST /api/v1/manager-core/warehouses/outgoing/{id}/active

Set Finished

POST /api/v1/manager-core/warehouses/outgoing/{id}/finish

Set Started

POST /api/v1/manager-core/warehouses/outgoing/{id}/start-production

Request Body:

ParameterTypeRequiredValidation
deadline_datestringConditional*min:6, max:40 (*required_without_all:item_id,restart)
start_datestringConditional*min:6, max:40 (*required_without_all:item_id,restart)
operation_deadline_datestringNomin:6, max:40
item_idintegerConditional*(*required_without_all:deadline_date,restart)
restartbooleanNo-
income_idsarrayNo-

Set Material Setting

POST /api/v1/manager-core/warehouses/outgoing/{id}/materials

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:product_variants,id
no_need_to_sendbooleanNo-

Outgoing Problems

List Problems

GET /api/v1/manager-core/warehouses/outgoing/problems

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerNoexists:warehouses,id
fromdateNo-
todateNo-
typearrayNo-
partnersarrayNo-
characteristicsarrayNo-
show_deletedbooleanNo-

Export Problems

GET /api/v1/manager-core/warehouses/outgoing/problems/export/{exportType}

Parameters:

  • exportType (path) - Export format: xlsx, xls, ods, pdf, csv

Inventory Shortage

GET /api/v1/manager-core/warehouses/outgoing/inventory-shortage

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerNoexists:warehouses,id

Inventory Audit

Get Audits

GET /api/v1/manager-core/warehouses/outgoing/inventory-audit

Query Parameters:

ParameterTypeRequiredValidation
warehouseintegerYesexists:warehouses,id
archivebooleanNo-

Create Audit

POST /api/v1/manager-core/warehouses/outgoing/inventory-audit

Request Body:

ParameterTypeRequiredValidation
warehouseintegerYesexists:warehouses,id
typeintegerYesin:1,2,3,4
quantitynumberConditional*gte:0 (*required_if:type,1)
categoriesarrayConditional*(*required_if:type,3)
slotsarrayConditional*(*required_if:type,4)
usersarrayNo-
planned_atstringNo-

Set Audit Item

POST /api/v1/manager-core/warehouses/outgoing/inventory-audit/{id}/set

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id
quantitynumberNo-

Finish Audit

POST /api/v1/manager-core/warehouses/outgoing/inventory-audit/{id}/finish

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:items,id

Outgoing Export

GET /api/v1/manager-core/warehouses/outgoing/{id}/export/{exportType}
GET /api/v1/manager-core/warehouses/outgoing/export/{exportType}

Parameters:

  • exportType (path) - Export format: xlsx, xls, ods, pdf, csv