Skip to content

getByIdWarehouse

Request

Path
idinteger, (int32)required
GET
/api/v1/warehouse/{id}
curl -i -X GET \
  'https://api.prana.software/api/v1/warehouse/{id}'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
codestring, non-emptyrequired

Warehouse code (unique per warehouse).

Default:""
Example:"ALM01"
nationalIdentityCardstring

National Identity Card associated to the warehouse.

Default:""
Example:"12345678A"
descriptionstring

Warehouse description.

Default:""
Example:"Central warehouse"
addressstring

Street address of the warehouse.

Default:""
Example:"Av. de la Industria, 23"
postalCodestring

Postal code.

Default:""
Example:"03001"
populationstring

Population or locality (city/town) of the warehouse.

Default:""
Example:"Alicante"
countryobject(ApiCountryListReadDto)

Country information. See CountryListReadDto.java for structure.

Default:""
stateobject(ApiStateListReadDto)

State information. See StateListReadDto.java for structure.

Default:""
phone1string

First contact phone number.

Default:""
Example:"+34965123456"
phone2string

Second contact phone number.

Default:""
Example:"+34965111111"
emailstring

Contact email address for the warehouse.

Default:""
Example:"warehouse@company.com"
contactPersonstring
activeboolean
Response
{
  "id": "",
  "code": "ALM01",
  "nationalIdentityCard": "12345678A",
  "description": "Central warehouse",
  "address": "Av. de la Industria, 23",
  "postalCode": "03001",
  "population": "Alicante",
  "country": null,
  "state": {
    "id": "",
    "code": "28",
    "description": "Madrid",
    "country": null,
    "isoCode": "ES-M"
  },
  "phone1": "+34965123456",
  "phone2": "+34965111111",
  "email": "warehouse@company.com",
  "contactPerson": "string",
  "active": true
}