Get Locations Details API (New API)(Beta)

Inbound | GET | /locations

Summary

This API is used to fetch location details for a given location code mapped to a channel in Increff system.

Description

Front-end system can call this API to get details of a location which is mapped to a channel in Increff system.

These details can be further used by the front-end system to improve the customer experience during pre-order and post order phases.

Request

Empty

Response

{
  "locationData": [
    {
      "locationCode": "string",
      "cimsLocationId": 0,
      "omsLocationId": 0,
      "channelWarehouseId":"string",
      "locationAddress": {
        "city": "Banglore",
        "contact_email": "rahul@increff.com",
        "contact_name": "Rahul",
        "contact_phone": "9988998899",
        "country": "INDIA",
        "state": "KA",
        "street1": "1",
        "street2": "2",
        "street3": "3",
        "zip": "560102"
      },
      "locationType": "STORE"
    }
  ]
}

Data types for Fields

Field	Data Type	Description	Mandatory/ Non Mandatory
`cimsLocationId`	Long	Unique code to identify a location in CIMS	Yes
`omsLocationId`	Long	Unique code to identify a location in OMS	Yes
`channelWarehouseId`	String	Unique identifier at channel’s end for a warehouse	Yes
`locationType`	LocationType	(STORE/ WAREHOUSE/USP)	Yes
`locationCode`	String	Unique code to identify a location	Yes
`locationAddress`	Address	location address	Yes
`locationAddress.name`	String	Customer name	Yes
`locationAddress.street1`	String	Address line 1	Yes
`locationAddress.street2`	String	Address line2	Yes
`locationAddress.street3`	String	Address line3	Yes
`locationAddress.phone`	String	Phone number	Yes
`locationAddress.email`	String	Email	Yes
`locationAddress.city`	String	City	Yes
`locationAddress.state`	String	State	Yes
`locationAddress.zip`	String	Zip code	Yes
`locationAddress.country`	String	Country	Yes