Guides

Store API

The store API allows to register, update and delete the business stores so they are properly mantained and updated. Keeping the store master updated in Wapping is important as it will be used to allow connections for the Checkout API trough each store code, or to show the store location to customers.


📘

Note that this API is not always integrated, and will only be necessary in environments with a high number of stores, which can experience multiple openings and closings.
Wapping provides a way to manually create and delete stores trough the Wapping Manager.

The Store API Reference can be consulted to view information in detail for each method and object.

The Store API Swagger is also accessible in the endpoint, to interact directly with the API.


The API includes five controllers:

  • Store: Main controller to manage the creation, deletion and updates over Stores.
  • Store Status: Allows handling customized store status relevant for the business
  • Store Type: Used to caracterize different types of store, flexible to allow custom categorizations as in big/small, street/mall, etc
  • User: Controller to handle the store user personnel.
  • Store Group: Controller to handle the groups of store

The store creation request, both minimal and full JSON.

{
  "codeStore": "string",
  "name": "string",
  "enumTypeStoreId": 0,
  "groupOfStoreId": 0
}
{
  "codeStore": "string", 
  "name": "string",
  "imageB64": { 
    "base64": "string",
    "name": "string",
    "position": 0
  },
  "deleteImage": false, 
  "imageUriBlob": "string", 
  "enumTypeStoreId": 0, 
  "groupOfStoreId": 0,
  "groupOfStoreName": "string", 
  "surfaceM2": 0, 
  "visibleApp": true, 
  "description": "string", 
  "contact": { 
    "name": "string",
    "surname": "string",
    "email": "string",
    "mobile": "string",
    "phone": "string"
  },
  "address": { 
    "country": "string",
    "postalCode": "string",
    "streetAddress": "string",
    "route": "string",
    "streetNumber": "string",
    "sublocality": "string",
    "locality": "string",
    "administrativeAreaLevel1": "string",
    "administrativeAreaLevel2": "string",
    "administrativeAreaLevel3": "string",
    "storeTypeId": 0,
    "storeStatusId": 0,
    "latitude": 0,
    "longitude": 0
  },
  "calendarOpenId": 0, 
  "businessId": 0 
}

Also available with the field explanation


Integration Steps

Create Store Groups
Begin by creating store groups. If your business has a defined grouping logic, follow it; otherwise, create a default group.

Optional: Create Store Assistants
Store assistants can be added manually, though this is usually unnecessary since they can be automatically registered during the checkout process. The option remains available if needed.

Optional: Create store Types

The types can also be created if there is an already existing categorization of stores, to handle different types as in street/mall, big/small surfaces, super/hiper, etc.

Optional: Create store status

If the status is a relevant information in the business, they can be modelled through this controller.

The usual functionality is to reflect if a store is open, closed, renovations, etc.

Register Stores
Finally, register the stores using the Store controller and the Create method.