Ubicaciones físicas
Endpoint para gestionar el apartado de ubicaciones físicas.
</> GET / physicalLocationsDevuelve la lista de ubicaciones físicas.
</> POST / physicalLocationsCreación de una ubicaciones física
</> GET / physicalLocations/{id}Devuelve la ubicaciones físicas con el identificador interno indicado
</> PUT / physicalLocations/{id}Edición de la ubicación física con el identificador especificado.
</> DELETE / physicalLocations/{id}Elimina la ubicación física con el identificador especificado.
</> GET / physicalLocations/getId/{pId}Devuelve el identificador interno de la ubicación física
GET /physicalLocations
Descripción
Devuelve la lista de ubicaciones físicas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/physicalLocations
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| languageCode | Opcional | string | |
| Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. | |||
| page | Opcional | 1 | numeric |
| Nº de página solicitada. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/physicalLocations?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
},
"PHYSICALLOCATIONS": [
{
"ACTIVE" : 1,
"ADDRESS" :"Bisbe Torres i Bages, 3",
"CITY" :"Igualada",
"COUNTRYID" : 724,
"EMAIL" :"",
"ID" : 1,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LATITUDE" : 41.583182,
"LOCATIONID" : 15916328,
"LONGITUDE" : 1.612641,
"NAME" :"TLG Commerce",
"PHONE" :"",
"PID" :"TLG",
"POSTALCODE" :"08700",
"STATE" :"Barcelona",
"VISIBLEONMAP" : 1
}
]
}
POST /physicalLocations
Descripción
Creación de una ubicaciones física
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/physicalLocations
Parámetros de entrada JSON
{ "physicalLocations": { "countryCode":string, "languages": [ { "languageCode":string, "information": string } ], "pId": string "active": boolean "address": string "city": string "email": string "latitude": numeric "locationId": numeric "longitude": numeric "name": string "notificationEmail": string "phone": string "postalCode": string "state": string "visibleOnMap": boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| physicalLocations | Obligatorio | struct | |
| Bloque de información que contiene la definición de la ubicación física | |||
| physicalLocations/active | Opcional | false | boolean |
| Indica si la ubicación física está activa | |||
| physicalLocations/address | Opcional | string | |
| Indica la dirección de la ubicación física | |||
| physicalLocations/city | Opcional | string | |
| Indica el nombre de la ciudad de la ubicación física | |||
| physicalLocations/countryCode | Obligatorio | string | |
| Devuelve elementos asociados al país. Formato ISO 3166-1 alpha-2. Más información en el recurso: util/countries. | |||
| physicalLocations/email | Opcional | string | |
| correo electrónico de la ubicación física | |||
| physicalLocations/languages | Opcional | array [0:n] | |
| Bloque de idiomas de la ubicación física | |||
| physicalLocations/languages/information | Opcional | string | |
| Información adicional de la ubicación física | |||
| physicalLocations/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| physicalLocations/latitude | Opcional | 0 | numeric |
| Latitud de la ubicación física | |||
| physicalLocations/locationId | Opcional | numeric | |
| Identificador interno de una zona dentro de un país. | |||
| physicalLocations/longitude | Opcional | 0 | numeric |
| Longitud de la ubicación física | |||
| physicalLocations/name | Opcional | string | |
| Nombre interno de la ubicación física | |||
| physicalLocations/notificationEmail | Opcional | string | |
| physicalLocations/pId | Obligatorio | string | |
| Identificador público de la ubicación física | |||
| physicalLocations/phone | Opcional | string | |
| Indica el número de teléfono de la ubicación física | |||
| physicalLocations/postalCode | Opcional | string | |
| Indica el CP de la ubicación física | |||
| physicalLocations/state | Opcional | string | |
| Provincia de la ubicación física | |||
| physicalLocations/visibleOnMap | Opcional | false | boolean |
| Visible en el mapa | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ADDRESS" :"Bisbe Torres i Bages, 3",
"CITY" :"Igualada",
"COUNTRYID" : 724,
"EMAIL" :"",
"ID" : 1,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LATITUDE" : 41.583182,
"LOCATIONID" : 15916328,
"LONGITUDE" : 1.612641,
"NAME" :"TLG Commerce",
"PHONE" :"",
"PID" :"TLG",
"POSTALCODE" :"08700",
"STATE" :"Barcelona",
"VISIBLEONMAP" : 1
}
GET /physicalLocations/{id}
Descripción
Devuelve la ubicaciones físicas con el identificador interno indicado
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/physicalLocations/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ADDRESS" :"Bisbe Torres i Bages, 3",
"CITY" :"Igualada",
"COUNTRYID" : 724,
"EMAIL" :"",
"ID" : 1,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LATITUDE" : 41.583182,
"LOCATIONID" : 15916328,
"LONGITUDE" : 1.612641,
"NAME" :"TLG Commerce",
"PHONE" :"",
"PID" :"TLG",
"POSTALCODE" :"08700",
"STATE" :"Barcelona",
"VISIBLEONMAP" : 1
}
PUT /physicalLocations/{id}
Descripción
Edición de la ubicación física con el identificador especificado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/physicalLocations/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "physicalLocations": { "countryCode":string, "languages": [ { "languageCode":string, "information": string } ], "pId": string "active": boolean "address": string "city": string "email": string "latitude": numeric "locationId": numeric "longitude": numeric "name": string "notificationEmail": string "phone": string "postalCode": string "state": string "visibleOnMap": boolean } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| physicalLocations | Obligatorio | struct | |
| Bloque de información que contiene la definición de la ubicación física | |||
| physicalLocations/active | Opcional | false | boolean |
| Indica si la ubicación física está activa | |||
| physicalLocations/address | Opcional | string | |
| Indica la dirección de la ubicación física | |||
| physicalLocations/city | Opcional | string | |
| Indica el nombre de la ciudad de la ubicación física | |||
| physicalLocations/countryCode | Opcional | string | |
| Devuelve elementos asociados al país. Formato ISO 3166-1 alpha-2. Más información en el recurso: util/countries. | |||
| physicalLocations/email | Opcional | string | |
| correo electrónico de la ubicación física | |||
| physicalLocations/languages | Opcional | array [0:n] | |
| Bloque de idiomas de la ubicación física | |||
| physicalLocations/languages/information | Opcional | string | |
| Información adicional de la ubicación física | |||
| physicalLocations/languages/languageCode | Obligatorio | string | |
| Indica el código de idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages. | |||
| physicalLocations/latitude | Opcional | 0 | numeric |
| Latitud de la ubicación física | |||
| physicalLocations/locationId | Opcional | numeric | |
| Identificador interno de una zona dentro de un país. | |||
| physicalLocations/longitude | Opcional | 0 | numeric |
| Longitud de la ubicación física | |||
| physicalLocations/name | Opcional | string | |
| Nombre interno de la ubicación física | |||
| physicalLocations/notificationEmail | Opcional | string | |
| physicalLocations/pId | Obligatorio | string | |
| Identificador público de la ubicación física | |||
| physicalLocations/phone | Opcional | string | |
| Indica el número de teléfono de la ubicación física | |||
| physicalLocations/postalCode | Opcional | string | |
| Indica el CP de la ubicación física | |||
| physicalLocations/state | Opcional | string | |
| Provincia de la ubicación física | |||
| physicalLocations/visibleOnMap | Opcional | false | boolean |
| Visible en el mapa | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : 1,
"ADDRESS" :"Bisbe Torres i Bages, 3",
"CITY" :"Igualada",
"COUNTRYID" : 724,
"EMAIL" :"",
"ID" : 1,
"LANGUAGES": [
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"ES",
"LINKFOLLOWING" : true
},
{
"BANNERALT" :"banner alt",
"BANNERIMAGE" :"banner.jpg",
"DESTINATIONURL" :"http://www.aaaa.com",
"LANGUAGE" :"EN",
"LINKFOLLOWING" : true
}
],
"LATITUDE" : 41.583182,
"LOCATIONID" : 15916328,
"LONGITUDE" : 1.612641,
"NAME" :"TLG Commerce",
"PHONE" :"",
"PID" :"TLG",
"POSTALCODE" :"08700",
"STATE" :"Barcelona",
"VISIBLEONMAP" : 1
}
DELETE /physicalLocations/{id}
Descripción
Elimina la ubicación física con el identificador especificado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/physicalLocations/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 1
}
GET /physicalLocations/getId/{pId}
Descripción
Devuelve el identificador interno de la ubicación física
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/physicalLocations/getId/abc
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| pId | Obligatorio | string | |
| Identificador público. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 143
}