Importing products over API

Products can be imported programmatically over Application Programming Interface (API), using secured HTTPS protocol.

Following steps have to be done in order to import a product via API:

Get access token
Import the product with the access token attached

POSTMAN tool will be used for executing the HTTPS requests to the API as part of this example.

Getting access token

First, an authentication token has to be retrieve in order to manage user's application data.

Getting the token can be done by executing a POST request to /api/v1/auth/login route and providing username and password parameters in the JSON body of the request.

Authentication token will be returned as part of the response. This token can be used to access endpoints that enable management of the user's data.

Importing product

Product can be created by executing a POST request to the /api/v1/products/create endpoint.

Following attributes should be provided in order to create a simple product:

name
customer_name
quantity
status
order

As mentioned, the access token has to be attached as part of the header in the form "Authorization: bearer <ACCESS_TOKEN>" in order to update the users data.

In POSTMAN, it can be done in following way:

Viewing the product on product dashboard

If the request was executed successfully, the product will be visible on the product dashboard.

All possible product attributes

Parameter	Description
at_subcontractor	Boolean specifying that product is currently at a subcontractor.
color	Hex code defining the color of the card on product dashboard. (use our OFFISEEK's pallete).
customer_name	Customer name.
delivery_date	The customer's expected delivery date of the product.
description	Text description of the product.
exchange_rate	If the production and sale price currency is different, it is necessary to store the current exchange rate.
has_prepayment	Boolean specifying whether the customer has to pay for the product in advance.
has_transport	Boolean specifying whether the factory is responsible for transporting the goods.
name	Name of the product.
note	Note, f.e. for transporting the goods.
order	The position of the product card in the status column on the product dashboard.
order_id	Order ID from external ERP or accounting system.
production_date	The expected production date of the product.
production_price	Production price.
production_price_currency	Production price currency.
production_unit_price	Production unit price.
quantity	Quantity of the product - can be text.
sale_price	Sale price.
sale_price_currency	Sale price currency.
sale_unit_price	Sale unit price.
status	Status of the product - "new" / "todo" / "inprogress" / "done".
to_stock	Boolean specifying whether the product is produced to stock.