Want to fix or add a feature? Join-us on gitHub
Something is missing? Add some documentation

API - Frontoffice

All the online REST Frontoffice demo is here http://remote-rest-frontoffice.demo.qalingo.com/

The source code of this webapp Rest fronoffice is here https://github.com/qalingo/qalingo-web-remote and some services are secured with Spring-security.

If you need more features, tell us, we will add it!

Customer

Source code CustomerRestService.java

Customer private informations

  • Path: /customer/account
  • Method: GET
  • is secured
  • Produces: CustomerPojoResponse

Customer public informations

  • Path: /customer/permalink/{permalink}
  • Method: GET
  • is not secured
  • Produces: CustomerPojoResponse

Customer create

  • Path: /customer/
  • Method: POST
  • is not secured
  • Consumes: CustomerPojo
  • 		{
    		"login": "xxxx",
    		"title": "xxxx",
    		"firstname": "xxxx",
    		"lastname": "xxxx",
    		"email": "xxxx",
    		"password": "xxxx",
    		"defaultLocale": "xxxx",
    		"guest": "xxxx"
		}
  • Produces: void

Customer update

  • Path: /customer/account
  • Method: PUT
  • is secured
  • Consumes: CustomerPojo
  • 		{
    		"login": "xxxx",
    		"title": "xxxx",
    		"firstname": "xxxx",
    		"lastname": "xxxx",
    		"email": "xxxx",
    		"password": "xxxx",
    		"defaultLocale": "xxxx",
    		"guest": false
		}
  • Produces: void

Customer wishlist - product list

  • Path: /customer/wishlist
  • Method: GET
  • is secured
  • Produces: WishlistPojoResponse

Customer add to wishlist

  • Path: /customer/wishlist
  • Method: PUT
  • is secured
  • Consumes: WishlistPojoRequest
  • 		{
			"marketAreaCode": "xxxx",
			"catalogCategoryCode": "xxxx",
			"productSkuCode": "xxxx"
		}
  • Produces: AddToWishlistPojoResponse

Catalog

Source code CatalogRestService.java

Virtual Catalog list

  • Path: /catalog/virtual/
  • Method: GET
  • is not secured
  • Produces: CatalogListPojoResponse

Virtual Catalog details

  • Path: /catalog/virtual/{catalogCode}
  • Method: GET
  • is not secured
  • Produces: CatalogPojoResponse

Virtual Catalog - Category list

  • Path: /catalog/virtual/{catalogCode}/category/
  • Method: GET
  • is not secured
  • Produces: CategoryListPojoResponse

Virtual Catalog - Category details

  • Path: /catalog/virtual/{catalogCode}/category/{categoryCode}/
  • Method: GET
  • is not secured
  • Produces: CategoryPojoResponse

Virtual Catalog - Product Marketing list

  • Path: /catalog/virtual/{catalogCode}/category/{categoryCode}/product/
  • Method: GET
  • is not secured
  • Produces: ProductListPojoResponse

Virtual Catalog - Product Marketing details

  • Path: /catalog/virtual/{catalogCode}/category/{categoryCode}/product/{productCode}
  • Method: GET
  • is not secured
  • Produces: ProductPojoResponse

Cart / Checkout

Source code CartRestService.java

Cart - details

  • Path: /cart/
  • Method: GET
  • is not secured
  • Consumes:
  • 		{
			"marketAreaCode": "xxxx"
		}
  • Produces: CommonCartPojoResponse

Cart - add item to cart

You need to call the "cart details" before, to get a cartId.

  • Path: /cart/items/
  • Method: POST
  • is not secured
  • Consumes:
  • 		{
			"marketAreaCode": "xxxx"
			"cartId": "xxxx"
			"productSkuCode": "xxxx"
			"catalogCategoryCode": "xxxx"
			"quantity": 1
		}
  • Produces: AddToCartPojoResponse

Cart - update item to cart

  • Path: /cart/items/
  • Method: PUT
  • is not secured
  • Consumes:
  • 		{
			"cartId": "xxxx",
			"productSkuCode": "xxxx",
			"quantity": 1
		}
  • Produces: CommonCartPojoResponse

Cart - update item to cart

  • Path: /cart/items/
  • Method: DELETE
  • is not secured
  • Consumes:
  • 		{
			"cartId": "xxxx",
			"productSkuCode": "xxxx"
		}
  • Produces: CommonCartPojoResponse

Cart - set promocode (TODO)

  • Path: /cart/promocode/
  • Method: POST
  • is not secured
  • Consumes:
  • 		{
			"cartId": "xxxx",
			"promoCode": "xxxx"
		}
  • Produces: CommonCartPojoResponse

Cart - set the shipping address

  • Path: /cart/shipping-address/
  • Method: POST
  • is secured
  • Consumes:
  • 		{
			"cartId": "xxxx",
			"customerAddressId": "xxxx"
		}
  • Produces: CommonCartPojoResponse

Cart - set the billing address

  • Path: /cart/billing-address/
  • Method: POST
  • is secured
  • Consumes:
  • 		{
			"cartId": "xxxx",
			"customerAddressId": "xxxx"
		}
  • Produces: CommonCartPojoResponse

Cart - set the delivery method

  • Path: /cart/delivery-method/
  • Method: POST
  • is secured
  • Consumes:
  • 		{
			"cartId": "xxxx",
			"deliveryMethodCode": "xxxx"
		}
  • Produces: CommonCartPojoResponse

Retailer

Source code RetailerRestService.java

Retailer - list

  • Path: /retailer/
  • Method: GET
  • is not secured
  • Produces: RetailerListPojoResponse

Retailer - details

  • Path: /retailer/{code}
  • Method: GET
  • is not secured
  • Produces: RetailerPojoResponse

Store

Source code StoreRestService.java

Store - list

  • Path: /store/
  • Method: GET
  • is not secured
  • Produces: StoreListPojoResponse

Store - details

  • Path: /store/{code}
  • Method: GET
  • is not secured
  • Produces: StorePojoResponse