This document will explain all RESTful-API web services of BorrowMe. \nThis document requires basic knowledge of RESTful, HTTP request and links between ERP packages.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5400769","collectionId":"cce38e17-b231-48fe-979a-cdbf5d78ee39","publishedId":"S17owVD2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"B63838"},"publishDate":"2019-03-21T12:59:36.000Z"},"item":[{"name":"Tokens","item":[{"name":"Create New Token","id":"358380b0-0589-46ba-a241-a897697e2baa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This action will create a new bearer token. \nThis bearer token will automatically be bound to the user requesting the said token.
\n","urlObject":{"protocol":"https","path":["api","v1","tokens"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"358380b0-0589-46ba-a241-a897697e2baa"}],"id":"80f605c5-4942-48ae-a87c-9f93f147aed2","description":"Every API web service is protected with user authentication or a bearer token authentication.
\nTo be able to work with the web service the user has to send a valid bearer token with the RESTful HTTP request.
\nA bearer token can be obtained through the tokens web service.
\n","event":[{"listen":"prerequest","script":{"id":"23f4cdb7-a275-4d9c-ae31-c14153326845","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"623cdb60-33b7-42e5-8d41-17d245c27325","type":"text/javascript","exec":[""]}}],"_postman_id":"80f605c5-4942-48ae-a87c-9f93f147aed2"},{"name":"Customer","item":[{"name":"Create new Customer","id":"1aa3fb11-f35e-4bba-8dae-2fb50d7fe500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will result in the creation of a new customer.
\nThe body expects a list of customers, this list can contain 1 or more customers.
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1aa3fb11-f35e-4bba-8dae-2fb50d7fe500"},{"name":"Request all customers","id":"f297266d-0086-4e76-ad82-715f540f8d14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The request requires a CustomerID to be present.
\n
This action will request all customers.
\nThe result of this will be a list of 15 customers as 15 is the default page size.
\n","urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["{{yourdomain}}"],"query":[{"key":"index","value":"1"},{"key":"size","value":"15"}],"variable":[]}},"response":[],"_postman_id":"f297266d-0086-4e76-ad82-715f540f8d14"},{"name":"Get specific customer","id":"522ea4bc-711c-4ef8-a2cf-9ba8ad22d58a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will result in a single customer who's customerID will match the requested customerID.
\nThe URL-Pathname is expecting a CustomerID field. This field is after the URL-Pathname of the webservice and is separated with a / symbol.
\n","urlObject":{"protocol":"https","path":["api","v1","customers","{{CustomerID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"522ea4bc-711c-4ef8-a2cf-9ba8ad22d58a"},{"name":"Edit customer","id":"6733c8ed-da20-4878-8eb4-8e6c55cdc892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will edit a customer.
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","customers","{{CustomerID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6733c8ed-da20-4878-8eb4-8e6c55cdc892"},{"name":"Delete customer","id":"16f4b2aa-2e7f-4188-a2c5-6a7ade157e9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://{{yourdomain}}/api/v1/customers/{{CustomerID}}","description":"To edit a customer, the CustomerID is required as an URL parameter and it has to be present in the body.
\n
The URL-Pathname is expecting a CustomerID field. This field is after the URL-Pathname of the webservice and is separated with a / symbol.
\nThe result of this action is “OK” which implies that that action has completed successfully.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The customers can be managed using the customer web service. This means that new customers can be created, existing customers can be requested, edited and removed.
\nA customer consists of the following properties:
\nThe customerID is only required in the URL-parameters.\nThe contactID will be auto-generated and will be in the result.
\n","urlObject":{"path":["api","v1","customers","{{CustomerID}}","contacts"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7034adf8-e138-4cb0-8c39-b548e7e3146c"},{"name":"Get customer contacts","id":"9f8ee8c0-6003-44d6-addd-d571294879ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The customer contacts can be managed using the customers contact API end-point. This means that new contacts can be created, existing customers can be requested, edited and removed.
\nA contact consists of the following properties:
\nThis action will result in a new order being created.
\nThe body expects a list of orders, this list can consist of 1 or more orders.
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","orders"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c112759b-a5dc-4c39-87b4-640c55496557"},{"name":"Request all orders","id":"52362ab1-ca86-4c86-87f8-c347120a9fca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Every order requires the fields DateTimeRentalStart and DateTimeBusinessStart.
\n
This action will request all orders currently in the system, with default 15 results.
\n","urlObject":{"protocol":"https","path":["api","v1","orders"],"host":["{{yourdomain}}"],"query":[{"key":"index","value":"1"},{"key":"size","value":"15"}],"variable":[]}},"response":[],"_postman_id":"52362ab1-ca86-4c86-87f8-c347120a9fca"},{"name":"Get specific order","id":"58e4ea56-7d7e-4fdf-b444-781b6f033de1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will request a specific order which has the same orderID as the requested orderID.
\n","urlObject":{"protocol":"https","path":["api","v1","orders","{{OrderID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58e4ea56-7d7e-4fdf-b444-781b6f033de1"},{"name":"Edit Order","id":"711e405f-9871-4d6f-949a-4a88a53ab836","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will result in an edited order when the given OrderID matches with the order in the system.
\n\n\nTo edit an order, the OrderID is required as an URL parameter and it has to be present in the body.
\n
The orderID field contained in the body cannot be changed and has to match with the OrderID in the URL.
\n","urlObject":{"protocol":"https","path":["api","v1","orders","{{OrderID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"711e405f-9871-4d6f-949a-4a88a53ab836"}],"id":"3856943b-77d3-478e-bfbc-32d6b15d0da1","description":"Orders can be managed via the Orders web service. That means that new orders can be created, existing orders can be requested and edited and existing orders can be deleted.
\nAn order consists of the following properties:
\nThis action will result in a coupling between existing items and existing orders.
\nThis action will overwrite the current couplings between the order and the related items.\nThe couplings that need to be retained will have to be added to the call.
\n","urlObject":{"protocol":"https","path":["api","v1","orders","{{OrderID}}","orderItems "],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"11e0a2ad-5731-424d-9fa7-51b45fc4e4e1"},{"name":"Request coupling between an order and the ordered items","id":"15884ae0-a804-4e0b-a410-e3a8bc5a3daf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{yourdomain}}/api/v1/orders/{{OrderID}}/orderItems","description":"This action will result in a list of existing item and order couplings.
\nThe result of this action is a list of order article couplings from the order where the order number matches with the OrderID field from the URL-Pathname.
\n","urlObject":{"protocol":"https","path":["api","v1","orders","{{OrderID}}","orderItems"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"15884ae0-a804-4e0b-a410-e3a8bc5a3daf"}],"id":"cadebc78-f449-4db5-90ec-1bd87100ce4e","description":"The orders web service can be used to couple items to existing orders\nA coupling between an order and item using web service contains the following fields:
\nThis action will result in the creation of a new reservation.
\nThe body is expecting a list of reservations, this list can contain 1 or more reservations.
\n","urlObject":{"protocol":"https","path":["api","v1","reservations"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"335e61e2-fa49-43ad-a8bf-eadf00672d84"},{"name":"Request Reservations","id":"2d0b95fd-3dfe-47f8-8397-f59c842d1e1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will result in a list of all reservations, with default 15 results.
\n","urlObject":{"protocol":"https","path":["api","v1","reservations"],"host":["{{yourdomain}}"],"query":[{"key":"index","value":"1"},{"key":"size","value":"15"}],"variable":[]}},"response":[],"_postman_id":"2d0b95fd-3dfe-47f8-8397-f59c842d1e1e"},{"name":"Request specific reservation","id":"e00c108c-44b5-42be-ae5c-f8b099ed40a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will return an specific reservation based on the reservationID.
\nThe URL-Pathname is expecting a ReservationID field. This field is after the URL-Pathname of the webservice and is separated with a / symbol.
\n","urlObject":{"protocol":"https","path":["api","v1","reservations","{{ReservationID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e00c108c-44b5-42be-ae5c-f8b099ed40a9"},{"name":"Edit reservation","id":"de84b20c-cdf5-43a0-8d8d-c00225abbad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will edit an reservation that is found using the ReservationID.
\n\n\nTo edit a reservation, the ReservationID is required as an URL parameter and it has to be present in the body.
\n
The body is expecting an reservation with edited fields. The ReservationID field contained in the body should not be changed and has to match with the ReservationID in the URL-querystring.
\n","urlObject":{"protocol":"https","path":["api","v1","reservations","{{ReservationID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"de84b20c-cdf5-43a0-8d8d-c00225abbad6"},{"name":"Delete Reservation","id":"0f7e21a2-4caf-43a3-bd93-f56820853cdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will result in the deletion of an reservation.
\nThe URL-Pathname is expecting a ReservationID field. This field is after the URL-Pathname of the webservice and is separated with a / symbol.
\n","urlObject":{"port":"","path":["{{yourdomain}}","api","v1","reservations","{{ReservationID}}"],"host":["https"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f7e21a2-4caf-43a3-bd93-f56820853cdd"}],"id":"24b7cceb-f694-4d57-98f0-382ea4275017","description":"Reservations can be managed using the reservations web service.\nThis means new reservations can be created, existing reservations can be edited, existing reservations can be requested and existing reservations can be deleted.
\nA reservation consists of the following properties:
\nThis action will result in the creation of a new coupling between a reservation and an reserved item.
\nThis action will overwrite the current couplings between the reservation and the related items,\nThe couplings that need to be retained will have to be added to the call.
\n","urlObject":{"protocol":"https","path":["api","v1","reservations","{{ReservationID}}","reservationItems"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a26a21b9-58ff-4cb0-8215-23b801b83f8d"},{"name":"Request reserved item coupling","id":"b7d755a8-beb6-4aaa-a635-3ca0bc0c2d83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action wil result in a list of reserved items coupled to the reservation where the reservation number matches the ReservationID of the URL-Pathname.
\nThis action will result in a list of reservationitems with reserved items where the reservation number matches the ReservationID of the URL-Pathname.
\n","urlObject":{"protocol":"https","path":["api","v1","reservations","{{ReservationID}}","reservationItems "],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7d755a8-beb6-4aaa-a635-3ca0bc0c2d83"}],"id":"fc1bcc87-abc3-40bd-9f5c-d335fd516ad8","description":"The reservations web service can be used to couple items to existing reservations\nA coupling between an reservationitem using web service contains the following fields:
\nThe ItemID, ItemType and ItemGroupID are required.
\n","urlObject":{"protocol":"https","path":["api","v1","items"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49235efc-d3d3-469b-bf6b-43ec74c42875"},{"name":"Request items","id":"d81a192e-5786-4b8b-ab71-90039dca5c8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{yourdomain}}/api/v1/items?index=1&size=15","description":"This action will request all orders currently in the system, with default 15 results.
\n","urlObject":{"path":["api","v1","items"],"host":["{{yourdomain}}"],"query":[{"key":"index","value":"1"},{"key":"size","value":"15"}],"variable":[]}},"response":[],"_postman_id":"d81a192e-5786-4b8b-ab71-90039dca5c8a"},{"name":"Request specific item","id":"a347371e-ac53-4f53-90a6-022caddfc7b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{yourdomain}}/api/v1/items/{{ItemID}}","description":"This action will return an specific item based on the ItemID.
\nThe URL-Pathname is expecting a ItemID field. This field is after the URL-Pathname of the webservice and is separated with a / symbol.
\n","urlObject":{"path":["api","v1","items","{{ItemID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a347371e-ac53-4f53-90a6-022caddfc7b8"},{"name":"Edit item","id":"7dce923b-1761-4763-b084-aa96542159d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{yourdomain}}/api/v1/items/{{ItemID}}","urlObject":{"path":["api","v1","items","{{ItemID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7dce923b-1761-4763-b084-aa96542159d1"},{"name":"Delete item","id":"dde73623-2cb1-4418-85dd-7844234dbf08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{yourdomain}}/api/v1/items/{{ItemID}}","urlObject":{"path":["api","v1","items","{{ItemID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dde73623-2cb1-4418-85dd-7844234dbf08"},{"name":"Check item availability","id":"7e6ad4be-00c4-4b68-ad49-3de35084969d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This action will result in the status of availability of an item.
\nThe URL-pathname is expecting an ItemID field.
\nThe availability in the web service has the following fields:
\nThe availability of an article is separated in availability segments. The segments are categorised on warehouse. The periods of the segments in a warehouse are end-to-end and do not overlap.
\nAn availability segment of this web service contains the following fields:
\nExample Item serial
\",\n \"ResidualValue\": 5324008100000000.00,\n \"PurchaseValue\": 7057043340000000.00,\n \"PurchaseDate\": null,\n \"ManufacturerSerial\": null,\n \"LastRentedReference\": \"\",\n \"Counter\": null,\n \"LastRentedCustomerID\": \"009\",\n \"TotalInvoiced\": 0.0000,\n \"OnBackOrder\": null,\n \"DateSold\": null,\n \"TotalWriteOff\": 0.0,\n \"BookValue\": 7057043340000000.00,\n \"LocationID\": null,\n \"OriginalStatus\": \"Stock\"\n\t}\t\n]"},"url":"https://{{yourdomain}}/api/v1/items/{{ItemID}}/serialitems","urlObject":{"protocol":"https","path":["api","v1","items","{{ItemID}}","serialitems"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"43c0290e-aaf2-4ae7-9e47-091d20dbc5dc"},{"name":"Request serial items","id":"9416ce7a-22a2-40b6-b28e-6ebb8bf28ba1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Items can be obtained via the items webservice.
\nAn item contains the following fields:
\n\n\n","event":[{"listen":"prerequest","script":{"id":"73837fab-53ec-4948-9f40-b01439c06ee2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7338a2e-37e6-4225-868a-2bd59bb02e72","type":"text/javascript","exec":[""]}}],"_postman_id":"e9711342-8e67-4ece-993f-777346de32a2"},{"name":"Serial","item":[{"name":"Create new serial items with items","id":"1e8e3486-0d45-4fcc-98bd-bb25ee88daba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n\t{\n\t\t\"ItemID\": \"ItemA\",\n \"ItemType\": \"RentalPeriod\",\n \"ItemGroupID\": \"ItemGroupA\",\n \"Brand\": \"Item A Brand\",\n \"Description\": \"ItemA\",\n \"EANCode\": \"5901234123456\",\n \"AutoSelectSerials\": false,\n \"LockWarehouse\": false,\n \"Articlecode\": \"Salable\",\n \"ServiceGroupID\": null,\n \"Notes\": \"If an item has one or more images attached, the corresponding URL will be in the ImageUrls property. If the ImagesAreProtected is true, then the request to get the image as to be made with the token in the Authorization header.
\n
Some extra notes of Item A
\",\n \"MaxStock\": 0,\n \"MinStock\": 0,\n \"Weight\": 0.0,\n \"ShippingWeight\": 0.0,\n \n \"SerialID\": \"ItemA-0001\",\n \"OwnerContactID\": null,\n \"WarehouseID\": \"Warehouse\",\n \"ManufacturerSerial\": \"AE12340001\",\n \"OnBackOrder\": false,\n \"Counter\": 0,\n \"OriginalStatus\": \"Stock\"\n }\n]"},"url":"{{yourdomain}}/api/v1/serials","urlObject":{"path":["api","v1","serials"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e8e3486-0d45-4fcc-98bd-bb25ee88daba"},{"name":"Request serial items","id":"49948209-fb0a-41eb-8bc8-f870f19fea06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Serial item can be optained via the serials end-point.
\nAn serial item contains the following fields:
\nExample maintenance
\",\r\n \"WarehouseID\": \"Warehouse\"\r\n }\r\n]"},"url":"{{yourdomain}}/api/v1/itemserialservice","urlObject":{"path":["api","v1","itemserialservice"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1deec81-8279-460c-a349-61ccb6ddb7e3"},{"name":"Reqeust serial services","id":"6d6b6bb1-ebee-4692-860a-6c336802cbd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Example maintenance
\",\r\n \"WarehouseID\": \"Warehouse\"\r\n}"},"url":"{{yourdomain}}/api/v1/itemserialservice/{{SerialServiceID}}","urlObject":{"path":["api","v1","itemserialservice","{{SerialServiceID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"de59f0b4-28bb-4e78-b5b6-6d364e690dd9"},{"name":"Delete serial service","id":"64c34273-c901-4503-9a9c-fbd823a44589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{yourdomain}}/api/v1/itemserialservice/{{SerialServiceID}}","urlObject":{"path":["api","v1","itemserialservice","{{SerialServiceID}}"],"host":["{{yourdomain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"64c34273-c901-4503-9a9c-fbd823a44589"}],"id":"63966b90-1f59-430e-bda7-67ad861bc5b7","description":"Serial services can be obtained via the serial service end-point.
\nA serial service contains the following fields:
\n