{"info":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"20122176","collectionId":"efee73df-6046-4cc2-9549-ae0566ad4cd9","publishedId":"2s93ecv9m7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-12T08:38:25.000Z"},"item":[{"name":"API по довідниках","item":[{"name":"clients","id":"bbd43520-fb73-40f0-9a63-934fc512f24c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/clients?filters%5Bids%5D=&filters%5Bname%5D=&filters%5Bsurname%5D=&filters%5Bphone%5D=&sort[page]=&sort[pageSize]=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["clients"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

array of client ids

\n","type":"text/plain"},"key":"filters%5Bids%5D","value":""},{"description":{"content":"

find by client name

\n","type":"text/plain"},"key":"filters%5Bname%5D","value":""},{"description":{"content":"

find by client surname

\n","type":"text/plain"},"key":"filters%5Bsurname%5D","value":""},{"description":{"content":"

find by client phone

\n","type":"text/plain"},"key":"filters%5Bphone%5D","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"sort[page]","value":""},{"description":{"content":"

number of pageSize, max 50

\n","type":"text/plain"},"key":"sort[pageSize]","value":""}],"variable":[]}},"response":[],"_postman_id":"bbd43520-fb73-40f0-9a63-934fc512f24c"},{"name":"vehicles by client","id":"6a65377e-0cf6-415b-bfaf-d9f9343aa522","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/client/vehicles/{clientId}?vehicleId=&query=&page=&pageSize=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["client","vehicles","{clientId}"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

find by vehicle id

\n","type":"text/plain"},"key":"vehicleId","value":""},{"description":{"content":"

find by registration number, vehicle make, model, VIN,

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

number of pageSize, max 50

\n","type":"text/plain"},"key":"pageSize","value":""}],"variable":[]}},"response":[],"_postman_id":"6a65377e-0cf6-415b-bfaf-d9f9343aa522"},{"name":"vehicles","id":"4856128a-b7cc-41b5-9fb3-f88f5474d991","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/vehicles?filters%5Bid%5D=&filters%5Bvin%5D=&filters%5BlicensePlate%5D=&filters%5Bname%5D=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["vehicles"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

vehicle id

\n","type":"text/plain"},"key":"filters%5Bid%5D","value":""},{"description":{"content":"

vehicle VIN code

\n","type":"text/plain"},"key":"filters%5Bvin%5D","value":""},{"description":{"content":"

vehicle license plate

\n","type":"text/plain"},"key":"filters%5BlicensePlate%5D","value":""},{"description":{"content":"

vehicle name

\n","type":"text/plain"},"key":"filters%5Bname%5D","value":""}],"variable":[]}},"response":[],"_postman_id":"4856128a-b7cc-41b5-9fb3-f88f5474d991"},{"name":"employees","id":"105de9f2-c639-42f7-8b83-97d8e1b70586","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/employees?disabled=&query=&onlyMechanics=&ids=&posts=&isManager=&managerIds=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["employees"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

return disabled employee too

\n","type":"text/plain"},"key":"disabled","value":""},{"description":{"content":"

find by employee name, employee surname, employee phone, employee email, employee job

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

return only mechanics

\n","type":"text/plain"},"key":"onlyMechanics","value":""},{"description":{"content":"

find by array of employee id

\n","type":"text/plain"},"key":"ids","value":""},{"description":{"content":"

find by array of employee posts, valid [MECHANIC, MASTER_RECEIVER, SPARE_PARTS_SPECIALIST, WORKSHOP_MASTER, ADMINISTRATOR, CASHIER, ACCOUNTANT, HEAD, IT_ADMINISTRATOR, OWNER, OTHER]

\n","type":"text/plain"},"key":"posts","value":""},{"description":{"content":"

return only managers

\n","type":"text/plain"},"key":"isManager","value":""},{"description":{"content":"

find by array of manager ids

\n","type":"text/plain"},"key":"managerIds","value":""}],"variable":[]}},"response":[],"_postman_id":"105de9f2-c639-42f7-8b83-97d8e1b70586"},{"name":"store products","id":"64fb86cf-45b4-4d7e-83bc-9f8576630503","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/store_products?query=&page=&pageSize=&all=&productId=&productCode=&productBrand=&brandId=&withoutPhoto=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["store_products"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

find by product code, brand name

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

number of page size

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

return all

\n","type":"text/plain"},"key":"all","value":""},{"description":{"content":"

find by productId

\n","type":"text/plain"},"key":"productId","value":""},{"description":{"content":"

find by product code

\n","type":"text/plain"},"key":"productCode","value":""},{"description":{"content":"

find by product brand

\n","type":"text/plain"},"key":"productBrand","value":""},{"description":{"content":"

find by brand id

\n","type":"text/plain"},"key":"brandId","value":""},{"description":{"content":"

return without photo

\n","type":"text/plain"},"key":"withoutPhoto","value":""}],"variable":[]}},"response":[],"_postman_id":"64fb86cf-45b4-4d7e-83bc-9f8576630503"},{"name":"warehouses","id":"5302dac1-4b1d-478b-a283-5bde30fe0c7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/warehouses?considerQuantity=&id=&attribute=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["warehouses"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

return warehouse with consider quantity true

\n","type":"text/plain"},"key":"considerQuantity","value":""},{"description":{"content":"

find by warehouse id

\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"

find by array of warehouse attributes, valid ['MAIN','RESERVE','TOOL','REPAIR_AREA','STORAGE']

\n","type":"text/plain"},"key":"attribute","value":""}],"variable":[]}},"response":[],"_postman_id":"5302dac1-4b1d-478b-a283-5bde30fe0c7e"},{"name":"brands","id":"4f02b867-9cc7-4674-ad90-009414ee1858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/clients/brands?filters%5Bpage%5D=&filters%5BbrandName%5D=&filters%5BsupplierId%5D=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["clients","brands"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"filters%5Bpage%5D","value":""},{"description":{"content":"

find by brand name

\n","type":"text/plain"},"key":"filters%5BbrandName%5D","value":""},{"description":{"content":"

find by supplier id

\n","type":"text/plain"},"key":"filters%5BsupplierId%5D","value":""}],"variable":[]}},"response":[],"_postman_id":"4f02b867-9cc7-4674-ad90-009414ee1858"},{"name":"requisites","id":"6f656e7c-5b84-446c-8635-f9ce513874f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/businesses/requisites","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["businesses","requisites"],"host":["api","carbook","pro"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f656e7c-5b84-446c-8635-f9ce513874f0"},{"name":"labors","id":"63729a79-cd2a-4550-bf44-a2acb5cd28be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/labors?all=&id=&crossId=&storeGroupId=&masterLaborId=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["labors"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

return all

\n","type":"text/plain"},"key":"all","value":""},{"description":{"content":"

find by id

\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"

find by cross id

\n","type":"text/plain"},"key":"crossId","value":""},{"description":{"content":"

find by store group id

\n","type":"text/plain"},"key":"storeGroupId","value":""},{"description":{"content":"

find by master labor id

\n","type":"text/plain"},"key":"masterLaborId","value":""}],"variable":[]}},"response":[],"_postman_id":"63729a79-cd2a-4550-bf44-a2acb5cd28be"},{"name":"store groups","id":"77f65c4d-2d86-4551-ab32-d1d6fc17c6ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/store_groups","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["store_groups"],"host":["api","carbook","pro"],"query":[],"variable":[]}},"response":[],"_postman_id":"77f65c4d-2d86-4551-ab32-d1d6fc17c6ab"},{"name":"stations","id":"0c93d5d0-7919-4ba4-9392-545431f384a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/businesses/stations","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["businesses","stations"],"host":["api","carbook","pro"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c93d5d0-7919-4ba4-9392-545431f384a7"},{"name":"suppliers","id":"63c975be-13fb-4fc6-9472-d3ffc01a676d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/business_suppliers_dept?filters%5Bquery%5D=&filters%5BwithoutZeroDept%5D=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["business_suppliers_dept"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

Find by supplier name, supplier phone, supplierId

\n","type":"text/plain"},"key":"filters%5Bquery%5D","value":""},{"description":{"content":"

response without zero dept

\n","type":"text/plain"},"key":"filters%5BwithoutZeroDept%5D","value":""}],"variable":[]}},"response":[],"_postman_id":"63c975be-13fb-4fc6-9472-d3ffc01a676d"},{"name":"cash boxes","id":"534ff3cf-8adc-47df-875d-3b20ff3b0c32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/cash_boxes/balance?endDate=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","name":"API по довідниках","type":"folder"}},"urlObject":{"protocol":"https","path":["cash_boxes","balance"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"endDate","value":""}],"variable":[]}},"response":[],"_postman_id":"534ff3cf-8adc-47df-875d-3b20ff3b0c32"}],"id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"2c5b6a48-88f7-4156-9153-99ff83772e29","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2b5e3ee9-a87b-411a-a60f-15a26d5e11c0","type":"text/javascript","exec":[""]}}],"_postman_id":"1fccaeef-bb92-4f99-a53d-fd23a454e57a","description":""},{"name":"API Наряд-замовлення","item":[{"name":"orders","id":"25e29d15-f2f5-475f-9025-fd6eacb8f613","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/orders?client=&statuses=&vehicleId=&query=&startDate=&endDate=&page=&pageSize=&sortOrder=&sortField=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["orders"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

client Id

\n","type":"text/plain"},"key":"client","value":""},{"description":{"content":"

array of string, valid - ['call', 'redundant', 'approve', 'cancel', 'not_complete', 'progress', 'reserve', 'required', 'success', 'invite']

\n","type":"text/plain"},"key":"statuses","value":""},{"description":{"content":"

vehicle id

\n","type":"text/plain"},"key":"vehicleId","value":""},{"description":{"content":"

find by

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

ISO

\n","type":"text/plain"},"key":"startDate","value":""},{"description":{"content":"

ISO

\n","type":"text/plain"},"key":"endDate","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

number of page size

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

default - 'desc', valid - ['asc', 'desc']

\n","type":"text/plain"},"key":"sortOrder","value":""},{"description":{"content":"

default - 'datetime', valid - ['datetime', 'beginDatetime', 'totalSum', 'deliveryDatetime', 'stationNum', 'successDatetime']

\n","type":"text/plain"},"key":"sortField","value":""}],"variable":[]}},"response":[],"_postman_id":"25e29d15-f2f5-475f-9025-fd6eacb8f613"},{"name":"Add order","id":"11986d3f-7438-413d-94a1-d2d425411197","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded; charset=UTF-8","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"businessId","value":"","description":"

business Id, required

\n","type":"text"},{"key":"clientId","value":"","description":"

client Id, optional

\n","type":"text"},{"key":"phone","value":"","description":"

client phone, required, phone format example: +2d(3d) 3d-2d-2d, d - digits

\n","type":"text"},{"key":"date","value":"","description":"

date, required, date format example: YYYY-MM-DD

\n","type":"text"},{"key":"time","value":"","description":"

time, required, time format example: HH:MM

\n","type":"text"},{"key":"clientVehicleId","value":"","description":"

client vehicle id, optional

\n","type":"text"},{"key":"comment","value":"","description":"

comment from client, optional

\n","type":"text"},{"key":"stationLoads","value":"","description":"

List of station loads for the order, items of array: id (number, optional), status (string, valid: ['TO_DO', 'COMPLETED'], required), beginDatetime (date, iso, required), duration (number, required), stationNum (integer, optional)

\n","type":"text"}]},"url":"https://api.carbook.pro/orders/by_third_party","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["orders","by_third_party"],"host":["api","carbook","pro"],"query":[],"variable":[]}},"response":[],"_postman_id":"11986d3f-7438-413d-94a1-d2d425411197"},{"name":"Add order with client & vehicle","id":"0a72e61b-52b3-4eb6-8639-e8c56fc7e40a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"clientId","value":"","description":"

ID of the client, must be a positive integer, optional

\n","type":"text"},{"key":"clientName","value":"","description":"

Name of the client, this field is mutually exclusive with clientId, optional

\n","type":"text"},{"key":"clientSurname","value":"","description":"

Surname of the client, optional

\n","type":"text"},{"key":"clientPhone","value":"","description":"

Client's phone number, must be provided if clientName is provided, optional, phone format example: +2d(3d) 3d-2d-2d, d - digits

\n","type":"text"},{"key":"sourceId","value":"","description":"

Source ID for the request, must be a positive integer. Default is 1, optional

\n","type":"text"},{"key":"date","value":"","description":"

Date of the order, required, date format example: YYYY-MM-DD

\n","type":"text"},{"key":"time","value":"","description":"

Time of the order, required, time format example: HH:MM

\n","type":"text"},{"key":"clientVehicleId","value":"","description":"

ID of the client vehicle, must be a positive integer, optional

\n","type":"text"},{"key":"comment","value":"","description":"

comment from client, optional

\n","type":"text"},{"key":"plateNumber","value":"","description":"

License plate number of the client’s vehicle, optional

\n","type":"text"},{"key":"vin","value":"","description":"

Vehicle Identification Number (VIN), optional, must be 17 characters long. Can be null or an empty string

\n","type":"text"},{"key":"alias","value":"","description":"

Alias for the vehicle, optional

\n","type":"text"},{"key":"comment","value":"","description":"

Additional comments for the order, optional

\n","type":"text"},{"key":"findByPhone","value":"","description":"

Deprecated. Doesn`t affect request logic

\n","type":"text"},{"key":"stationLoads","value":"","description":"

List of station loads for the order, items of array: status (string, valid: ['TO_DO', 'COMPLETED'], required), beginDatetime (date, iso, required), duration (number, required), stationNum (integer, optional)

\n","type":"text"}]},"url":"https://api.carbook.pro/orders/client_vehicle","description":"

General description: The request creates a new order in the \"Reserve\" status with a client and a vehicle. The client is searched for using either the clientId or clientPhone parameters. The vehicle is searched for using either the clientVehicleId or the client's ID. If the client or vehicle is not found, they will be created based on the provided input data.

You must provide one of the following fields: clientId or clientName. If clientName is provided, the clientPhone field is also required. Additionally, at least one of the following fields must be provided: clientVehicleId, plateNumber, or vin.

Examples

Creating a order without a vehicle.
If no client is found with the provided clientPhone, a new client will be created:
{
\"clientName\": \"{client_name}\",
\"clientSurname\": \"{client_surname}\",
\"clientPhone\": \"{client_phone}\",
\"date\": \"{date}\",
\"time\": \"{time}\"
}
Creating a order with a vehicle.
If no vehicle is found with the provided plateNumber or vin, a new vehicle will be created:
{
\"clientName\": \"{client_name}\",
\"clientSurname\": \"{client_surname}\",
\"clientPhone\": \"{client_phone}\",
\"plateNumber\": \"{license_plate}\",
\"vin\": \"{VIN_code}\",
\"date\": \"{date}\",
\"time\": \"{time}\"
}
Creating a order using clientId (no need to provide name or phone):
{
\"clientId\": \"{client_id}\",
\"date\": \"{date}\",
\"time\": \"{time}\"
}
Creating a order with a vehicle using clientId and clientVehicleId:
{
\"clientId\": \"{client_id}\",
\"clientVehicleId\": \"{client_vehicle_id}\",
\"date\": \"{date}\",
\"time\": \"{time}\",
\"stationLoads\": [{
status: \"{status}\",
beginDatetime: \"{datetime}\",
duration: \"{duration}\",
stationNum: \"{stationNum}\"
}]
}

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["orders","client_vehicle"],"host":["api","carbook","pro"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a72e61b-52b3-4eb6-8639-e8c56fc7e40a"},{"name":"active orders","id":"f2f9a79d-e80f-4e83-b58d-63f831afe42f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/order/third_party?businessId=&phone=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["order","third_party"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

business id, required

\n","type":"text/plain"},"key":"businessId","value":""},{"description":{"content":"

client phone, required

\n","type":"text/plain"},"key":"phone","value":""}],"variable":[]}},"response":[],"_postman_id":"f2f9a79d-e80f-4e83-b58d-63f831afe42f"},{"name":"order by ID","id":"5c0478c2-fad1-4135-92a4-2452545b2bfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/orders/{orderId}","description":"

https://api.carbook.pro/orders/{orderId}

Response:\n\nblockedOrder - <bool> - Order status (if true, order cannot be edited)\nbusinessLocations - All business locations\ncalls - Calls regarding this order\ncashOrders - <CashOrder[]> Cash orders, that relate to this order\nemployees - All business employees\nloyalty - <Loyalty> - Loyalty program\nmanagers - <Manager[]> - All business managers\nnormHourPrice - <number> - Price of norm hour (taken from Labors directory setting)\norder - <Order> - Order information\norderDetails - <OrderDetail[]> - Order details\norderRecommendations - <OrderRecommendationList> - Order recommendations\norderServices - <OrderService[]> - Order services.\nschedule - <ScheduleGroup[]> - Business work schedule.\nstationLoads - <StationLoad[]> - Station loads of the order\nstations - <Station[]> - All business stations (posts)\n\n\nCashOrder:\nbusinessSupplierId - <integer> - Supplier id\ncashBoxId - <integer> - Cash box id\nclientId - <integer> - Client id\ncreatedAt - <string> - ISO date, created at\ncreatedBy - <integer> - id of manager (responsible), who created an order\ndecrease - <number> - amount of decrease (is null if order is of type \"INCOME\")\nincrease - <number> - amount of increase (is null if order is of type \"EXPENSE\", \"ADJUSTMENT\")\nid - <string> - id of a cash order\norderId - <integer> - id of an order\nupdatedAt - <string> - ISO date, last update date\nupdatedBy - <integer> - id of manager, who updated an order\n\nLoyalty:\naccumulativeDiscountId - <integer> - accumulative discount id\nappurtunanciesPercent - <number> - <number> - percent of details sum added to loyalty balance\nbarcode - <string>\nbarcodeId - <integer>\ncardNumber - <string>\nclientId - <integer>\ncolor - <string> - color of card\ncreatedAt - <string> - ISO date, created at\ncreatedBy - <integer> - id of manager (responsible), who created a loyalty\ncurrentLevel - <LoyaltyLevel> - current loyalty level\nfixedDiscountId - <integer>\nid - <number> - loyalty id\nisActive - <bool>\nlaborsPercent - <number> - percent of labors sum added to loyalty balance\nname - <string>\nnextLevel - <LoyaltyLevel> - next loyalty level\npointsToNextLevel - <number>\nprogramDiscountSettingsId - <integer>\ntotalPoints - <number>\ntype - <string> - \"ACCUMULATIVE\", \"FIXED\", \"BONUS\" - type of loyalty program\nupdatedBy - <integer> - id of manager, who created a loyalty\n\n\n\nLoyaltyLevel:\nid - <integer> - loyalty level id\nprogramDiscountSettingsId - <integer>\nbusinessId - <integer>\nsumFrom - <number> - level start sum\nsumTo - <number> - level end sum\ncardName - <string> - card name\ncolor - <string> - color of card\ntotalPercent - <number> - total percent of sum added to loyalty balance\nlaborsPercent - <number> - percent of labors sum added to loyalty balance\nappurtunanciesPercent - <number> - <number> - percent of details sum added to loyalty balance\ncreatedAt - <string> - ISO date, created at\ncreatedBy - <integer> - id of manager (responsible), who created a loyalty\nupdatedBy - <integer> - id of manager, who created a loyalty\n\n\n\nManager:\nbusinessId - <integer> - id of business of the manager\ndisabled - <bool> - is manager account disabled\nemployeeId - <integer>\nid - <integer> - manager id\nisCashier - <bool>\nisMechanic - <bool>\nisStatisticCrmIncluded - <bool>\nmanagerName - <string>\nmanagerSurname - <string>\nmedoc - <Medoc> - medoc settings\nphone - <string>\nphoneCode - <PhoneCode>\nposts - <EmployeePost[]>\n\n\n\nMedoc:\ndept - <string> - debt\nedrpou - <string>\nlogin - <string>\nurl - <string> - medoc url\n\n\nPhoneCode:\ncode - <string> - country phone code (\"380\" for Ukraine)\ncountry - <string>\n\n\nEmployeePost:\npostId - <integer>\npostName - <string>\n\n\nOrder:\nbeginDatetime - <string> - ISO date, date of order creation\nclientPhone - <string>\nclientId - <integer>\nclientVehicleId - <integer>\nduration - <number> - duration of order, in hours\nmanagerId - <integer>\npaymentMethod - <string> - one of: \"cash\", \"visa\", \"noncash\"\nstatus - <string> - one of: \"not_completed_supplier_expense\", \"success\", \"cancel\", \"required\", \"approve\", \"not_completed_supplier_income\", \"progress\", \"reserve\", \"stop\", \"invite\", \"redundant\", \"call\", \"processing\", \"not_complete\"\nid - <integer> - order id\nnum - <string> - number of an order\ndatetime - <string> - ISO date\nservicesSum - <number> - sum of order services\ndetailsSum - <number> - sum of order details\nbusinessId - <integer>\ndeliveryDatetime - <string> - ISO date\ninvoiceCreated - <bool> - is invoice created in vat journal\ninvoiceReportPrinted - <bool> - is invoice printed in vat journal\ncompletedWorkReportPrinted - <bool>\nservicesTotalSum - <number> - total sum of order services\ndetailsTotalSum - <number> - total sum of order details\nservicesPriceSum - <number>\nappurtenanciesPriceSum - <number>\ntotalSum - <number>\ntotalSumDiscount - <number> - total discount sum\nservicesSumDiscount - services discount sum\nonlyAppurtenanciesTotalSum - <number>\nonlyAppurtenanciesTotalSumDiscount - <number>\nprintNumber - <string> - print number in print documents\nlaborTimeMultiplier - <number>\ntotalSumWithTax - <number>\ntax - <integer>\nisTaxPayer - <bool>\nbodyId - <integer>\nremainingSum - <number>\nsubStatus - <string> - one of: \"paid\", \"after_repair\", \"logistic_parts\", \"adjustment\", \"pause\", \"request\", \"deleted\", \"calculation_parts\", \"diagnostics\", \"record\", \"new\", \"calculation_labors\", \"repair\", \"auto\", \"done\", \"stop\", \"regulations\", \"before_repair\", \"call\", \"review\"\nclientVehicleTypeId - <integer>\nclientVehicleRadius - <integer>\nvehicleTypeName - <string> - for example, in ukrainian, one of: \"Легковий\", \"Вантажний\", \"Мото\", \"Інший\", \"Бус\"\nnormHourPrice - <number>\nplate - <string> - client vehicle plate number\n\n\n\nOrderDetail:\nactualMarkup - <number> - price compared to purchase price of the detail\nagreement - <string> - agreement status of the detail, one of: \"UNDEFINED\", \"REJECTED\", \"AGREED\"\nbrandName - <string>\ncellAddress - <string> - warehouse cell address\ncomment - <Comment> - diagnostic comment\ncount - <number> - quantity of detail\ncountOnWarehouse - <number> - quantity of detail in warehouse\ncountInStoreOrders - <number - quantity of detail in store orders\ndetailClass - <string> - one of: \"STATION\", \"CONSUMABLE\", \"CLIENT_PART\"\ndetailCode - <string>\ndetailName - <string>\nexternalApiDocId - <string> - id of supplier document\nexternalApiExpenseDocId - <string>\nid - <integer> - id of order detail\nisCritical - <bool>\nisCriticalByTime - <bool>\nisEndingByTime - <bool>\nisFromStock - <bool>\nisNewByTime - <bool>\nisOverdueByTime - <bool>\nmarkupCheckFailed - <bool>\nmeasureUnit - <string>\npurchasePrice - <number>\nprice - <number> - selling price\npartRowDiscount - <integer>\nproductId - <integer> - id of product in Products directory\npartUnitId - <integer> - measure unit id\nproductname - <string>\nproductCode - <string>\nproductBrandId - <integer>\ntradeCode - <string> - UKTZ code\nstoreGroupId - <integer>\nmin - <integer>\nmax - <integer>\nremaining - <number> - quantity of details remaining in warehouse\nreserved - <number>\nsupplierId - <integer>\nsupplierBrandId - <integer>\nsupplierName - <string>\nsupplierBrandName - <string>\nstore - <string[]> - availabilities\nstage - <string> - one of: \"RETURNED\", \"ORDERED\", \"INSTALLED\", \"ACCEPTED\", \"INACTIVE\", \"GIVEN\", \"CANCELED\", \"NO_SPARE_PART\", \"RESERVED\"\norder - <number>\nsum - <number> - sum without VAT, count \\* price with discounts\ntime - <integer> - status time\nsecondsInStatus - <integer>\nstatusSetDatetime - <string> - ISO date\nstatusTime - <integer>\ntransferedToRepairArea - <bool> - detail is in the repair area\nstatusColor - <string>\n\n\n\nComment:\ncomment - <string>\npositions - <string[]>\nproblems - <string[]>\n\n\n\nOrderRecommendationList:\nlist - <OrderRecommendation[]>\ncount - <{count: <string>}>\n\n\nOrderRecommendation:\nrecommendationId - <integer>\nvehicleId - <integer>\norderId - <integer>\norderNum - <string>\nlaborId - <string>\nlaborName - <string>\ndefaultName - <string>\nrecommendationToDate - <string>\nrecommendationToOdometerValue - <integer>\nrecommendationStatus - <bool>\ncount - <number>\nservicePrice - <integer>\nlaborUnitId - <integer>\norderSuccessDatetime - <string> - ISO date\n\n\nOrderService:\nid - <integer> - id of this service\nbusinessSupplierId - <integer>\nbusinessSupplierName - <string>\nlaborId - <string> - labor code\nspecificationId - <integer>\nlaborUnitId - <integer> - measure unit id\nstartTime - <string> - format: YYYY-MM-DD HH:MM\nendTime - <string> - format: YYYY-MM-DD HH:MM\nmeasureUnit - <string>\nhours - <number>\nprice - <integer>\nserviceRowDiscount - <integer> - discount, in percents\nsum - <number> - sum without VAT, count \\* price with discounts\nownDetail - <bool>\nagreement - <string> - agreement status of the service, one of: \"UNDEFINED\", \"REJECTED\", \"AGREED\"\ndefaultName - <string>\nserviceName - <string>\ncomment - <Comment>\npurchasePrice - <number>\ncount - <integer> - quantity of services\nisCritical - <bool>\nstage - <string> - one of: \"DONE\", \"STOPPED\", \"CANCELED\", \"IN_PROGRESS\", \"INACTIVE\"\nworkingTime - <integer>\nstoppedTime - <integer>\nstoreGroupId - <integer>\norder - <integer>\ncounterparty - <string> - one of: \"CREW\", \"SUPPLIER\", \"EMPLOYEE\"\nstoreGroupName - <string>\nemployeeName - <string>\nactualMarkup - <integer>\n\n\n\nScheduleGroup:\nbeginTime - <string> - start of business work, format: \"DD:MM\"\nendTime - <string> - end of business work, format: \"DD:MM\"\nh24 - <bool> - is 24 hour\ndays - <integer[]> - days of week (starting index - 1 (Monday))\n\n\n\nStationLoad:\nbeginDatetime - <string> - ISO date\nduration - <number> - amount of time, in hours\nid - <integer>\nstationNum - <integer> - number of business station\nstatus - <string> - one of: \"TO_DO\", \"COMPLETED\"\n\n\nStation:\ndisabled - <bool> - is station disabled, opposite of \"enabled\"\nenabled - <bool> - is station enabled, opposite of \"disabled\"\nid - <integer>\nname - <string>\nnum - <integer>\n\n

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["orders","{orderId}"],"host":["api","carbook","pro"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c0478c2-fad1-4135-92a4-2452545b2bfa"}],"id":"a7d0c371-d3c5-41c1-9c34-b545cb19b35f","_postman_id":"a7d0c371-d3c5-41c1-9c34-b545cb19b35f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}}},{"name":"API Склад та складські документи","item":[{"name":"store documents","id":"f31ec5a9-62e5-46b3-8413-ec5061a24ef7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/store_docs?operationCodes=&documentTypes=&types=&statuses=&query=&createdDatetime=&doneDatetime=&recordDatetime=&paidDatetime=&startDate=&endDate=&orderId=&storeDocId=&warehouseId=&page=&pageSize=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["store_docs"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

array of operation codes, valid ['INC','CRT','STP','SRV','OUT','SRT','CST','STM','TSF','RES','ORD','BOR','COM','TOL','TOR','AUT','VRT','KPP','KPM']

\n","type":"text/plain"},"key":"operationCodes","value":""},{"description":{"content":"

array of document type, valid ['SUPPLIER','CLIENT','INVENTORY','OWN_CONSUMPTION','TRANSFER','SERVICE','PRESERVATION']

\n","type":"text/plain"},"key":"documentTypes","value":""},{"description":{"content":"

array of type, valid ['INCOME','EXPENSE']

\n","type":"text/plain"},"key":"types","value":""},{"description":{"content":"

array of status, valid ['NEW','DONE','CANCEL']

\n","type":"text/plain"},"key":"statuses","value":""},{"description":{"content":"

find by supplier name, manager name, manager surname, client name, client surname, employee name, employee surname, barcode, supplier document number

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"createdDatetime","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"doneDatetime","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"recordDatetime","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"paidDatetime","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"startDate","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"endDate","value":""},{"description":{"content":"

order Id

\n","type":"text/plain"},"key":"orderId","value":""},{"description":{"content":"

document Id

\n","type":"text/plain"},"key":"storeDocId","value":""},{"description":{"content":"

warehouse Id

\n","type":"text/plain"},"key":"warehouseId","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

number of page size

\n","type":"text/plain"},"key":"pageSize","value":""}],"variable":[]}},"response":[],"_postman_id":"f31ec5a9-62e5-46b3-8413-ec5061a24ef7"},{"name":"store products balance","id":"ed63d028-667d-468d-bd95-18a4458cd301","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/store_doc_products/balance?productIds=&date=&query=&page=&pageSize=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["store_doc_products","balance"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

array of productIds

\n","type":"text/plain"},"key":"productIds","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"date","value":""},{"description":{"content":"

find by product code

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

number of page size

\n","type":"text/plain"},"key":"pageSize","value":""}],"variable":[]}},"response":[],"_postman_id":"ed63d028-667d-468d-bd95-18a4458cd301"},{"name":"balance by products","id":"db8951b3-2d89-44ae-becc-4d23280a7667","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/balance_by_products?warehouseId=&groupId=&productCode=&brandId=&date=&detailing=","description":"

Query Params:
warehouseId - warehouse id, optional
groupId - product group id, optional
productCode - product code, optional
brandId - brand id, optional
date - store doc done date up until given date, format ISO 8601 (YYYY-MM-DD), optional
detailing - detailing, valid - [\"without\", \"warehouses\", \"cells\"]

Response Fields:
code - Product code
name - Product name
brand - Product brand/manufacturer
product_group - Product group/category
reserved - Reserved quantity of the product
reservedSum - Total reserved sum/value
available - Available quantity in stock
productMin - Minimum allowed quantity for purchase/order
productMax - Maximum allowed quantity for purchase/order
barcode - Product barcode(s), comma-separated
price - Product price
averageWarehousePrice - Average warehouse price
measureUnit - Measurement unit (e.g. шт)
quantity - Total quantity of the product (if detailing=\"warehouses\")
detailing - Detailing[], detailing=\"cells\" -> DetailingCells[]> - Detailed stock/price in warehouses

Detailing:
name - Warehouse name
price - Price per item
quantity - Quantity
reserved - Reserved quantity
reservedSum - Reserved sum/value

DetailingCells:
name - Warehouse name
price - Price per item
quantity - Quantity

Examples

Request 1:

https://api.carbook.pro/balance_by_products?date=2026-02-11&detailing=without

Response 1:

[\n    {\n        \"code\": \"0409\",\n        \"name\": \"Колодка гальмівна барабанна\",\n        \"brand\": \"Remsa\",\n        \"product_group\": \"1000000 - Автозапчастини\",\n        \"reserved\": 1,\n        \"reservedSum\": 10,\n        \"available\": 0,\n        \"productMin\": \"\",\n        \"productMax\": \"\",\n        \"barcode\": \"\",\n        \"price\": 10,\n        \"averageWarehousePrice\": 10,\n        \"measureUnit\": \"шт\",\n        \"quantity\": 1\n    },\n    {\n        \"code\": \"010203\",\n        \"name\": \"Хладагенти (фреони) R134A\",\n        \"brand\": \"Akkussan\",\n        \"product_group\": \"1000000 - Автозапчастини\",\n        \"reserved\": 0,\n        \"reservedSum\": 0,\n        \"available\": 98,\n        \"productMin\": \"\",\n        \"productMax\": \"\",\n        \"barcode\": \"\",\n        \"price\": 980,\n        \"averageWarehousePrice\": 10,\n        \"measureUnit\": \"шт\",\n        \"quantity\": 98\n    },\n]\n\n

Request 2:

https://api.carbook.pro/balance_by_products?detailing=cells

Response 2:

[\n    {\n        \"code\": \"0409\",\n        \"name\": \"Колодка гальмівна барабанна\",\n        \"brand\": \"Remsa\",\n        \"product_group\": \"1000000 - Автозапчастини\",\n        \"reserved\": 0,\n        \"reservedSum\": 0,\n        \"available\": 1,\n        \"productMin\": \"\",\n        \"productMax\": \"\",\n        \"barcode\": \"\",\n        \"price\": 10,\n        \"averageWarehousePrice\": 10,\n        \"measureUnit\": \"шт\",\n        \"detailing\": [\n            {\n                \"name\": \"Головний / без комірки\",\n                \"price\": 10,\n                \"quantity\": 1\n            }\n        ]\n    },\n    {\n        \"code\": \"010203\",\n        \"name\": \"Хладагенти (фреони) R134A\",\n        \"brand\": \"Akkussan\",\n        \"product_group\": \"1000000 - Автозапчастини\",\n        \"reserved\": 0,\n        \"reservedSum\": 0,\n        \"available\": 98,\n        \"productMin\": \"\",\n        \"productMax\": \"\",\n        \"barcode\": \"\",\n        \"price\": 980,\n        \"averageWarehousePrice\": 10,\n        \"measureUnit\": \"шт\",\n        \"detailing\": [\n            {\n                \"name\": \"Головний / без комірки\",\n                \"price\": 800,\n                \"quantity\": 80\n            },\n            {\n                \"name\": \"Склад 1 / без комірки\",\n                \"price\": 100,\n                \"quantity\": 10\n            },\n            {\n                \"name\": \"Склад 2 / без комірки\",\n                \"price\": 80,\n                \"quantity\": 8\n            }\n        ]\n    }\n]\n\n

warehouse id, optional

\n","type":"text/plain"},"key":"warehouseId","value":""},{"description":{"content":"

product group id, optional

\n","type":"text/plain"},"key":"groupId","value":""},{"description":{"content":"

product code, optional

\n","type":"text/plain"},"key":"productCode","value":""},{"description":{"content":"

brand id, optional

\n","type":"text/plain"},"key":"brandId","value":""},{"description":{"content":"

store doc done date up until given date, format ISO 8601 (YYYY-MM-DD), optional

\n","type":"text/plain"},"key":"date","value":""},{"description":{"content":"

detailing, valid - [\"without\", \"warehouses\", \"cells\"]

\n","type":"text/plain"},"key":"detailing","value":""}],"variable":[]}},"response":[],"_postman_id":"db8951b3-2d89-44ae-becc-4d23280a7667"},{"name":"stock in warehouses","id":"e258bf6e-239e-4508-82e6-5a4bf56a78e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/store_product/stock_in_warehouses?productCode=&brandId=&productId=","description":"

Params:
productCode - product code, optional
brandId - brand id, default - 0, optional
productId - product id, optional

productId and productCode are mutually exclusive
At least one of them must be provided

Response:
id - Warehouse id
count - Current quantity available in warehouse
totalCount - Total quantity in warehouse and across all cells
purchasePrice - Average purchase price of the product
cellsInfo - Cells info

batches - List of batches

Batch:
quantity - Quantity in this batch
purchasePrice - Purchase price per unit in this batch

CellsInfo:
cellAddress - Cell name
count - Quantity in this cell
price - Price in this cell
batches: - Batches in this cell

Examples

Request 1/2:

https://api.carbook.pro/store_product/stock_in_warehouses?productId=252640
OR
https://api.carbook.pro/store_product/stock_in_warehouses?productCode=00288849&brandId=586

Response 1/2:

[\n    {\n        \"id\": 2827,\n        \"count\": 72,\n        \"totalCount\": 162,\n        \"purchasePrice\": 42.638888888888886,\n        \"batches\": [\n            {\n                \"quantity\": 30,\n                \"purchasePrice\": 25\n            },\n            {\n                \"quantity\": 20,\n                \"purchasePrice\": 50\n            },\n            {\n                \"quantity\": 22,\n                \"purchasePrice\": 60\n            }\n        ],\n        \"cellsInfo\": [\n            {\n                \"cellAddress\": \"2827.A.A\",\n                \"count\": 39,\n                \"price\": 36,\n                \"batches\": [\n                    {\n                        \"quantity\": 10,\n                        \"purchasePrice\": 30\n                    },\n                    {\n                        \"quantity\": 15,\n                        \"purchasePrice\": 40\n                    }\n                ]\n            },\n            {\n                \"cellAddress\": \"2827.A.C\",\n                \"count\": 1,\n                \"price\": 0,\n                \"batches\": []\n            },\n            {\n                \"cellAddress\": \"2827.B.C\",\n                \"count\": 50,\n                \"price\": 35,\n                \"batches\": [\n                    {\n                        \"quantity\": 50,\n                        \"purchasePrice\": 35\n                    }\n                ]\n            }\n        ]\n    },\n    {\n        \"id\": 3556,\n        \"count\": 100,\n        \"totalCount\": 100,\n        \"purchasePrice\": 10,\n        \"batches\": [\n            {\n                \"quantity\": 100,\n                \"purchasePrice\": 10\n            }\n        ],\n        \"cellsInfo\": []\n    },\n    {\n        \"id\": 3557,\n        \"count\": 0,\n        \"totalCount\": 0,\n        \"purchasePrice\": 0,\n        \"batches\": [],\n        \"cellsInfo\": []\n    },\n    {\n        \"id\": 4228,\n        \"count\": 0,\n        \"totalCount\": 1,\n        \"purchasePrice\": 0,\n        \"batches\": [],\n        \"cellsInfo\": [\n            {\n                \"cellAddress\": \"4228.A.C\",\n                \"count\": 1,\n                \"price\": 0,\n                \"batches\": []\n            }\n        ]\n    }\n]\n\n

product code, optional

\n","type":"text/plain"},"key":"productCode","value":""},{"description":{"content":"

brand id, default - 0, optional

\n","type":"text/plain"},"key":"brandId","value":""},{"description":{"content":"

product id, optional

\n","type":"text/plain"},"key":"productId","value":""}],"variable":[]}},"response":[],"_postman_id":"e258bf6e-239e-4508-82e6-5a4bf56a78e0"}],"id":"3c5a8556-4111-4a69-a971-bf9cad6e6629","_postman_id":"3c5a8556-4111-4a69-a971-bf9cad6e6629","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}}},{"name":"API Каси та заборгованість","item":[{"name":"suppliers credit","id":"8beace27-800e-4c1e-bf8c-f8f2dc96e50c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/business_suppliers_dept?filters%5Bquery%5D=&filters%5BwithoutZeroDept%5D=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["business_suppliers_dept"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

Find by supplier name, supplier phone, supplierId

\n","type":"text/plain"},"key":"filters%5Bquery%5D","value":""},{"description":{"content":"

response without zero dept

\n","type":"text/plain"},"key":"filters%5BwithoutZeroDept%5D","value":""}],"variable":[]}},"response":[],"_postman_id":"8beace27-800e-4c1e-bf8c-f8f2dc96e50c"},{"name":"cash orders","id":"2f91d541-2483-42f1-ac54-685d2441548d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/cash_orders?startDate=&endDate=&sortField=&sortOrder=&page=&pageSize=&cashBoxId=&query=&storeDocId=&clientId=&employeeId=&orderId=&businessSupplierId=&analyticsUniqueId=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["cash_orders"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"startDate","value":""},{"description":{"content":"

ISO date

\n","type":"text/plain"},"key":"endDate","value":""},{"description":{"content":"

sort by id or datetime

\n","type":"text/plain"},"key":"sortField","value":""},{"description":{"content":"

sort by asc or desc

\n","type":"text/plain"},"key":"sortOrder","value":""},{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

number of page size

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

cashbox id

\n","type":"text/plain"},"key":"cashBoxId","value":""},{"description":{"content":"

find by client name, client surname, client phone, vehicle vin, vehicle number, supplier name, employee name, employee surname, employee email, employee phone

\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"

store doc id

\n","type":"text/plain"},"key":"storeDocId","value":""},{"description":{"content":"

client id

\n","type":"text/plain"},"key":"clientId","value":""},{"description":{"content":"

employee id

\n","type":"text/plain"},"key":"employeeId","value":""},{"description":{"content":"

order id

\n","type":"text/plain"},"key":"orderId","value":""},{"description":{"content":"

supplier id

\n","type":"text/plain"},"key":"businessSupplierId","value":""},{"description":{"content":"

analytic Id

\n","type":"text/plain"},"key":"analyticsUniqueId","value":""}],"variable":[]}},"response":[],"_postman_id":"2f91d541-2483-42f1-ac54-685d2441548d"},{"name":"clients depts","id":"b1470527-3565-4584-b60c-e851efd74937","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.carbook.pro/report/client_debts?filters%5Bpage%5D=&filters%5BpageSize%5D=&filters%5Bquery%5D=&filters%5BoverdueOnly%5D=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}},"urlObject":{"protocol":"https","path":["report","client_debts"],"host":["api","carbook","pro"],"query":[{"description":{"content":"

number of page

\n","type":"text/plain"},"key":"filters%5Bpage%5D","value":""},{"description":{"content":"

number of page size

\n","type":"text/plain"},"key":"filters%5BpageSize%5D","value":""},{"description":{"content":"

find by client name, client surname, client phone

\n","type":"text/plain"},"key":"filters%5Bquery%5D","value":""},{"description":{"content":"

return overdue only

\n","type":"text/plain"},"key":"filters%5BoverdueOnly%5D","value":""}],"variable":[]}},"response":[],"_postman_id":"b1470527-3565-4584-b60c-e851efd74937"}],"id":"d325b63b-cfc3-4138-87ed-80efcab56dab","_postman_id":"d325b63b-cfc3-4138-87ed-80efcab56dab","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","id":"efee73df-6046-4cc2-9549-ae0566ad4cd9","name":"APICarbook","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"92567e18-45cf-4786-a8b2-2758d4833d15","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"be07ecc6-587a-4abc-a31f-292b0ff010c7","type":"text/javascript","exec":[""]}}]}