Skip to content

Get a location by Id

get
https://api.mercadoe.com/v1/locations/{locationId}

Retrieves information about a specific location with the given LocationId.

Request

Path Parameters

locationId
int32
required
the request id

Responses

200
404
Success

Body

application/json
locationId
int32
Me Location code
locationName
string | null
Location name
clientLocationId
string | null
Location code in the client’s ERP
address
string | null
Address
addressNumber
string | null
Address number
neighborhood
string | null
Neighborhood
complement
string | null
Address complement
city
string | null
City
state
string | null
State
postalCode
string | null
Postal code
country
string | null
Country
contact
string | null
Contact name
phoneNumber
string | null
Phone number
locationType
string
allowed values: UnknownDeliveryPlaceShippingPlaceInvoicingPlaceBillingPlaceReceivingPlaceCollectingPlace
businessOrganizations
array of object
List with the business organizations, consisting of the Company Code and the bussiness structure code and description.
companyNationalRegistration
object
isDeactivated
boolean | null
Flag to identify if the location is blocked.