Envíos
Endpoint para gestionar el apartado de envíos. Está compuesto por recursos para administrar transportistas, tipos de envío, zonas de envío, ubicaciones, centros logísticos y secciones de envío.
</> GET / shippersDevuelve la lista de transportistas.
</> POST / shippersCrea un transportista.
</> GET / shippers/{id}Devuelve el transportista con el identificador interno indicado.
</> PUT / shippers/{id}Actualiza el transportista con el identificador interno indicado.
</> DELETE / shippers/{id}Elimina el transportista con el identificador interno indicado.
</> GET / shippers/getId/{pId}Devuelve el identificador interno del transportista.
</> GET / shippingTypesDevuelve la lista de tipos de envío.
</> POST / shippingTypesCrea un tipo de envío.
</> GET / shippingTypes/{id}Devuelve el tipo de envío con el identificador interno indicado.
</> PUT / shippingTypes/{id}Actualiza el tipo de envío con el identificador interno indicado.
</> DELETE / shippingTypes/{id}Elimina el tipo de envío con el identificador interno indicado.
</> GET / shippingTypes/getId/{pId}Devuelve el identificador interno del tipo de envío.
</> GET / shippingZonesDevuelve la lista de zonas de envío.
</> POST / shippingZonesCrea una zona de envío.
</> GET / shippingZones/{id}Devuelve la zona de envío con el identificador interno indicado.
</> PUT / shippingZones/{id}Actualiza la zona de envío con el identificador interno indicado.
</> DELETE / shippingZones/{id}Elimina la zona de envío con el identificador interno indicado.
</> GET / shippingZones/{id}/locationsDevuelve la lista de ubicaciones asociadas a la zona de envío.
</> POST / shippingZones/{id}/locationsAñade una ubicación a la zona de envío.
</> GET / shippingZones/{id}/logisticCentersDevuelve la lista de centros logísticos asociados a la zona de envío.
</> POST / shippingZones/{id}/logisticCentersAñade un centro logístico a la zona de envío.
</> GET / shippingZones/{id}/sectionsDevuelve la lista de secciones de envío de la zona especificada.
</> POST / shippingZones/{id}/sectionsCrea una sección de envío para la zona especificada.
</> GET / shippingZones/getId/{pId}Devuelve el identificador interno de la zona de envío.
</> DELETE / shippingZones/locations/{id}Elimina la ubicación de la zona de envío con el identificador interno indicado.
</> DELETE / shippingZones/logisticCenters/{id}Elimina el centro logístico de la zona de envío con el identificador interno indicado.
</> GET / shippingZones/sections/{id}Devuelve la sección de envío con el identificador interno indicado.
</> PUT / shippingZones/sections/{id}Actualiza la sección de envío con el identificador interno indicado.
</> DELETE / shippingZones/sections/{id}Elimina la sección de envío con el identificador interno indicado.
GET/shippers
Descripción
Devuelve la lista de transportistas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippers
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 indicado. Acepta un código de idioma base (ISO 639-1 de dos dígitos) o, cuando esté disponible, un código de idioma regional (como es-ES, en-GB o pt-BR). Más información en la documentación del API de Geolocation. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| sort | Opcional | name | string |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SHIPPERS": [
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"Correos Express",
"URL" :"https://www.correos.es/tracking/"
},
{
"LANGUAGE" :"ES-MX",
"NAME" :"Correos Express",
"URL" :"https://www.correos.mx/tracking/"
}
],
"LOGO" :"/images/correos.png",
"NAME" :"correos",
"PID" :"correos",
"URL" :"https://api.correos.es"
}
]
}
POST/shippers
Descripción
Crea un transportista.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippers
Parámetros de entrada JSON
{ "shippers": { "active":boolean, "languages": [ { "language":string, "languageCode":string, "name":string, "url":string } ], "logo":string, "name":string, "pId":string, "url":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippers | Obligatorio | struct | |
| Bloque de información que contiene la definición del transportista. | |||
| shippers/active | Opcional | false | boolean |
| Indica si el transportista está activo. | |||
| shippers/languages | Opcional | array [0:n] | |
| Bloque de idiomas del transportista. | |||
| shippers/languages/language | Opcional | string | |
| Alias del código de idioma aceptado en cada idioma del transportista. | |||
| shippers/languages/languageCode | Opcional | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| shippers/languages/name | Opcional | string | |
| Nombre localizado del transportista. | |||
| shippers/languages/url | Opcional | string | |
| URL localizada de seguimiento o del transportista. | |||
| shippers/logo | Opcional | string | |
| Ruta relativa o absoluta del logotipo del transportista. | |||
| shippers/name | Obligatorio | string | |
| Nombre interno del transportista. | |||
| shippers/pId | Obligatorio | string | |
| Identificador público del transportista. | |||
| shippers/url | Opcional | string | |
| URL base del transportista. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"Correos Express",
"URL" :"https://www.correos.es/tracking/"
},
{
"LANGUAGE" :"ES-MX",
"NAME" :"Correos Express",
"URL" :"https://www.correos.mx/tracking/"
}
],
"LOGO" :"/images/correos.png",
"NAME" :"correos",
"PID" :"correos",
"URL" :"https://api.correos.es"
}
GET/shippers/{id}
Descripción
Devuelve el transportista con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippers/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"Correos Express",
"URL" :"https://www.correos.es/tracking/"
},
{
"LANGUAGE" :"CA",
"NAME" :"Correos Express",
"URL" :"https://www.correos.es/tracking/"
}
],
"LOGO" :"/images/correos.png",
"NAME" :"Correos",
"PID" :"correos",
"URL" :"https://api.correos.es"
}
PUT/shippers/{id}
Descripción
Actualiza el transportista con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippers/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "shippers": { "active":boolean, "languages": [ { "language":string, "languageCode":string, "name":string, "url":string } ], "logo":string, "name":string, "pId":string, "url":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippers | Obligatorio | struct | |
| Bloque de información que contiene la definición del transportista. | |||
| shippers/active | Opcional | false | boolean |
| Indica si el transportista está activo. | |||
| shippers/languages | Opcional | array [0:n] | |
| Bloque de idiomas del transportista. | |||
| shippers/languages/language | Opcional | string | |
| Alias del código de idioma aceptado en cada idioma del transportista. | |||
| shippers/languages/languageCode | Opcional | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| shippers/languages/name | Opcional | string | |
| Nombre localizado del transportista. | |||
| shippers/languages/url | Opcional | string | |
| URL localizada de seguimiento o del transportista. | |||
| shippers/logo | Opcional | string | |
| Ruta relativa o absoluta del logotipo del transportista. | |||
| shippers/name | Opcional | string | |
| Nombre interno del transportista. | |||
| shippers/pId | Opcional | string | |
| Identificador público del transportista. | |||
| shippers/url | Opcional | string | |
| URL base del transportista. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"ID" : 1,
"LANGUAGES": [
{
"LANGUAGE" :"ES",
"NAME" :"Correos Express",
"URL" :"https://www.correos.es/tracking/"
},
{
"LANGUAGE" :"CA",
"NAME" :"Correos Express",
"URL" :"https://www.correos.es/tracking/"
}
],
"LOGO" :"/images/correos.png",
"NAME" :"Correos",
"PID" :"correos",
"URL" :"https://api.correos.es"
}
DELETE/shippers/{id}
Descripción
Elimina el transportista con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippers/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/shippers/getId/{pId}
Descripción
Devuelve el identificador interno del transportista.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippers/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
}
GET/shippingTypes
Descripción
Devuelve la lista de tipos de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingTypes
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 indicado. Acepta un código de idioma base (ISO 639-1 de dos dígitos) o, cuando esté disponible, un código de idioma regional (como es-ES, en-GB o pt-BR). Más información en la documentación del API de Geolocation. | |||
| q | Opcional | string | |
| Criterio de búsqueda. | |||
| shipperId | Obligatorio | numeric | |
| Identificador interno del transportista al que pertenecen los tipos de envío. | |||
| sort | Opcional | name | string |
| Variable de ordenación. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SHIPPINGTYPES": [
{
"ACTIVE" : true,
"DESCRIPTION" :"Standard shipping",
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"
Descripción
","LANGUAGE" :"ES",
"NAME" :"Envío estándar"
},
{
"DESCRIPTION" :"
Descripció
","LANGUAGE" :"CA",
"NAME" :"Enviament estàndard"
}
],
"NAME" :"Standard",
"PID" :"standard",
"PRIORITY" : 1,
"RESTRICTIVE" : false,
"SECTIONSWITHTAXINCLUDED" : false,
"SHIPPERID" : 1,
"TAXES": [
{
"TAXID" : 12
},
{
"TAXID" : 15
}
],
"TAXFIXEDVALUE" : true
}
]
}
POST/shippingTypes
Descripción
Crea un tipo de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingTypes
Parámetros de entrada JSON
{ "shippingTypes": { "active":boolean, "description":string, "languages": [ { "description":string, "language":string, "languageCode":string, "name":string } ], "name":string, "pId":string, "priority":numeric, "restrictive":boolean, "sectionsWithTaxIncluded":boolean, "shipperId":numeric, "taxFixedValue":boolean, "taxes": [ { "taxId":numeric } ] } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippingTypes | Obligatorio | struct | |
| Bloque de información que contiene la definición del tipo de envío. | |||
| shippingTypes/active | Opcional | false | boolean |
| Indica si el tipo de envío está activo. | |||
| shippingTypes/description | Opcional | string | |
| Descripción interna del tipo de envío. | |||
| shippingTypes/languages | Opcional | array [0:n] | |
| Bloque de idiomas del tipo de envío. | |||
| shippingTypes/languages/description | Opcional | string | |
| Descripción localizada del tipo de envío. | |||
| shippingTypes/languages/language | Opcional | string | |
| Alias del código de idioma aceptado en cada idioma del tipo de envío. | |||
| shippingTypes/languages/languageCode | Opcional | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| shippingTypes/languages/name | Opcional | string | |
| Nombre localizado del tipo de envío. | |||
| shippingTypes/name | Obligatorio | string | |
| Nombre interno del tipo de envío. | |||
| shippingTypes/pId | Obligatorio | string | |
| Identificador público del tipo de envío. | |||
| shippingTypes/priority | Opcional | 1 | numeric |
| Prioridad del tipo de envío. | |||
| shippingTypes/restrictive | Opcional | false | boolean |
| Indica si el tipo de envío es restrictivo (requiere permiso RESSH). | |||
| shippingTypes/sectionsWithTaxIncluded | Opcional | false | boolean |
| Indica si las secciones incluyen impuestos. | |||
| shippingTypes/shipperId | Obligatorio | numeric | |
| Identificador interno del transportista al que pertenece el tipo de envío. | |||
| shippingTypes/taxFixedValue | Opcional | true | boolean |
| Indica si el tipo de envío utiliza un valor de impuesto fijo. | |||
| shippingTypes/taxes | Opcional | array [0:n] | |
| Bloque de impuestos del tipo de envío. Solo se guarda si taxFixedValue es true. | |||
| shippingTypes/taxes/taxId | Obligatorio | numeric | |
| Identificador interno del impuesto LogiCommerce. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ACTIVE" : true,
"DESCRIPTION" :"Standard shipping",
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"
Descripción
","LANGUAGE" :"ES",
"NAME" :"Envío estándar"
},
{
"DESCRIPTION" :"
Descripció
","LANGUAGE" :"CA",
"NAME" :"Enviament estàndard"
}
],
"NAME" :"Standard",
"PID" :"standard",
"PRIORITY" : 1,
"RESTRICTIVE" : false,
"SECTIONSWITHTAXINCLUDED" : false,
"SHIPPERID" : 1,
"TAXES": [
{
"TAXID" : 12
},
{
"TAXID" : 15
}
],
"TAXFIXEDVALUE" : true
}
GET/shippingTypes/{id}
Descripción
Devuelve el tipo de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingTypes/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"DESCRIPTION" :"Standard shipping",
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"
Descripción
","LANGUAGE" :"ES",
"NAME" :"Envío estándar"
},
{
"DESCRIPTION" :"
Descripció
","LANGUAGE" :"CA",
"NAME" :"Enviament estàndard"
}
],
"NAME" :"Standard",
"PID" :"standard",
"PRIORITY" : 10,
"RESTRICTIVE" : false,
"SECTIONSWITHTAXINCLUDED" : false,
"SHIPPERID" : 1,
"TAXES": [
{
"TAXID" : 7
},
{
"TAXID" : 15
}
],
"TAXFIXEDVALUE" : true
}
PUT/shippingTypes/{id}
Descripción
Actualiza el tipo de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingTypes/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "shippingTypes": { "active":boolean, "description":string, "languages": [ { "description":string, "language":string, "languageCode":string, "name":string } ], "name":string, "pId":string, "priority":numeric, "restrictive":boolean, "sectionsWithTaxIncluded":boolean, "shipperId":numeric, "taxFixedValue":boolean, "taxes": [ { "taxId":numeric } ] } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippingTypes | Obligatorio | struct | |
| Bloque de información que contiene la definición del tipo de envío. | |||
| shippingTypes/active | Opcional | false | boolean |
| Indica si el tipo de envío está activo. | |||
| shippingTypes/description | Opcional | string | |
| Descripción interna del tipo de envío. | |||
| shippingTypes/languages | Opcional | array [0:n] | |
| Bloque de idiomas del tipo de envío. | |||
| shippingTypes/languages/description | Opcional | string | |
| Descripción localizada del tipo de envío. | |||
| shippingTypes/languages/language | Opcional | string | |
| Alias del código de idioma aceptado en cada idioma del tipo de envío. | |||
| shippingTypes/languages/languageCode | Opcional | string | |
| Etiqueta de idioma según el estándar internacional BCP 47. Las etiquetas base (p.ej. 'en') deben corresponder a un idioma base conectado al commerce; las variantes regionales (p.ej. 'en-US') deben corresponder a un idioma regionalizado conectado al commerce y requieren que el array 'languages' contenga también una entrada para su idioma base. | |||
| shippingTypes/languages/name | Opcional | string | |
| Nombre localizado del tipo de envío. | |||
| shippingTypes/name | Opcional | string | |
| Nombre interno del tipo de envío. | |||
| shippingTypes/pId | Opcional | string | |
| Identificador público del tipo de envío. | |||
| shippingTypes/priority | Opcional | 1 | numeric |
| Prioridad del tipo de envío. | |||
| shippingTypes/restrictive | Opcional | false | boolean |
| Indica si el tipo de envío es restrictivo (requiere permiso RESSH). | |||
| shippingTypes/sectionsWithTaxIncluded | Opcional | false | boolean |
| Indica si las secciones incluyen impuestos. | |||
| shippingTypes/shipperId | Opcional | numeric | |
| Identificador interno del transportista al que pertenece el tipo de envío. | |||
| shippingTypes/taxFixedValue | Opcional | true | boolean |
| Indica si el tipo de envío utiliza un valor de impuesto fijo. | |||
| shippingTypes/taxes | Opcional | array [0:n] | |
| Bloque de impuestos del tipo de envío. Solo se guarda si taxFixedValue es true. | |||
| shippingTypes/taxes/taxId | Obligatorio | numeric | |
| Identificador interno del impuesto LogiCommerce. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ACTIVE" : true,
"DESCRIPTION" :"Standard shipping",
"ID" : 1,
"LANGUAGES": [
{
"DESCRIPTION" :"
Descripción
","LANGUAGE" :"ES",
"NAME" :"Envío estándar"
},
{
"DESCRIPTION" :"
Descripció
","LANGUAGE" :"CA",
"NAME" :"Enviament estàndard"
}
],
"NAME" :"Standard",
"PID" :"standard",
"PRIORITY" : 10,
"RESTRICTIVE" : false,
"SECTIONSWITHTAXINCLUDED" : false,
"SHIPPERID" : 1,
"TAXES": [
{
"TAXID" : 7
},
{
"TAXID" : 15
}
],
"TAXFIXEDVALUE" : true
}
DELETE/shippingTypes/{id}
Descripción
Elimina el tipo de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingTypes/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/shippingTypes/getId/{pId}
Descripción
Devuelve el identificador interno del tipo de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingTypes/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
}
GET/shippingZones
Descripción
Devuelve la lista de zonas de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| shippingTypeId | Obligatorio | numeric | |
| Identificador interno del tipo de envío al que pertenecen las zonas de envío. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SHIPPINGZONES": [
{
"DESCRIPTION" :"European shipping zone",
"ID" : 1,
"NAME" :"Europe Zone",
"PID" :"zone-europe",
"SHIPPINGTYPEID" : 1
}
]
}
POST/shippingZones
Descripción
Crea una zona de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones
Parámetros de entrada JSON
{ "shippingZones": { "description":string, "name":string, "pId":string, "shippingTypeId":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippingZones | Obligatorio | struct | |
| Bloque de información que contiene la definición de la zona de envío. | |||
| shippingZones/description | Opcional | string | |
| Descripción de la zona de envío. | |||
| shippingZones/name | Obligatorio | string | |
| Nombre de la zona de envío. | |||
| shippingZones/pId | Obligatorio | string | |
| Identificador público de la zona de envío. | |||
| shippingZones/shippingTypeId | Obligatorio | numeric | |
| Identificador interno del tipo de envío al que pertenece la zona de envío. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"DESCRIPTION" :"European shipping zone",
"ID" : 1,
"NAME" :"Europe Zone",
"PID" :"zone-europe",
"SHIPPINGTYPEID" : 1
}
GET/shippingZones/{id}
Descripción
Devuelve la zona de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DESCRIPTION" :"European shipping zone",
"ID" : 1,
"NAME" :"Europe Zone",
"PID" :"zone-europe",
"SHIPPINGTYPEID" : 1
}
PUT/shippingZones/{id}
Descripción
Actualiza la zona de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "shippingZones": { "description":string, "name":string, "pId":string, "shippingTypeId":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippingZones | Obligatorio | struct | |
| Bloque de información que contiene la definición de la zona de envío. | |||
| shippingZones/description | Opcional | string | |
| Descripción de la zona de envío. | |||
| shippingZones/name | Opcional | string | |
| Nombre de la zona de envío. | |||
| shippingZones/pId | Opcional | string | |
| Identificador público de la zona de envío. | |||
| shippingZones/shippingTypeId | Opcional | numeric | |
| Identificador interno del tipo de envío al que pertenece la zona de envío. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"DESCRIPTION" :"European shipping zone",
"ID" : 1,
"NAME" :"Europe Zone",
"PID" :"zone-europe",
"SHIPPINGTYPEID" : 1
}
DELETE/shippingZones/{id}
Descripción
Elimina la zona de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/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/shippingZones/{id}/locations
Descripción
Devuelve la lista de ubicaciones asociadas a la zona de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1/locations
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"LOCATIONS": [
{
"COUNTRYID" : 195,
"ID" : 1,
"LOCATIONID" : 0
},
{
"COUNTRYID" : 73,
"ID" : 2,
"LOCATIONID" : 5432
}
]
}
POST/shippingZones/{id}/locations
Descripción
Añade una ubicación a la zona de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1/locations
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "locations": { "countryId":numeric, "locationId":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| locations | Obligatorio | struct | |
| Bloque de información que contiene la definición de la ubicación. | |||
| locations/countryId | Obligatorio | numeric | |
| Identificador interno del país. | |||
| locations/locationId | Obligatorio | numeric | |
| Identificador interno de la ubicación. Valor 0 indica país completo sin ubicación específica. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"COUNTRYID" : 195,
"ID" : 1,
"LOCATIONID" : 0
}
GET/shippingZones/{id}/logisticCenters
Descripción
Devuelve la lista de centros logísticos asociados a la zona de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1/logisticCenters
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"LOGISTICCENTERS": [
{
"ID" : 1,
"LOGISTICCENTERID" : 42
},
{
"ID" : 2,
"LOGISTICCENTERID" : 58
}
]
}
POST/shippingZones/{id}/logisticCenters
Descripción
Añade un centro logístico a la zona de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1/logisticCenters
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "logisticCenters": { "logisticCenterId":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| logisticCenters | Obligatorio | struct | |
| Bloque de información que contiene la definición del centro logístico. | |||
| logisticCenters/logisticCenterId | Obligatorio | numeric | |
| Identificador interno del centro logístico (warehouseGroupId). | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 1,
"LOGISTICCENTERID" : 42
}
GET/shippingZones/{id}/sections
Descripción
Devuelve la lista de secciones de envío de la zona especificada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1/sections
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"SHIPPINGSECTIONS": [
{
"AMOUNTS": [
{
"AMOUNT" : 5,
"CURRENCYID" : 1,
"MAXAMOUNT" : 50,
"MINAMOUNT" : 0
}
],
"ID" : 1,
"MAXWEIGHT" : 50,
"MINWEIGHT" : 0,
"PID" :"section-0-50",
"SHIPPINGZONEID" : 1
}
]
}
POST/shippingZones/{id}/sections
Descripción
Crea una sección de envío para la zona especificada.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/1/sections
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "shippingSections": { "amounts": [ { "amount":numeric, "currencyId":numeric, "maxAmount":numeric, "minAmount":numeric } ], "maxWeight":numeric, "minWeight":numeric, "pId":string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippingSections | Obligatorio | struct | |
| Bloque de información que contiene la definición de la sección de envío. | |||
| shippingSections/amounts | Obligatorio | array [1:n] | |
| Array de importes de precio para diferentes monedas. | |||
| shippingSections/amounts/amount | Obligatorio | numeric | |
| Importe del coste de envío. | |||
| shippingSections/amounts/currencyId | Obligatorio | numeric | |
| Identificador interno de la moneda. | |||
| shippingSections/amounts/maxAmount | Obligatorio | numeric | |
| Importe máximo del pedido para esta sección de envío. | |||
| shippingSections/amounts/minAmount | Obligatorio | numeric | |
| Importe mínimo del pedido para esta sección de envío. | |||
| shippingSections/maxWeight | Obligatorio | numeric | |
| Peso máximo del pedido para esta sección de envío (en kg). | |||
| shippingSections/minWeight | Obligatorio | numeric | |
| Peso mínimo del pedido para esta sección de envío (en kg). | |||
| shippingSections/pId | Obligatorio | string | |
| Identificador público de la sección de envío. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"AMOUNTS": [
{
"AMOUNT" : 5,
"CURRENCYID" : 1,
"MAXAMOUNT" : 50,
"MINAMOUNT" : 0
}
],
"ID" : 1,
"MAXWEIGHT" : 50,
"MINWEIGHT" : 0,
"PID" :"section-0-50",
"SHIPPINGZONEID" : 1
}
GET/shippingZones/getId/{pId}
Descripción
Devuelve el identificador interno de la zona de envío.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/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" : 1
}
DELETE/shippingZones/locations/{id}
Descripción
Elimina la ubicación de la zona de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/locations/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
}
DELETE/shippingZones/logisticCenters/{id}
Descripción
Elimina el centro logístico de la zona de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/logisticCenters/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/shippingZones/sections/{id}
Descripción
Devuelve la sección de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/sections/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AMOUNTS": [
{
"AMOUNT" : 5,
"CURRENCYID" : 1,
"MAXAMOUNT" : 50,
"MINAMOUNT" : 0
}
],
"ID" : 1,
"MAXWEIGHT" : 50,
"MINWEIGHT" : 0,
"PID" :"section-0-50",
"SHIPPINGZONEID" : 1
}
PUT/shippingZones/sections/{id}
Descripción
Actualiza la sección de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/sections/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "shippingSections": { "amounts": [ { "amount":numeric, "currencyId":numeric, "maxAmount":numeric, "minAmount":numeric } ], "maxWeight":numeric, "minWeight":numeric, "pId":string, "shippingZoneId":numeric } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| shippingSections | Obligatorio | struct | |
| Bloque de información que contiene la definición de la sección de envío. | |||
| shippingSections/amounts | Opcional | array [0:n] | |
| Array de importes de precio para diferentes monedas. | |||
| shippingSections/amounts/amount | Obligatorio | numeric | |
| Importe del coste de envío. | |||
| shippingSections/amounts/currencyId | Obligatorio | numeric | |
| Identificador interno de la moneda. | |||
| shippingSections/amounts/maxAmount | Obligatorio | numeric | |
| Importe máximo del pedido para esta sección de envío. | |||
| shippingSections/amounts/minAmount | Obligatorio | numeric | |
| Importe mínimo del pedido para esta sección de envío. | |||
| shippingSections/maxWeight | Opcional | numeric | |
| Peso máximo del pedido para esta sección de envío (en kg). | |||
| shippingSections/minWeight | Opcional | numeric | |
| Peso mínimo del pedido para esta sección de envío (en kg). | |||
| shippingSections/pId | Opcional | string | |
| Identificador público de la sección de envío. | |||
| shippingSections/shippingZoneId | Opcional | numeric | |
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AMOUNTS": [
{
"AMOUNT" : 5,
"CURRENCYID" : 1,
"MAXAMOUNT" : 50,
"MINAMOUNT" : 0
}
],
"ID" : 1,
"MAXWEIGHT" : 50,
"MINWEIGHT" : 0,
"PID" :"section-0-50",
"SHIPPINGZONEID" : 1
}
DELETE/shippingZones/sections/{id}
Descripción
Elimina la sección de envío con el identificador interno indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/shippingZones/sections/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
}