Generar Recolección

POST 
/pickup/create

Este endpoint permite la creación de una solicitud de recolección para servicios de paquetería. Al invocar este método, los usuarios pueden especificar la paquetería de la que desean solicitar la recolección, lo que permite una integración eficiente con múltiples proveedores de servicio.

En el cuerpo de la solicitud, se deben incluir varios datos clave para procesar la recolección. Esto incluye: Identificación de la paquetería, Dirección de la recolección, Dimensiones del paquete y Horarios disponibles de recolección.

Este endpoint es esencial para automatizar el proceso de recolección, brindando a los usuarios una manera fácil y rápida de programar la recogida de sus paquetes, mejorando la experiencia del cliente y la eficiencia operativa del servicio de paquetería.

Request

Header Parameters

Authorization anyrequired

Bearer "access_token".

shop_id anyrequired

Identificador único de tienda.

application/json

Body

required

mensajeria stringrequired

Nombre de mensajería: DHL, FEDEX, UPS.

nombre_contacto stringrequired

Nombre de contacto.

apellidos_contacto stringrequired

Apellido de contacto.

email stringrequired

Email de contacto.

calle stringrequired

Calle donde sera la recolección.

numero stringrequired

Número donde sera la recolección.

colonia stringrequired

Colonia donde sera la recolección.

telefono stringrequired

Telefono de contacto.

estado stringrequired

Estado donde sera la recolección.

municipio stringrequired

Municipio donde sera la recolección.

codigo_postal stringrequired

Código postal donde sera la recolección.

referencias stringrequired

Referencias.

cantidad_piezas integerrequired

Cantidad de piezas recolectadas.

peso integerrequired

Peso total del paquete.

largo integerrequired

Largo en cm que tiene el paquete.

ancho integerrequired

Ancho en cm que tiene el paquete.

alto integerrequired

Alto en cm que tiene el paquete.

fecha stringrequired

Fecha de recolección.

hora_inicio stringrequired

Hora de apertura de comercio.

horario_cierre stringrequired

Hora de cierre.

comercio_id stringrequired

Identificador único de tienda en API Identity.

Responses

200

Respuesta de petición de generación de recolección. El campo "detail" contiene los datos retornados de la generación de la guía.

Response Headers

application/json

Schema

Schema

success boolean

Indica si la petición fue exitosa o no.

message string

Mensaje mostrado cuando se obtiene la respuesta de una recolección.

detail

object

Detalle de la respuesta.

recoleccion

object

Detalle de la recolección.

mensaje string

Mensaje de respuesta.

location string

Locación (url).

pick_up string

Número de recolección.

status string

Success | Error.

localizacion string

Localización.

Example (from schema)

{
  "success": boolean,
  "message": "string",
  "detail": {
    "recoleccion": {
        "location": "string",
        "pick_up": "string",
        "localizacion": "string",
    }
  }
}

Estructura de Response

{
  "success": true,
  "message": "Petición exitosa!",
  "detail": {
    "recoleccion": {
        "location": "https//xmlpitest-ea-dhl.com/XMLShippingServlet?isUTF8Supportt=true",
        "pick_up": "321",
        "localizacion": "HPU",
    }
  }
}

400

Posibles errores debido a que no existe la cotización.

Response Headers

application/json

Schema

Schema

success boolean

Indica si la petición fue exitosa o no.

message string

Mensaje mostrado cuando se obtiene la respuesta de una recolección.

detail

object

Detalle de la respuesta de error obtenida.

recoleccion

object

Detalle del error.

mensaje string

Mensaje de respuesta.

location string

Locación (url).

pick_up string

Número de recolección.

status string

Success | Error.

localizacion string

Localización.

Example (from schema)

{
  "success": boolean,
  "message": "string",
  "detail": {
    "recoleccion": {
        "status": "string",
        "mensaje": "string",
    }
  }
}

Error

{
  "success": false,
  "message": "Error al procesar petición",
  "detail": {
    "recoleccion": {
        "status": "Error",
        "mensaje": "Mensaje de error regresado por la mensajería",
    }
  }
}

Loading...