Canales de venta
Endpoint para gestionar el apartado de canales de venta.
</> GET / channels/{id}/physicalLocationsDevuelve las ubicaciones físicas vinculadas al canal de venta
</> POST / channels/{id}/physicalLocationsVinculación de una ubicación física al canal de venta
</> PUT / channels/{id}/physicalLocations/{physicalLocationId}Edición de la ubicación física para el canal de venta
</> DELETE / channels/{id}/physicalLocations/{physicalLocationId}Desvinculación de la ubicación física al canal de venta
</> GET / channels/getId/{pId}Devuelve el identificador interno del canal de venta
GET /channels/{id}/physicalLocations
Descripción
Devuelve las ubicaciones físicas vinculadas al canal de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/channels/1/physicalLocations
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PHYSICALLOCATIONS": [
{
"DELIVERYPOINT" : true,
"HEADQUARTER": {
"ID" : 123,
"PID" :"abc"
},
"PHYSICALLOCATION": {
"ID" : 123,
"PID" :"abc"
},
"RETURNPOINT" : false,
"ZONERADIUS" : 50
}
]
}
POST /channels/{id}/physicalLocations
Descripción
Vinculación de una ubicación física al canal de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/channels/1/physicalLocations
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "channelPhysicalLocations": { "deliveryPoint":boolean, "headquarter": { "id":numeric, "pId":string }, "physicalLocation": { "id":numeric, "pId":string }, "returnPoint":boolean, "zoneRadius":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| channelPhysicalLocations | Obligatorio | struct | |
| Bloque de información que contiene la definición de la ubicación física para el canal de venta | |||
| channelPhysicalLocations/deliveryPoint | Opcional | false | boolean |
| Indica si la ubicación física es un punto de entrega. | |||
| channelPhysicalLocations/headquarter | Opcional | struct | |
| Bloque que define la delegación. | |||
| channelPhysicalLocations/headquarter/id | Opcional | 0 | numeric |
| Identificador interno de la delegación. Opcional en caso que se use identificador público. | |||
| channelPhysicalLocations/headquarter/pId | Opcional | string | |
| Identificador público de la delegación. Opcional en caso que se use identificador interno. | |||
| channelPhysicalLocations/physicalLocation | Obligatorio | struct | |
| Bloque que define la ubicación física de la vinculación. | |||
| channelPhysicalLocations/physicalLocation/id | Opcional | 0 | numeric |
| Identificador interno de la ubicación física. Opcional en caso que se use identificador público. | |||
| channelPhysicalLocations/physicalLocation/pId | Opcional | string | |
| Identificador público de la ubicación física. Opcional en caso que se use identificador interno. | |||
| channelPhysicalLocations/returnPoint | Opcional | false | boolean |
| Indica si la ubicación física es un punto de devolución. | |||
| channelPhysicalLocations/zoneRadius | Opcional | 0 | numeric |
| Indica el radio de distancia (en km) del área de influencia de la ubicación física. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"PHYSICALLOCATIONS": [
{
"DELIVERYPOINT" : true,
"HEADQUARTER": {
"ID" : 123,
"PID" :"abc"
},
"PHYSICALLOCATION": {
"ID" : 123,
"PID" :"abc"
},
"RETURNPOINT" : false,
"ZONERADIUS" : 50
}
]
}
PUT /channels/{id}/physicalLocations/{physicalLocationId}
Descripción
Edición de la ubicación física para el canal de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/channels/1/physicalLocations/{physicalLocationId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| physicalLocationId | Obligatorio | numeric | |
| Identificador interno de la ubicación física. | |||
Parámetros de entrada JSON
{ "channelPhysicalLocations": { "deliveryPoint":boolean, "headquarter": { "id":numeric, "pId":string }, "returnPoint":boolean, "zoneRadius":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| channelPhysicalLocations | Obligatorio | struct | |
| Bloque de información que contiene la definición de la ubicación física para el canal de venta | |||
| channelPhysicalLocations/deliveryPoint | Opcional | false | boolean |
| Indica si la ubicación física es un punto de entrega. | |||
| channelPhysicalLocations/headquarter | Opcional | struct | |
| Bloque que define la delegación. | |||
| channelPhysicalLocations/headquarter/id | Opcional | 0 | numeric |
| Identificador interno de la delegación. Opcional en caso que se use identificador público. | |||
| channelPhysicalLocations/headquarter/pId | Opcional | string | |
| Identificador público de la delegación. Opcional en caso que se use identificador interno. | |||
| channelPhysicalLocations/returnPoint | Opcional | false | boolean |
| Indica si la ubicación física es un punto de devolución. | |||
| channelPhysicalLocations/zoneRadius | Opcional | 0 | numeric |
| Indica el radio de distancia (en km) del área de influencia de la ubicación física. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PHYSICALLOCATIONS": [
{
"DELIVERYPOINT" : true,
"HEADQUARTER": {
"ID" : 123,
"PID" :"abc"
},
"PHYSICALLOCATION": {
"ID" : 123,
"PID" :"abc"
},
"RETURNPOINT" : false,
"ZONERADIUS" : 50
}
]
}
DELETE /channels/{id}/physicalLocations/{physicalLocationId}
Descripción
Desvinculación de la ubicación física al canal de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/channels/1/physicalLocations/{physicalLocationId}
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"PHYSICALLOCATIONS": [
{
"DELIVERYPOINT" : true,
"HEADQUARTER": {
"ID" : 123,
"PID" :"abc"
},
"PHYSICALLOCATION": {
"ID" : 123,
"PID" :"abc"
},
"RETURNPOINT" : false,
"ZONERADIUS" : 50
}
]
}
GET /channels/getId/{pId}
Descripción
Devuelve el identificador interno del canal de venta
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/channels/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
}