Fast Furniture Documentation

API Layer Module

Get Product List

Returns a list of products filtered by merchant id and supplier id

{
    "request": {
      "supplierId": "1484",
      "merchantId": "1234",
      "allProducts": false
    },
    "products": [
      {
        "_id": "5f62df0d8e3238b91c0d767b",
        "productId": "1528",
        "productNameBySupplier": "Marseille1",
        "productNameByMerchant": "Marseille1",
        "productNameByVme": "Marseille1"
      },
      {
        "_id": "5f62df0e8e3238b91c0d767c",
        "productId": "1571",
        "productNameBySupplier": "Lana",
        "productNameByMerchant": "Lana",
        "productNameByVme": "Lana"
      }
    ]
  }

Request Information

Category	Value
Http request	`GET`
URL	`/api/product/list`

Headers

None are specified.

Parameters

Parameter	Definition
supplierId	`the supplier id`
merchantId	`the merchant id (optional)`
allProducts	`default: false, if true, returns all products of the specified supplier, else only merchant specific products (if merchent id is set)`

Schema of response

Field	Definition
_id	`unique system id`
productId	`product id`
productNameBySupplier	`product name by supplier`
productNameByMerchant	`product name by merchant (if merchant id is set)`
productNameByVme	`product name by vme`

Post Import Products Job

Create product import job for one or multiple products

{
    "_id": "5f62df0e8e3238b91c0d767c"
  }

Request Information

Category	Value
Http request	`POST`
URL	`/api/product/import`

Headers

None are specified.

Parameters

Parameter	Definition
supplierId	`the supplier id`
merchantId	`the merchant id (optional)`
products	`array of product objects`
products[id]	`product id`
products[nameBySupplier]	`product name by supplier`
products[nameByMerchant]	`product name by merchant, if merchantId is set`
products[nameByVme]	`product name by vme`

Schema of response

Field	Definition
_id	`unique job id`

Get Import Job Status

Returns the status of the import job process

{
    "_id": "5f62df0e8e3238b91c0d767c",
    "status": "QUEUE"
  }

Request Information

Category	Value
Http request	`GET`
URL	`/api/product/import/status`

Headers

None are specified.

Parameters

Parameter	Definition
id	`job id`

Schema of response

Field	Definition
_id	`job id`
status	`status of the import process (QUEUE, ERROR, PROCESSING, DONE)`
message	`if status = ERROR, the regarding error message`

Get Product Data

Returns descriptive information for a specific product. The request should contain the system id or the product id and the supplier id.

{
  "_id": "5f62df0d8e3238b91c0d767b",
  "productId": "1528",
  "supplierId": "polipol",
  "merchantId": "1234",
  "description": "Betonoptiken bei Möbeln werden immer beliebter. Der Kleiderschrank Leek greift sie am Korpus auf und kombiniert sie mit einer weißen Front. Leek verfügt über ein praktisch unterteiltes Schrankinneres hinter den vier großen Drehtüren. Sieben große Fächer und eine Kleiderstange bieten viel Platz für Kleidung – zusammengelegt und auf einen Bügel aufgehängt. Darüber hinaus stehen Ihnen sechs große Schubladen zur Verfügung.",
  "url": "https://cekaso-shareme.s3.eu-central-1.amazonaws.com/fastfurniture/1.jpg",
  "productNameBySupplier": "Marseille1",
  "productNameByMerchant": "Marseille1",
  "productNameByVme": "Marseille1",
  "created": "2020-09-22 10:15:24",
  "updated": "2020-09-25 14:11:32"
}

Request Information

Category	Value
Http request	`GET`
URL	`/api/product`

Headers

None are specified.

Parameters

Parameter	Definition
_id	`unique system id (required if productId + supplierId is missing)`
productId	`get product id (required if _id is missing)`
supplierId	`supplier id (required if _id is missing)`
merchantId	`merchant id (optional)`

Schema of response

Field	Definition
_id	`unique generated id`
productId	`product id`
description	`product description`
url	`product picture url`
productNameBySupplier	`product name by supplier`
productNameByMerchant	`product name by merchant (if merchant id is set)`
productNameByVme	`product name by vme`

Get Product Delivery Week

Returns delivery week of a specific product

{
  "_id": "5f62df0d8e3238b91c0d767b",
  "deliveryWeek": "34",
  "shippingTime": "4"
}

Request Information

Category	Value
Http request	`GET`
URL	`/api/product/delivery-week`

Headers

None are specified.

Parameters

Parameter	Definition
_id	`unique system id (required if productId + supplierId is missing)`
productId	`get product id (required if _id is missing)`
supplierId	`supplier id (required if _id is missing)`

Schema of response

Field	Definition
_id	`unique system id`
deliveryWeek	`delivery week of the product`
shippingTime	`additional weeks until the product arrives at the customer`

Get Product Warehouse Stock

Returns warehouse stock of a specific product

{
  "_id": "5f62df0d8e3238b91c0d767b",
  "amount": "42"
}

{
  "_id": "5f62df0d8e3238b91c0d767b",
  "amount": "0",
  "availableFromDate": "2021-06-11"
}

Request Information

Category	Value
Http request	`GET`
URL	`/api/product/warehouse-stock`

Headers

None are specified.

Parameters

Parameter	Definition
_id	`unique system id (required if productId + supplierId is missing)`
productId	`get product id (required if _id is missing)`
supplierId	`supplier id (required if _id is missing)`

Schema of response

Field	Definition
_id	`unique system id`
amount	`amount of products in stock (0 if stock is empty)`
availableFromDate	`date (YYYY-MM-DD) when the product is available again if stock is empty (amount == 0)`

Retail API

Get Product Warehouse Stock Retail

Returns warehouse stock(s) of a specific product for different locations

{
  "GTIN": "00012345678905",
  "VAN": "1212359435926741",
  "ERPArticleName"; "Armlehnstuhl",
  "locations": [
    {
      "locationId": "13",
      "locationName":"Store A",
      "amount": {
          "sellable": "30",
          "none_sellable": "12"
      }
    },
    {
      "locationId": "14",
      "locationName":"Store B",
      "amount": {
          "sellable": "8",
          "none_sellable": "15"
      }
    }
  ]
}

Request Information

Category	Value
Http request	`GET`
URL	`/api/retail/warehouse-stock`

Headers

None are specified.

Parameters

Parameter	Definition
GTIN	`Global Trade Item Number (GTIN-14) of the product (required if VAN is missing)`
VAN	`Verbandsartikelnummer of the product (required if GTIN is missing)`

Schema of response

Field	Definition
GTIN	`Required if GTIN provided in request`
VAN	`Required if VAN provided in request`
ERPArticleName	`Required. Represents the name of the article within the ERP system`

|locations|Array of locations with the amount of products with GTIN/VAN. Amount is differentiated based on sellable and non-sellable status.|

Supplier Module

Create Supplier

Create new supplier

{
  "supplierId": "1528",
  "name": "1234",
  "url": "34",
  "defaultShippingTime": 4
}

Request Information

Category	Value
Http request	`POST`
URL	`/api/supplier`

Headers

Content-Type: application/json

Parameters

Parameter	Definition
_id	`unique system id`
supplierId	`supplier id`
name	`supplier name`
logoUrl	`logo url`
defaultShippingTime	`default shipping time which the supplier agreed to`

{
  "_id": "5f62df0d8e3238b91c0d767b"
}

Schema of response

Field	Definition
_id	`unique system id`
message	`only if an error occurs, that need further explanation`

Update Supplier

Update existing supplier

{
  "_id": "5f62df0d8e3238b91c0d767b",
  "supplierId": "1528",
  "name": "1234",
  "url": "34",
  "defaultShippingTime": "4"
}

Request Information

Category	Value
Http request	`PUT`
URL	`/api/supplier`

Headers

Content-Type: application/json

Parameters

Parameter	Definition
_id	`unique system id`
supplierId	`supplier id`
name	`supplier name`
logoUrl	`logo url`
defaultShippingTime	`default shipping time which the supplier agreed to`

{
  "_id": "5f62df0d8e3238b91c0d767b"
}

Schema of response

Field	Definition
_id	`unique generated id`
message	`only if an errors occurs, that need further explanation`

Get Supplier

Get specific supplier

Request Information

Category	Value
Http request	`GET`
URL	`/api/supplier`

Headers

None.

Parameters

Parameter	Definition
_id	`unique system id`

{
  "_id": "5f62df0d8e3238b91c0d767b",
  "supplierId": "1528",
  "name": "1234",
  "url": "34",
  "defaultShippingTime": "4",
  "created": "2020-09-22 10:15:24",
  "updated": "2020-09-25 14:11:32",
  "notes": [
    {
      "_id": "8f62df0d8e3238b91c0d767c",
      "user": "user@mail.com",
      "note": "Default shipping time may vary by 2 to 4 weeks",
      "created": "2020-09-22 10:15:24",
      "updated": "2020-09-25 14:11:32"
    }
  ]
}

Schema of response

Field	Definition
_id	`unique system id`
supplierId	`supplier id`
name	`supplier name`
logoUrl	`logo url`
defaultShippingTime	`default shipping time which the supplier agreed to`
created	`datetime: item created at`
updated	`datetime: item updated at`
notes	`array of notes object`
notes[_id]	`unique system id`
notes[user]	`user who created the note`
notes[note]	`text`
notes[created]	`datetime: item created at`
notes[updated]	`datetime: item updated at`

Get Supplier List

Get list of suppliers

Request Information

Category	Value
Http request	`GET`
URL	`/api/supplier`

Headers

Content-Type: application/json

{
  "suppliers": [
    {
      "_id": "8f62df0d8e3238b91c0d767c",
      "name": "user@mail.com",
      "logoUrl": "logo.png"
    }
  ]
}

Schema of response

Field	Definition
suppliers	`array of supplier objects`
_id	`unique supplier id`
name	`supplier name`
logoUrl	`supplier logo url`

Delete Supplier

Delete supplier

Request Information

Category	Value
Http request	`DELETE`
URL	`/api/supplier`

Headers

Content-Type: application/json

Parameters

Parameter	Definition
_id	`unique system id`

Possible Response Codes

Response Code	Meaning
200	Valid Request -- Server handled request successfully.
201	Item created -- Resource created successfully.
204	Empty Response -- Request was successfully. No response data needed.
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.