Datos de entrega en la API
Copiar enlace al artículo
Copiado

Estructura de datos de entrega general

Los datos de entrega de integración están disponibles para las versiones de API v3, v4, v5.

En los métodos /api/v*/orders y /api/v*/orders/history, el campo orders[][delivery] es responsable de los datos de entrega, en otros métodos /api/v*/orders* - el campo [TRANSLATE_PLACEHOLDER_2186]]

Estructura de mensaje para los métodos /api/v*/orders/get, /api/v*/orders, /api/v*/orders/history:

"order": {
 // ...
 "entrega": {
 "code": "delivery-type-code", // Código simbólico del tipo de entrega
 "integrationCode": "correos", // Código de entrega de integración asociado con el tipo de entrega
 "data": {// Datos adicionales para la entrega de la integración
 // Los datos difieren según
 // de la entrega de integración especificada
 },
 "service": {// Servicio de entrega
 "name": "Servicio de entrega 1",
 "código": "entrega-servicio-1"
 },
 "costo": 5, // costo de envío
 "date": "2014-10-26", // Fecha de entrega
 "address": {// dirección de entrega
 // ...
 }
 }
 }
} 

La estructura del mensaje para los métodos /api/v*/orders/create, /api/v*/orders/edit, /api/v*/orders/upload difiere según el tipo de envío, ya sea de integración o no. Para la entrega de la integración, se especifica adicionalmente el campo data, que contiene datos adicionales para la entrega de la integración. Para obtener más información sobre la descripción de este campo para cada tipo de entrega de integración, consulte la sección Datos de entrega de integración.

Un ejemplo de una solicitud para crear / editar un pedido con entrega sin integración:

"order": {
 // ...
 "entrega": {
 "código": "código de tipo de entrega",
 "Servicio": {
 "name": "Servicio de entrega 1",
 "código": "entrega-servicio-1"
 },
 "costo": 5,
 "fecha": "2014-10-26",
 "habla a": {
 // ...
 }
 }
 }
} 

Un ejemplo de una solicitud para crear / editar un pedido con entrega de integración Correos:

"order": {
 // ...
 "entrega": {
 "code": "Correos",
 "datos": {
 "trackNumber": "EA349651005ES"
 },
 "costo": 5,
 "fecha": "2014-10-26",
 "habla a": {
 // ...
 }
 }
 }
} 

Estructura de datos de la dirección de envío

La dirección de entrega order[delivery][address] se puede especificar en forma de cadena en el campo order[delivery][address][text], o en forma detallada, completando todos los campos excepto order[delivery][address][text]. Un ejemplo de una solicitud con el llenado detallado de todos los campos de la dirección de entrega:

"order": {
 // ...
 "entrega": {
 // ...
 "habla a": {
 "index": "28046", // Código postal
 "region": "Madrid", // Región
 "regionId": 55, // ID de región en geohelper
 "city": "Madrid", // Ciudad
 "cityId": 4995, // ID de la ciudad en geohelper
 "cityType": "g.", // Tipo de asentamiento
 "street": "Paseo de Castellana", // Calle
 "streetId": 1777167, // ID de calle en geohelper
 "streetType": "street", // Tipo de calle
 "building": "146", // Número de casa
 "flat": "13", // Número de apartamento u oficina
 "piso": 5, // Piso
 "bloque": 3, // Entrada
 "casa": "1", // Edificio
 "vivienda": "1", // vivienda
 "metro": "Santiago Bernabeu", // Metro
 "notes": "2nd checkpoint" // Notas adicionales
 "deliveryTime": "de 10:00 a 12:00" // Hora de entrega
 }
 }
 }
} 

Un ejemplo de una solicitud con una dirección de entrega de cadena:

"order": {
 // ...
 "entrega": {
 // ...
 "habla a": {
 "índice": "614030",
 "ciudad": "Malaga",
 "text": "Paseo del parque, 26, apto. 18"
 }
 }
 }
} 

Datos de entrega de integración

Puede ver los métodos de interacción con las entregas de integración en la referencia de métodos de API. Debe encontrar el campo order[delivery][data] y seleccionar el servicio de entrega que necesita en la selección.

Restricciones al editar pedidos con entregas integradas

Al editar un pedido a través de la API con una entrega integrada '' '' '' ', se aplican restricciones. Dependiendo del tipo de entrega, no puede cambiar los datos en los siguientes campos:

Correos

order[weight]

order[length]

order[width]

order[height]

order[phone]

order[deliveryCost]

order[paymentType]

order[shipmentStore]

order[delivery][address]

DPD

order[weight]

order[manager]

order[phone]

order[firstName]

order[lastName]

order[deliveryCost]

order[paymentType]

order[shipmentStore]

order[delivery][address]

Nuevo correo

order[weight]

order[customer]

order[phone]

order[deliveryCost]

order[paymentType]

order[shipmentStore]

order[delivery][address]

Revisa

order[weight]

order[firstName]

order[lastName]

order[phone]

order[deliveryCost]

order[paymentType]

order[shipmentStore]

order[delivery][address]

Gracias por tus comentarios.
¿Te resultó útil este artículo
No
  • Рекомендации не помогли
  • Нет ответа на мой вопрос
  • Текст трудно понять
  • Не нравится описанный функционал
Si
Artículo anterior
Ejemplos de mensajes de error de API
Al acceder a la API, pueden aparecer errores, que el sistema informará. En este artículo veremos los principales tipos de errores.
Artículo siguiente
Cómo integrar el servicio de entrega a través de la API
Cómo integrar el servicio de entrega a través de la API