HOGASHOP API

POST/department/{departmentId}/basket/items{?source,ignoreErrors}

Add items to basket. After this the client should GET whole basket to obtain correct parts and totals.

When the basket has products the merge is performed with this rules:

• Products of type 1 are never merged

• Same products are merged: the amount of existing basket item will be increased, unless delivery dates are different.

Example URI

Content-Type: application/json

[
  {
    "product": {
      "id": 23
    },
    "sellingUnit": {
      "name": "Sa",
      "quantity": 5
    }
  }
]

:[addToBasketRequest](https://www.hogashop.ch/schema/addToBasketRequest.json)

Content-Type: application/json
Basket-Revision: 123 - updated basket revision

:[addToBasketRequest](https://www.hogashop.ch/schema/addToBasketRequest.json)

Content-Type: application/json

{
  "message": " ... any message about wrong addToBasketRequest schema ... ",
  "code": 40023
}

Content-Type: application/json

{
  "message": "Department does not exist",
  "code": 40411
}

Content-Type: application/json

{
  "message": "Concurrent update of basket",
  "code": 4092
}

Content-Type: application/json

:[addToBasketRequest](https://www.hogashop.ch/schema/addToBasketRequest.json)

Content-Type: application/json

:[addToBasketRequest](https://www.hogashop.ch/schema/addToBasketRequest.json)

POST/department/{departmentId}/basket/calculated

Calculate a basket object.

Mutations ¶

When input basket has prices and delivery dates defined, the API will check if those values are correct. All values will be recalculated according to the business rules at the moment of this request, and will be written back in the same basket structure. Any differences will be reported in mutation property. When this property isn’t exists one can say that input basket is actual.

It is not necessary to provide dates and prices. The only required properties are “product” and “amount”. Giving that minimized basket the client side can obtain all the missed properties filled in in the response of this resource.

Example URI

Content-Type: application/json

:[basket](https://www.hogashop.ch/schema/basket.json)

Content-Type: application/json

:[Schema](https://www.hogashop.ch/schema/basket.json)

Content-Type: application/json

{"message":"Wrong department ID","code":4000}
{"message":"Unknown delivery strategy specified","code":40014}
{"message":"Invalid desired delivery date","code":40015}
{"message":" ... any message about wrong basket schema ... ","code":40017}

Content-Type: application/json

{
  "message": "Department does not exist",
  "code": 40411
}

POST/department/{departmentId}/order{?deliveryStrategy,allowDuplicates,ignoreMutations,ignorePriceDecreaseMutation,archive,orderSessionId,supplierReference}

Create an order. Using provided basket the orders will be created. Each basket part produces one order. A basket part is a set of products provided by the same supplier delivered on the same day.

Delivery strategy ¶

Parameter deliveryStrategy can be provided to make delivery dates for each product be calculated in different ways: deliver as fast as possible, deliver in the same day or do not define delivery date at all.

Allowing duplicate orders ¶

Parameter allowDuplicates can to turn off duplicate orders protection. The API won’t create an order when exactly the same set of products is already ordered or orderSessionId is a duplicate. See explanation of orderSessionId below.

Mutations ¶

When the input basket has prices and/or delivery dates defined the API will apply the current business rules to confirm that information. Is it possible that in the moment of ordering the prices are changed or the delivery time is passed. This makes the request to be rejected with code “400 Bad request: basket isn’t actual”. To refresh the information a different API resource should be used, for example POST /department/{departmentId}/basket/calculated.

It is not necessary to provide prices and delivery dates in the basket, if your client side isn’t interested in validating them and report mutations. Orders will be created for nearest delivery dates with current prices. Parameter ignoreMutations can make API to create orders no matter if the basket actual or not.

Order session ID ¶

Second level of duplicate orders protection.

The idea behind is to give an unique ID to a user’s session, the context a person in. For example when a user puts the first product in the basket the client application can generate this ID and remember. After order was created and the client application have received “201 Created” status code from the server this ID can be forgotten until next basket (set of products) will be collected.

This orderSessionId parameter should be provided in POST /department/{departmentId}/order request to make server to check if an order is already created within this session (with this basket). The duplicate is possible because of poor internet connection, when the client application does “create order” request but receives no response. This makes basket to remain, user can do request again. This time, when client application provide the same orderSessionId, the server won’t create a duplicate, but rejects the request with status code 409.

Example URI

:[Schema](https://www.hogashop.ch/schema/basket.json)

Content-Type: application/json

[
  123,
  124
]

Content-Type: application/json

{message: "Wrong department ID", code: 4000}
{message: " ... any message about wrong basket schema ... ", code: 40017}
for example {message: "The object must contain the properties ["customer","parts"].","path":"/", code: 40017}
{message: "Unknown delivery strategy specified", code: 40014}
{message: "Basket data is expired", code: 40019}

Content-Type: application/json

{message: "You have no rights to create orders", code: 4036}

Content-Type: application/json

{message: "Customer not found. Id: %s", code: 40411}
{message: "Department not found. Id: %s", code: 40411}

Content-Type: application/json

{message: "Using this data an order has already been created (order session id = {orderSessionId}).", code: 4090}
{message: "Same products already were ordered", code: 4091}

any server error

POST/department/{departmentId}/order/basket-revision/{basket_revision}{?part,deliveryStrategy,allowDuplicates,ignoreMutations,ignorePriceDecreaseMutation,archive,orderSessionId,supplierReference}

Create an order using the basket stored at the server. See the detailed description in the POST /department/{departmentId}/order paragraph.

To make an order the client side should provide basket-revision. It protects from wrong orders, when basket has been updated by different client.

Example URI

Content-Type: application/json
Basket-Revision: {newRevisionNumber} - only for partial orders

[
  123,
  124
]

Content-Type: application/json

{message: "Wrong department ID", code: 4000}
{message: "Wrong revision number", code: 4000}
{message: "Wrong basket part", code: 4000}
{message: "Unknown delivery strategy specified", code: 40014}

Content-Type: application/json

{message: "You have no rights to create orders", code: 4036}
{message: "You have no rights to create archive orders", code: 4036}

Content-Type: application/json

{message: "Department not found. Id: %s", code: 40411}

Content-Type: application/json

{message: "Using this data an order has already been created (order session id = {orderSessionId}).", code: 4090}
{message: "Same products already were ordered", code: 4091}
{message: "Basket data is expired", code: 40019}

any server error