Te presentamos la documentación de nuestra API donde podrás ver la especificación de nuestros métodos para integrarte y los ambientes con los que contamos.
Ambientes
SANDBOX
Estado: Activo
check_circle
https://api.uat.pickit.com.ar/index.php
https://api.uat.pickit.com.uy/index.php
https://api.uat.pickit.com.mx/index.php
https://api.uat.pickit.com.co/index.php
PRODUCCIÓN
Estado: Activo
check_circle
https://api.pickit.net
https://api.pickit.com.uy/index.php
https://api.pickit.com.mx/index.php
https://api.pickit.com.co/index.php
Estructura
ServiceType: Tipo de servicio. (enum string)
- 'SP' -> Store Pickup
- 'PP' -> Punto Pickit
- 'PL' -> Locker
- 'ST' -> Stock
WorkflowTag: Workflow de la transacción. (enum string)
- 'dispatch' -> Envío
- 'refund' -> Devolución
- 'restocking' -> Reposición de stock
OperationType: Tipo de operación. (enum int)
- 1 -> a punto (toPoint)
- 2 -> a domicilio (toHome)
- 3 -> retailer (toRetailer)
Sla: Service license agreement (enum int)
- 1 -> Estándar
- 2 -> Urgente
- 3 -> Prioritario
- 4 -> Pactado con cliente
- 5 -> Warehouse
WeightUnit: Unidad de medida de peso (enum string)
- ‘kg’ -> Kilogramos
- ‘g' -> Gramos
LengthUnit: Unidad de medida de distancia (enum string)
- ‘m’ -> Metros
- ‘cm' -> Centímetros
Weight:
- amount [float]
- unit [WeightUnit]
Length
- amount : float
- unit : [LengthUnit]
Height
- amount : float
- unit : [LengthUnit]
Products:
- name (*) : [string] nombre del producto
- weight (*) : [Weight] peso del producto
- length : [Length] largo del producto
- height : [Length] alto del producto
- width : [Length] ancho del producto
- price (*) : [float] precio del producto
- sku : [string]
Address:
- postalCode : [string]
- address : [string]
- city : [string]
- province : [string]
Person:
- name (*) : [string] nombre del cliente.
- lastName (*) : [string] apellido del cliente
- pid (*) : [string] número de documento (dni)
- email (*) : [string] direccion de mail del cliente
- phone : [string] numero de telefono
- adress : [Address] Address
BudgetPetition:
- serviceType (*) : [ServiceType]
- operationType (*) : [OperationType]
- retailer (*) : [Retailer]
- products (*) : [ Products[] ]
- retailerAlternativeAddress: [ Address ]
- sla (*) : [Sla]
- customer (*) : [Person]
- point : [ PuntoPickitSucursalBase ]
Budget:
- price [float]
- urlMap [string]
- token [string]
DateTimeRange:
- start [date] fecha y hora inicial
- end [date] fecha y hora final
RetailerTracking:
- order [string]
- shipment [string]
TransactionStartType: Estado inicial de la transición. (enum int)
- 1 -> Retailer
- 2 -> Disponible para colecta
- 3 -> Courier
- 4 -> Devolución solicitada
- 5 -> Devolución programada
TransacctionPetition:
- budget (*) : [BudgetPetition]
- firstState : [TransacctionStartPointType]
- trakingInfo : RetailerTracking
- packageAmount : [int] cantidad de paquetes a enviar
- deliveryTimeRange : [DateTimeRange]
- refoundProbableCause : [string]
- observations : [string]
POST /apiV2/budget
Nombre del Método: budget
Objetivo / Descripción: Este método se debe utilizar para generar una cotización de una transacción en Pickit.
Detalle: Como primera instancia de comunicación, se solicitará los datos que se encuentran en el sitio del retailer y la especificación del tipo de transacción a realizar. Esto se utilizará luego para generar la cotización y para identificar los Puntos Pick It disponibles para los productos seleccionados de ese retailer. Se devolverá aquí la URL para abrir el Lightbox y el identificador de la cotización generada.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere cotizar. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se deberán enviar los datos de los artículos asociados a la compra y el detalle del tipo de transacción a cotizar. Opcionalmente se enviará la dirección que puso el Consumidor en el CheckOut para tomarla como dirección inicial de los Puntos Pick It.
| serviceType | Obligatorio. Se debe indicar el tipo de servicio a cotizar para crear la transacción. |
| workflowTag | Obligatorio. El workflow a cotizar; el mismo se relaciona con el servicio, ya que uno puede contener múltiples workflows. |
| operationType | Obligatorio. Tipo de operación. |
| retailer | Obligatorio. El comercio que quiere realizar la transacción. |
| retailer.tokenId | Obligatorio. Token de seguridad otorgado por pickit, corresponde al retailer que quiere cotizar. |
| products | Array de datos de los productos a cotizar la transacción. |
| products.name | Obligatorio. Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Obligatorio. Unidad del peso del producto. |
| products.weight.unit | Obligatorio. Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Obligatorio. Unidad del largo del producto. |
| products.length.unit | Obligatorio. Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Obligatorio. Unidad de la altura del producto. |
| products.height.unit | Obligatorio. Unidad de medida de la altura del producto. |
| products.width | Ancho del producto. |
| products.width.amount | Obligatorio. Unidad del ancho del producto. |
| products.width.unit | Obligatorio. Unidad del ancho del producto. |
| products.price | Precio del producto. |
| products.sku | SKU del producto. |
| products.amount | Cantidad de producto. |
| retailerAlternativeAddress | Dirección de colecta alternativa. En el caso de completar un campo, se deben completar todos. |
| retailerAlternativeAddress.postalCode | Obligatorio. Código postal. |
| retailerAlternativeAddress.address | Obligatorio. Calle y número. |
| retailerAlternativeAddress.city | Obligatorio. Localidad/Ciudad. |
| retailerAlternativeAddress.province | Provincia |
| sla | SLA a utilizar para la transacción. |
| sla.id | Obligatorio. Id del SLA a utilizar. |
| customer | Datos del consumidor final al que corresponderá la transacción. |
| customer.name | Obligatorio. Nombre. |
| customer.lastName | Obligatorio. Apellido. |
| customer.lastName | Obligatorio. Apellido. |
| customer.pid | Obligatorio. Documento de identidad. |
| customer.email | Obligatorio. Correo. |
| customer.phone | Teléfono. |
| customer.address | Dirección del consumidor final. Obligatorio para envío y devolución a domicilio. |
| customer.address.postalCode | Obligatorio. Código postal. |
| customer.address.address | Obligatorio. Calle y número. |
| customer.address.city | Obligatorio. Localidad/Ciudad. |
| customer.address.province | Provincia |
| pointId | Id del punto pickit/locker a cotizar. En el caso de enviarlo, se mostrará el precio de la transacción en la respuesta. |
{
"serviceType": "PP",
"workflowTag": "dispatch",
"operationType": 1,
"retailer": {
"tokenId": "string"
},
"products": [
{
"name": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"retailerAlternativeAddress": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
},
"sla": {
"id": 0
},
"customer": {
"name": "string",
"lastName": "string",
"pid": 0,
"email": "string",
"phone": "string",
"address": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
}
},
"pointId": 0
}
Response
Pick It le retornará el identificador de cotización generado y devolverá una URL asociada al mismo para poder abrir el lightbox.
| price | Valor de la cotización. Solo se mostrará en el caso de tener el dato del destino final. |
| urlMap | Url del lightbox de pickit. |
| urlMap | Url del lightbox de pickit. |
| mapImageUrl | Url de la imagen del punto ubicado en el mapa. |
| products | Array de datos de los productos cotizados. |
| products.name | Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Unidad del peso del producto. |
| products.weight.unit | Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Unidad del largo del producto. |
| products.length.unit | Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Unidad de la altura del producto. |
{
"price": 0,
"urlMap": "string",
"mapImageUrl": "string",
"products": [
{
"name": "string",
"uuid": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"uuid": "string",
"point": {
"name": "string",
"address": "string"
},
"hours": [
{
"days": "string",
"start": "2019-09-12T12:42:13.146Z",
"end": "2019-09-12T12:42:13.146Z"
}
]
}
GET /apiV2/budget/{uuid}
Nombre del Método: budget
Objetivo / Descripción: Este método se debe utilizar para obtener información de la cotización.
Detalle: Se muestra la información del precio de la cotización y del punto seleccionado.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit devuelve la información de la cotización.
| price | Valor de la cotización. Solo se mostrará en el caso de tener el dato del destino final. |
| urlMap | Url del lightbox de pickit. |
| mapImageUrl | Url de la imagen del punto ubicado en el mapa. |
| products | Array de datos de los productos cotizados. |
| products.name | Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Unidad del peso del producto. |
| products.weight.unit | Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Unidad del largo del producto. |
| products.length.unit | Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Unidad de la altura del producto. |
| products.height.unit | Unidad de medida de la altura del producto. |
| products.width | Ancho del producto. |
| products.width.amount | Unidad del ancho del producto. |
| products.width.unit | Unidad del ancho del producto. |
| products.price | Precio del producto. |
| products.sku | SKU del producto. |
| products.amount | Cantidad de producto. |
| uuid | Identificador de la cotización. |
| point | Datos del punto (en el caso de que haya sido enviado el dato en el request). |
| point.name | Nombre del punto. |
| point.address | Calle y nro. del punto. |
| hours | Horarios del punto |
| hours.days | Días operativos. |
| hours.start | Hora de apertura. |
| hours.end | Hora de cierre. |
[
{
"price": 0,
"urlMap": "string",
"mapImageUrl": "string",
"products": [
{
"name": "string",
"uuid": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"uuid": "string",
"point": {
"nombre": "string",
"direccion": "string"
},
"hours": [
{
"days": "string",
"start": "2019-09-20T13:08:24.417Z",
"end": "2019-09-20T13:08:24.417Z"
}
]
}
]
POST /apiV2/transaction/{uuid}
Nombre del Método: transaction
Objetivo / Descripción: Este método se debe utilizar para imponer una transacción en Pickit It a través de una cotización previamente generada.
Detalle:
Una vez seleccionado el punto, se debe imponer la transacción en pickit con el identificador de la cotización. Este servicio creará la misma en el sistema.
En la url debe introducirse el “uuid” que corresponde al identificador de la cotización previamente generada.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se deberán enviar el resto de los datos necesarios para realizar la imposición.
| firstState | Obligatorio. Estado inicial a crear la transacción. |
| trackingInfo | Información de seguimiento del pedido. |
| trackingInfo.order | Nro. de seguimiento del pedido para el retailer. |
| trackingInfo.shipment | Nro. de seguimiento del pedido del courier logístico. Aplica solo para estado inicial 3. |
| packageAmount | Cantidad de bultos de la transacción (se toma por defecto 1). |
| deliveryTimeRange | Obligatorio. Rango horario (aplica únicamente para devoluciones a domicilio). |
| deliveryTimeRange.start | Hora desde la cual el courier puede retirar la devolución. |
| deliveryTimeRange.end | Hora hasta la cual el courier puede retirar la devolución. |
| refundProbableCause | Motivo de la devolución (aplica solo para devolución a punto y domicilio). |
| observations | Observaciones adicionales sobre la transacción. |
{
"firstState": 1,
"trakingInfo": {
"order": "20336657889",
"shipment": ""
},
"packageAmount": 2,
"deliveryTimeRange": {
"start": "2019-09-13T15:11:38.133Z",
"end": "2019-09-13T15:11:38.133Z"
},
"refoundProbableCause": "",
"observations": ""
}
Response
Pick It le retornará el nro. de seguimiento de la transacción y tracking de la misma.
| transactionId | Identificador de la transacción. |
| pickitCode | Nro. de seguimiento pickit. |
| urlTracking | Url del tracking de la transacción. |
{
"transactionId": 0,
"pickitCode": "string",
"urlTracking": "string"
}
POST /apiV2/transaction
Nombre del Método: transaction
Objetivo / Descripción: Este método se debe utilizar para imponer una transacción en Pickit It simplificada (en el caso de no utilizar los servicios de cotización y selección de punto).
Detalle: Se envían en un solo servicio todos los datos de la transacción y se genera la misma en el sistema.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se deberán enviar el resto de los datos necesarios para realizar la imposición.
| serviceType | Obligatorio. Se debe indicar el tipo de servicio a cotizar para crear la transacción. |
| workflowTag | Obligatorio. El workflow a cotizar; el mismo se relaciona con el servicio, ya que uno puede contener múltiples workflows. |
| operationType | Obligatorio. Tipo de operación. |
| retailer | Obligatorio. El comercio que quiere realizar la transacción. |
| retailer.tokenId | Obligatorio. Token de seguridad otorgado por pickit, corresponde al retailer que quiere cotizar. |
| products | Array de datos de los productos a cotizar la transacción. |
| products.name | Obligatorio. Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Obligatorio. Unidad del peso del producto. |
| products.weight.unit | Obligatorio. Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Obligatorio. Unidad del largo del producto. |
| products.length.unit | Obligatorio. Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Obligatorio. Unidad de la altura del producto. |
| products.height.unit | Obligatorio. Unidad de medida de la altura del producto. |
| products.width | Ancho del producto. |
| products.width.amount | Obligatorio. Unidad del ancho del producto. |
| products.width.unit | Obligatorio. Unidad del ancho del producto. |
| products.price | Precio del producto. |
| products.sku | SKU del producto. |
| products.amount | Cantidad de producto. |
| retailerAlternativeAddress | Dirección de colecta alternativa. En el caso de completar un campo, se deben completar todos. |
| retailerAlternativeAddress.postalCode | Obligatorio. Código postal. |
| retailerAlternativeAddress.address | Obligatorio. Calle y número. |
| retailerAlternativeAddress.city | Obligatorio. Localidad/Ciudad. |
| retailerAlternativeAddress.province | Provincia |
| sla | SLA a utilizar para la transacción. |
| sla.id | Obligatorio. Id del SLA a utilizar. |
| customer | Datos del consumidor final al que corresponderá la transacción. |
| customer.name | Obligatorio. Nombre. |
| customer.lastName | Obligatorio. Apellido. |
| customer.pid | Obligatorio. Documento de identidad. |
| customer.email | Obligatorio. Correo. |
| customer.phone | Teléfono. |
| customer.address | Dirección del consumidor final. Obligatorio para envío y devolución a domicilio. |
| customer.address.postalCode | Obligatorio. Código postal. |
| customer.address.address | Obligatorio. Calle y número. |
| customer.address.city | Obligatorio. Localidad/Ciudad. |
| customer.address.province | Provincia |
| pointId | Id del punto pickit/locker. Obligatorio para envio a punto pickit, locker y stock y reposición de stock. |
| firstState | Obligatorio. Estado inicial a crear la transacción. |
| trackingInfo | Información de seguimiento del pedido |
| trackingInfo.order | Nro. de seguimiento del pedido para el retailer. |
| trackingInfo.shipment | Nro. de seguimiento del pedido del courier logístico. Aplica solo para estado inicial 3. |
| packageAmount | Cantidad de bultos de la transacción (se toma por defecto 1). |
| deliveryTimeRange | Obligatorio. Rango horario (aplica únicamente para devoluciones a domicilio). |
| deliveryTimeRange.start | Hora desde la cual el courier puede retirar la devolución. |
| deliveryTimeRange.end | Hora hasta la cual el courier puede retirar la devolución. |
| refundProbableCause | Motivo de la devolución (aplica solo para devolución a punto y domicilio). |
| observations | Observaciones adicionales sobre la transacción. |
{
"budgetPetition": {
"serviceType": "SP",
"workflowTag": "dispatch",
"operationType": 1,
"retailer": {
"tokenId": "string"
},
"products": [
{
"name": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"retailerAlternativeAddress": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
},
"sla": {
"id": 0
},
"customer": {
"name": "string",
"lastName": "string",
"pid": 0,
"email": "string",
"phone": "string",
"address": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
}
},
"pointId": 0
},
"firstState": 6,
"trakingInfo": {
"order": "string",
"shipment": "string"
},
"packageAmount": 0,
"deliveryTimeRange": {
"start": "2019-09-16T17:55:38.584Z",
"end": "2019-09-16T17:55:38.584Z"
},
"refoundProbableCause": "string",
"observations": "string"
}
Response
Pick It le retornará el valor acorde al punto seleccionado, el nro de seguimiento y tracking de la transacción.
| transactionId | Identificador de la transacción. |
| pickitCode | Nro. de seguimiento pickit. |
| urlTracking | Url del tracking de la transacción. |
| price | Valor de la transacción. |
{
"transactionId": 0,
"pickitCode": "string",
"urlTracking": "string",
"price": 0
}
GET /apiV2/map/point?page={page_number}&perPage={results_per_page}
Nombre del Método: map/point
Objetivo / Descripción: Este método se debe utilizar para obtener la lista de puntos que tiene habilitados.
Detalle: Se muestra la información de cada punto.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit devuelve el listado de los puntos con el detalle de cada uno.
| result.id | Id del resultado. |
| result.idService | Identificador del punto (acorde al servicio del mismo). |
| result.name | Nombre del punto. |
| result.serviceType | Servicio del punto. |
| result.lat | Latitud de la ubicación del punto. |
| result.lng | Longitud de la ubicación del punto. |
| result.address | Dirección del punto. |
| result.postalCode | Código postal del punto. |
| result.location | Localidad del punto. |
| result.province | Provincia del punto. |
| paginator | Los resultados de la consulta son paginados. |
| paginator.total | Total de resultados que se están paginando. |
| paginator.perPage | Cantidad de resultados que se devuelven por página. |
| paginator.page | Nro. de la página que se está consultando actualmente. |
| paginator.totalPages | Cantidad total de páginas. |
{
"result": [
{
"id": 1,
"idService": 1,
"name": "Scarlett Soho",
"serviceType": "PP",
"lat": -34.5891729,
"lng": -58.423744,
"address": "Nicaragua 4457",
"postalCode": "C1414BVC",
"location": "CABA",
"province": "CABA"
},
{
"id": 2,
"idService": 2,
"name": "Scarlett Centro",
"serviceType": "PP",
"lat": -34.597412,
"lng": -58.375819999999976,
"address": "Paraguay 639",
"postalCode": "C1057AAG",
"location": "CABA",
"province": "CABA"
},
{
"id": 3,
"idService": 3,
"name": "Scarlett República",
"serviceType": "PP",
"lat": -34.579127,
"lng": -58.41531900000001,
"address": "Republica de la India 2907",
"postalCode": "C1425FCE",
"location": "CABA",
"province": "CABA"
},
{
"id": 13,
"idService": 13,
"name": "Havanna O'Higgings",
"serviceType": "PP",
"lat": -34.5600949,
"lng": -58.452974299999994,
"address": "Juramento 2002",
"postalCode": "C1428DNH",
"location": "CABA",
"province": "CABA"
},
{
"id": 14,
"idService": 14,
"name": "Havanna Recova",
"serviceType": "PP",
"lat": -34.5900279,
"lng": -58.381911,
"address": "Posadas 1059",
"postalCode": "1011",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 24,
"idService": 24,
"name": "Havanna Anchorena",
"serviceType": "PP",
"lat": -34.593527,
"lng": -58.40512560000002,
"address": "Av Santa Fe 2694, CABA",
"postalCode": "C1425",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 25,
"idService": 25,
"name": "Havanna Soho",
"serviceType": "PP",
"lat": -34.588851,
"lng": -58.42649499999999,
"address": "Armenia 1788, CABA",
"postalCode": "1414",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 26,
"idService": 26,
"name": "Havanna Juan B Justo",
"serviceType": "PP",
"lat": -34.60471889999999,
"lng": -58.45813599999997,
"address": "Av San Martin 2182",
"postalCode": "C1416CRW",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 27,
"idService": 27,
"name": "Havanna San Telmo",
"serviceType": "PP",
"lat": -34.620474,
"lng": -58.371241,
"address": "CUSTOM 123",
"postalCode": "C1065AAT",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 29,
"idService": 29,
"name": "5asec Monroe locker",
"serviceType": "PP",
"lat": -34.5536624,
"lng": -58.4532193,
"address": "Monroe 1655, Buenos Aires, Argentina",
"postalCode": "1428",
"location": "Belgrano",
"province": "CABA"
},
{
"id": 73,
"idService": 73,
"name": "Havanna La Nacion",
"serviceType": "PP",
"lat": -34.6008607,
"lng": -58.36891300000002,
"address": "Bouchard 557, CABA",
"postalCode": "C1106",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 76,
"idService": 76,
"name": "Havanna Arcos",
"serviceType": "PP",
"lat": -34.58110509999999,
"lng": -58.428420200000005,
"address": "Paraguay 4979, CABA",
"postalCode": "C1425",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 91,
"idService": 147,
"name": "Corrientes 2107",
"serviceType": "PP",
"lat": -34.6045268,
"lng": -58.3968888,
"address": "Av. Corrientes 2107",
"postalCode": "1045",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 132,
"idService": 202,
"name": "Margarita Weild 1760",
"serviceType": "PP",
"lat": -34.7130404,
"lng": -58.3850077,
"address": "Margarita Weild 1760",
"postalCode": "B1824KOB",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 166,
"idService": 144,
"name": "Sucursal Retailer Sin Cadena Nuevo",
"serviceType": "PP",
"lat": -34.590612,
"lng": -58.43498870000002,
"address": "as 123",
"postalCode": "C1414",
"location": "Buenos Aires",
"province": "Buenos Aires"
}
],
"paginator": {
"total": 29,
"perPage": 15,
"page": 1,
"totalPages": 2
}
}
GET /apiV2/transaction/{transactionId}/label
Nombre del Método: /transaction/{transactionId}/label
Objetivo / Descripción: Este método se debe utilizar para obtener la/las etiqueta/s de la transacción ya creada en Pickit.
Detalle: Devuelve la/las etiqueta/s de la transacción y los datos en el caso de querer crear una diferente.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit devuelve la/las etiqueta/s con los datos de la transacción en el caso de querer armar una propia.
{
"customer": {
"name": "string",
"lastname": "string"
},
"pickitCode": "string",
"barcode": "string",
"pickitPoint": {
"id": 0,
"address": "string"
},
"retailer": {
"name": "string",
"responsable": "string",
"address": "string"
},
"date": "2020-02-03T13:26:58.714Z",
"url": {
"barCode": "string",
"label": [
"string"
]
},
"trackinginfo": {
"order": "string"
},
"shipmentID": "string",
"operationType": "string",
"canalization": "string",
"sla": "string",
"serviceId": 0
}
PUT /apiV2/transaction/{transactionId}/state
Nombre del Método: /transaction/{transactionId}/state
Objetivo / Descripción: Este método se debe utilizar para ejecutar el “Ready to ship” sobre la transacción.
Detalle: Realiza el cambio de estado de la transacción a “Disponible para colecta” y realiza la notificación para retirar el paquete. En el mismo se puede informar si hubo algún cambio con la cantidad de bultos del paquete.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se debe enviar el nuevo estado, y de querer realizar el cambio de cantidad de bultos, el nro. que corresponde.
| newState | Obligatorio. Siempre debe completarse con el valor “availableForDrop”, que corresponde al Disponible para colecta |
| additional | Datos adicionales a agregarle a la transacción. |
| additional.packageAmount | Este campo tomará por defecto el valor informado en la imposición de la cantidad de bultos. En el caso de querer modificarlo, se debe enviar la nueva cantidad, lo que actualizará la transacción y la cantidad de etiquetas. |
{
"newState":"availableForDrop",
"additional":{
"packageAmount": 1
}
}
Response
Pickit ejecuta el cambio de estado sobre la transacción a “Disponible para colecta”, y devuelve el id de la transacción si se ejecutó correctamente.
| transactionId | Identificador de la transacción. |
{
"transactionId": 14589
}
DELETE /apiV2/retailer/transaction/{idTransaction}
Nombre del Método: /retailer/transaction/{idTransaction}
Objetivo / Descripción: Este método se debe utilizar para cancelar una transacción ya creada en Pickit.
Detalle: Pasandole el id de la transacción, se cambia el status de la misma a “Cancelada”.
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit ejecuta el cambio de estado sobre la transacción a “Disponible para colecta”, y devuelve el id de la transacción si se ejecutó correctamente.
[]
- POST /apiV2/budget
- GET /apiV2/budget/{uuid}
- POST /apiV2/transaction/{uuid}
- GET /apiV2/transaction/
{transactionId}/label - PUT /apiV2/transaction/{transactionId}/state
- DELETE /apiV2/retailer/transaction
/{idTransaction} - GET /apiV2/map/point?page=
{page_number}&perPage={results_per_page} - POST /apiV2/transaction
- GET /apiV2/transaction/{transactionId}/label
- PUT /apiV2/transaction/{transactionId}/state
- DELETE /apiV2/retailer/transaction
/{idTransaction}
Integración con mapa:
Integración simplificada:
Te presentamos la documentación de nuestra API donde podrás ver la especificación de nuestros métodos para integrarte y los ambientes con los que contamos.
Ambientes
SANDBOX
Estado: Activo
check_circle
https://api.uat.pickit.com.ar/index.php
https://api.uat.pickit.com.uy/index.php
https://api.uat.pickit.com.mx/index.php
https://api.uat.pickit.com.co/index.php
PRODUCCIÓN
Estado: Activo
check_circle
https://api.pickit.net
https://api.pickit.com.uy/index.php
https://api.pickit.com.mx/index.php
https://api.pickit.com.co/index.php
-
keyboard_arrow_downEstructura
ServiceType: Tipo de servicio. (enum string)
- 'SP' -> Store Pickup
- 'PP' -> Punto Pickit
- 'PL' -> Locker
- 'ST' -> Stock
WorkflowTag: Workflow de la transacción. (enum string)
- 'dispatch' -> Envío
- 'refund' -> Devolución
- 'restocking' -> Reposición de stock
perationType: Tipo de operación. (enum int)
- 1 -> a punto (toPoint)
- 2 -> a domicilio (toHome)
- 3 -> retailer (toRetailer)
Sla: Service license agreement (enum int)
- 1 -> Estándar
- 2 -> Urgente
- 3 -> Prioritario
- 4 -> Pactado con cliente
- 5 -> Warehouse
WeightUnit: Unidad de medida de peso (enum string)
- ‘kg’ -> Kilogramos
- ‘g' -> Gramos
LengthUnit: Unidad de medida de distancia (enum string)
- ‘m’ -> Metros
- ‘cm' -> Centímetros
Weight:
- amount [float]
- unit [WeightUnit]
Length
- amount : float
- unit : [LengthUnit]
Height
- amount : float
- unit : [LengthUnit]
Products:
- name (*) : [string] nombre del producto
- weight (*) : [Weight] peso del producto
- length : [Length] largo del producto
- height : [Length] alto del producto
- width : [Length] ancho del producto
- price (*) : [float] precio del producto
- sku : [string]
Address:
- postalCode : [string]
- address : [string]
- city : [string]
- province : [string]
Person:
- name (*) : [string] nombre del cliente.
- lastName (*) : [string] apellido del cliente
- pid (*) : [string] número de documento (dni)
- email (*) : [string] direccion de mail del cliente
- phone : [string] numero de telefono
- adress : [Address] Address
BudgetPetition:
- serviceType (*) : [ServiceType]
- operationType (*) : [OperationType]
- retailer (*) : [Retailer]
- products (*) : [ Products[] ]
- retailerAlternativeAddress: [ Address ]
- sla (*) : [Sla]
- customer (*) : [Person]
- point : [ PuntoPickitSucursalBase ]
Budget:
- price [float]
- urlMap [string]
- token [string]
DateTimeRange:
- start [date] fecha y hora inicial
- end [date] fecha y hora final
RetailerTracking:
- order [string]
- shipment [string]
TransactionStartType: Estado inicial de la transición. (enum int)
- 1 -> Retailer
- 2 -> Disponible para colecta
- 3 -> Courier
- 4 -> Devolución solicitada
- 5 -> Devolución programada
TransacctionPetition:
- budget (*) : [BudgetPetition]
- firstState : [TransacctionStartPointType]
- trakingInfo : RetailerTracking
- packageAmount : [int] cantidad de paquetes a enviar
- deliveryTimeRange : [DateTimeRange]
- refoundProbableCause : [string]
- observations : [string]
Métodos:
POST /apiV2/budget
Nombre del Método: budget
Objetivo / Descripción: Este método se debe utilizar para generar una cotización de una transacción en Pickit.
Detalle: Como primera instancia de comunicación, se solicitará los datos que se encuentran en el sitio del retailer y la especificación del tipo de transacción a realizar. Esto se utilizará luego para generar la cotización y para identificar los Puntos Pick It disponibles para los productos seleccionados de ese retailer. Se devolverá aquí la URL para abrir el Lightbox y el identificador de la cotización generada.
add
{
"serviceType": "PP",
"workflowTag": "dispatch",
"operationType": 1,
"retailer": {
"tokenId": "string"
},
"products": [
{
"name": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"retailerAlternativeAddress": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
},
"sla": {
"id": 0
},
"customer": {
"name": "string",
"lastName": "string",
"pid": 0,
"email": "string",
"phone": "string",
"address": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
}
},
"pointId": 0
}
{
"price": 0,
"urlMap": "string",
"mapImageUrl": "string",
"products": [
{
"name": "string",
"uuid": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"uuid": "string",
"point": {
"name": "string",
"address": "string"
},
"hours": [
{
"days": "string",
"start": "2019-09-12T12:42:13.146Z",
"end": "2019-09-12T12:42:13.146Z"
}
]
}
POST /apiV2/transaction/{uuid}
Nombre del Método: transaction
Objetivo / Descripción: Este método se debe utilizar para imponer una transacción en Pickit It a través de una cotización previamente generada.
Detalle:
Una vez seleccionado el punto, se debe imponer la transacción en pickit con el identificador de la cotización. Este servicio creará la misma en el sistema.
En la url debe introducirse el “uuid” que corresponde al identificador de la cotización previamente generada.
{
"firstState": 1,
"trakingInfo": {
"order": "20336657889",
"shipment": ""
},
"packageAmount": 2,
"deliveryTimeRange": {
"start": "2019-09-13T15:11:38.133Z",
"end": "2019-09-13T15:11:38.133Z"
},
"refoundProbableCause": "",
"observations": ""
}
{
"transactionId": 0,
"pickitCode": "string",
"urlTracking": "string"
}
POST /apiV2/transaction
Nombre del Método: transaction
Objetivo / Descripción: Este método se debe utilizar para imponer una transacción en Pickit It simplificada (en el caso de no utilizar los servicios de cotización y selección de punto).
Detalle: Se envían en un solo servicio todos los datos de la transacción y se genera la misma en el sistema.
add
{
"budgetPetition": {
"serviceType": "SP",
"workflowTag": "dispatch",
"operationType": 1,
"retailer": {
"tokenId": "string"
},
"products": [
{
"name": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"retailerAlternativeAddress": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
},
"sla": {
"id": 0
},
"customer": {
"name": "string",
"lastName": "string",
"pid": 0,
"email": "string",
"phone": "string",
"address": {
"postalCode": "string",
"address": "string",
"city": "string",
"province": "string"
}
},
"pointId": 0
},
"firstState": 6,
"trakingInfo": {
"order": "string",
"shipment": "string"
},
"packageAmount": 0,
"deliveryTimeRange": {
"start": "2019-09-16T17:55:38.584Z",
"end": "2019-09-16T17:55:38.584Z"
},
"refoundProbableCause": "string",
"observations": "string"
}
{
"transactionId": 0,
"pickitCode": "string",
"urlTracking": "string",
"price": 0
}
GET /apiV2/budget/{uuid}
Nombre del Método: budget
Objetivo / Descripción: Este método se debe utilizar para obtener información de la cotización.
Detalle: Se muestra la información del precio de la cotización y del punto seleccionado.
add
[
{
"price": 0,
"urlMap": "string",
"mapImageUrl": "string",
"products": [
{
"name": "string",
"uuid": "string",
"weight": {
"amount": 0,
"unit": "g"
},
"length": {
"amount": 0,
"unit": "m"
},
"height": {
"amount": 0,
"unit": "m"
},
"width": {
"amount": 0,
"unit": "m"
},
"price": 0,
"sku": "string",
"amount": 0
}
],
"uuid": "string",
"point": {
"nombre": "string",
"direccion": "string"
},
"hours": [
{
"days": "string",
"start": "2019-09-20T13:08:24.417Z",
"end": "2019-09-20T13:08:24.417Z"
}
]
}
]
GET /apiV2/map/point?page={page_number}&perPage={results_per_page}
Nombre del Método: map/point
Objetivo / Descripción: Este método se debe utilizar para obtener la lista de puntos que tiene habilitados.
Detalle: Se muestra la información de cada punto.
add
{
"result": [
{
"id": 1,
"idService": 1,
"name": "Scarlett Soho",
"serviceType": "PP",
"lat": -34.5891729,
"lng": -58.423744,
"address": "Nicaragua 4457",
"postalCode": "C1414BVC",
"location": "CABA",
"province": "CABA"
},
{
"id": 2,
"idService": 2,
"name": "Scarlett Centro",
"serviceType": "PP",
"lat": -34.597412,
"lng": -58.375819999999976,
"address": "Paraguay 639",
"postalCode": "C1057AAG",
"location": "CABA",
"province": "CABA"
},
{
"id": 3,
"idService": 3,
"name": "Scarlett República",
"serviceType": "PP",
"lat": -34.579127,
"lng": -58.41531900000001,
"address": "Republica de la India 2907",
"postalCode": "C1425FCE",
"location": "CABA",
"province": "CABA"
},
{
"id": 13,
"idService": 13,
"name": "Havanna O'Higgings",
"serviceType": "PP",
"lat": -34.5600949,
"lng": -58.452974299999994,
"address": "Juramento 2002",
"postalCode": "C1428DNH",
"location": "CABA",
"province": "CABA"
},
{
"id": 14,
"idService": 14,
"name": "Havanna Recova",
"serviceType": "PP",
"lat": -34.5900279,
"lng": -58.381911,
"address": "Posadas 1059",
"postalCode": "1011",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 24,
"idService": 24,
"name": "Havanna Anchorena",
"serviceType": "PP",
"lat": -34.593527,
"lng": -58.40512560000002,
"address": "Av Santa Fe 2694, CABA",
"postalCode": "C1425",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 25,
"idService": 25,
"name": "Havanna Soho",
"serviceType": "PP",
"lat": -34.588851,
"lng": -58.42649499999999,
"address": "Armenia 1788, CABA",
"postalCode": "1414",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 26,
"idService": 26,
"name": "Havanna Juan B Justo",
"serviceType": "PP",
"lat": -34.60471889999999,
"lng": -58.45813599999997,
"address": "Av San Martin 2182",
"postalCode": "C1416CRW",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 27,
"idService": 27,
"name": "Havanna San Telmo",
"serviceType": "PP",
"lat": -34.620474,
"lng": -58.371241,
"address": "CUSTOM 123",
"postalCode": "C1065AAT",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 29,
"idService": 29,
"name": "5asec Monroe locker",
"serviceType": "PP",
"lat": -34.5536624,
"lng": -58.4532193,
"address": "Monroe 1655, Buenos Aires, Argentina",
"postalCode": "1428",
"location": "Belgrano",
"province": "CABA"
},
{
"id": 73,
"idService": 73,
"name": "Havanna La Nacion",
"serviceType": "PP",
"lat": -34.6008607,
"lng": -58.36891300000002,
"address": "Bouchard 557, CABA",
"postalCode": "C1106",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 76,
"idService": 76,
"name": "Havanna Arcos",
"serviceType": "PP",
"lat": -34.58110509999999,
"lng": -58.428420200000005,
"address": "Paraguay 4979, CABA",
"postalCode": "C1425",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 91,
"idService": 147,
"name": "Corrientes 2107",
"serviceType": "PP",
"lat": -34.6045268,
"lng": -58.3968888,
"address": "Av. Corrientes 2107",
"postalCode": "1045",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 132,
"idService": 202,
"name": "Margarita Weild 1760",
"serviceType": "PP",
"lat": -34.7130404,
"lng": -58.3850077,
"address": "Margarita Weild 1760",
"postalCode": "B1824KOB",
"location": "Buenos Aires",
"province": "CABA"
},
{
"id": 166,
"idService": 144,
"name": "Sucursal Retailer Sin Cadena Nuevo",
"serviceType": "PP",
"lat": -34.590612,
"lng": -58.43498870000002,
"address": "as 123",
"postalCode": "C1414",
"location": "Buenos Aires",
"province": "Buenos Aires"
}
],
"paginator": {
"total": 29,
"perPage": 15,
"page": 1,
"totalPages": 2
}
}
GET /apiV2/transaction/ {transactionId}/label
Nombre del Método: /transaction/{transactionId}/label
Objetivo / Descripción: Este método se debe utilizar para obtener la/las etiqueta/s de la transacción ya creada en Pickit.
Detalle: Devuelve la/las etiqueta/s de la transacción y los datos en el caso de querer crear una diferente.
add
{
"customer": {
"name": "string",
"lastname": "string"
},
"pickitCode": "string",
"barcode": "string",
"pickitPoint": {
"id": 0,
"address": "string"
},
"retailer": {
"name": "string",
"responsable": "string",
"address": "string"
},
"date": "2020-02-03T13:26:58.714Z",
"url": {
"barCode": "string",
"label": [
"string"
]
},
"trackinginfo": {
"order": "string"
},
"shipmentID": "string",
"operationType": "string",
"canalization": "string",
"sla": "string",
"serviceId": 0
}
PUT /apiV2/transaction/ {transactionId}/state
Nombre del Método: /transaction/{transactionId}/state
Objetivo / Descripción: Este método se debe utilizar para ejecutar el “Ready to ship” sobre la transacción.
Detalle: Realiza el cambio de estado de la transacción a “Disponible para colecta” y realiza la notificación para retirar el paquete. En el mismo se puede informar si hubo algún cambio con la cantidad de bultos del paquete.
addDELETE /apiV2/retailer/
transaction/{idTransaction}
Nombre del Método: /retailer/transaction/{idTransaction}
Objetivo / Descripción: Este método se debe utilizar para cancelar una transacción ya creada en Pickit.
Detalle: Pasandole el id de la transacción, se cambia el status de la misma a “Cancelada”.
add
{
[]
}
POST/apiV2/budget
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere cotizar. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se deberán enviar los datos de los artículos asociados a la compra y el detalle del tipo de transacción a cotizar. Opcionalmente se enviará la dirección que puso el Consumidor en el CheckOut para tomarla como dirección inicial de los Puntos Pick It.
| serviceType | Obligatorio. Se debe indicar el tipo de servicio a cotizar para crear la transacción. |
| workflowTag | Obligatorio. El workflow a cotizar; el mismo se relaciona con el servicio, ya que uno puede contener múltiples workflows. |
| operationType | Obligatorio. Tipo de operación. |
| retailer | Obligatorio. El comercio que quiere realizar la transacción. |
| retailer.tokenId | Obligatorio. Token de seguridad otorgado por pickit, corresponde al retailer que quiere cotizar. |
| products | Array de datos de los productos a cotizar la transacción. |
| products.name | Obligatorio. Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Obligatorio. Unidad del peso del producto. |
| products.weight.unit | Obligatorio. Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Obligatorio. Unidad del largo del producto. |
| products.length.unit | Obligatorio. Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Obligatorio. Unidad de la altura del producto. |
| products.height.unit | Obligatorio. Unidad de medida de la altura del producto. |
| products.width | Ancho del producto. |
| products.width.amount | Obligatorio. Unidad del ancho del producto. |
| products.width.unit | Obligatorio. Unidad del ancho del producto. |
| products.price | Precio del producto. |
| products.sku | SKU del producto. |
| products.amount | Cantidad de producto. |
| retailerAlternativeAddress | Dirección de colecta alternativa. En el caso de completar un campo, se deben completar todos. |
| retailerAlternativeAddress.postalCode | Obligatorio. Código postal. |
| retailerAlternativeAddress.address | Obligatorio. Calle y número. |
| retailerAlternativeAddress.city | Obligatorio. Localidad/Ciudad. |
| retailerAlternativeAddress.province | Provincia |
| sla | SLA a utilizar para la transacción. |
| sla.id | Obligatorio. Id del SLA a utilizar. |
| customer | Datos del consumidor final al que corresponderá la transacción. |
| customer.name | Obligatorio. Nombre. |
| customer.lastName | Obligatorio. Apellido. |
| customer.lastName | Obligatorio. Apellido. |
| customer.pid | Obligatorio. Documento de identidad. |
| customer.email | Obligatorio. Correo. |
| customer.phone | Teléfono. |
| customer.address | Dirección del consumidor final. Obligatorio para envío y devolución a domicilio. |
| customer.address.postalCode | Obligatorio. Código postal. |
| customer.address.address | Obligatorio. Calle y número. |
| customer.address.city | Obligatorio. Localidad/Ciudad. |
| customer.address.province | Provincia |
| pointId | Id del punto pickit/locker a cotizar. En el caso de enviarlo, se mostrará el precio de la transacción en la respuesta. |
Response
Pick It le retornará el identificador de cotización generado y devolverá una URL asociada al mismo para poder abrir el lightbox.
| price | Valor de la cotización. Solo se mostrará en el caso de tener el dato del destino final. |
| urlMap | Url del lightbox de pickit. |
| urlMap | Url del lightbox de pickit. |
| mapImageUrl | Url de la imagen del punto ubicado en el mapa. |
| products | Array de datos de los productos cotizados. |
| products.name | Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Unidad del peso del producto. |
| products.weight.unit | Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Unidad del largo del producto. |
| products.length.unit | Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Unidad de la altura del producto. |
GET/apiV2/budget/{uuid}
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit devuelve la información de la cotización.
| price | Valor de la cotización. Solo se mostrará en el caso de tener el dato del destino final. |
| urlMap | Url del lightbox de pickit. |
| mapImageUrl | Url de la imagen del punto ubicado en el mapa. |
| products | Array de datos de los productos cotizados. |
| products.name | Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Unidad del peso del producto. |
| products.weight.unit | Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Unidad del largo del producto. |
| products.length.unit | Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Unidad de la altura del producto. |
| products.height.unit | Unidad de medida de la altura del producto. |
| products.width | Ancho del producto. |
| products.width.amount | Unidad del ancho del producto. |
| products.width.unit | Unidad del ancho del producto. |
| products.price | Precio del producto. |
| products.sku | SKU del producto. |
| products.amount | Cantidad de producto. |
| uuid | Identificador de la cotización. |
| point | Datos del punto (en el caso de que haya sido enviado el dato en el request). |
| point.name | Nombre del punto. |
| point.address | Calle y nro. del punto. |
| hours | Horarios del punto |
| hours.days | Días operativos. |
| hours.start | Hora de apertura. |
| hours.end | Hora de cierre. |
POST/apiV2/transaction/{uuid}
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se deberán enviar el resto de los datos necesarios para realizar la imposición.
| firstState | Obligatorio. Estado inicial a crear la transacción. |
| trackingInfo | Información de seguimiento del pedido. |
| trackingInfo.order | Nro. de seguimiento del pedido para el retailer. |
| trackingInfo.shipment | Nro. de seguimiento del pedido del courier logístico. Aplica solo para estado inicial 3. |
| packageAmount | Cantidad de bultos de la transacción (se toma por defecto 1). |
| deliveryTimeRange | Obligatorio. Rango horario (aplica únicamente para devoluciones a domicilio). |
| deliveryTimeRange.start | Hora desde la cual el courier puede retirar la devolución. |
| deliveryTimeRange.end | Hora hasta la cual el courier puede retirar la devolución. |
| refundProbableCause | Motivo de la devolución (aplica solo para devolución a punto y domicilio). |
| observations | Observaciones adicionales sobre la transacción. |
Response
Pick It le retornará el nro. de seguimiento de la transacción y tracking de la misma.
| transactionId | Identificador de la transacción. |
| pickitCode | Nro. de seguimiento pickit. |
| urlTracking | Url del tracking de la transacción. |
POST/apiV2/transaction
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se deberán enviar el resto de los datos necesarios para realizar la imposición.
| serviceType | Obligatorio. Se debe indicar el tipo de servicio a cotizar para crear la transacción. |
| workflowTag | Obligatorio. El workflow a cotizar; el mismo se relaciona con el servicio, ya que uno puede contener múltiples workflows. |
| operationType | Obligatorio. Tipo de operación. |
| retailer | Obligatorio. El comercio que quiere realizar la transacción. |
| retailer.tokenId | Obligatorio. Token de seguridad otorgado por pickit, corresponde al retailer que quiere cotizar. |
| products | Array de datos de los productos a cotizar la transacción. |
| products.name | Obligatorio. Nombre del producto. |
| products.weight | Peso del producto. |
| products.weight.amount | Obligatorio. Unidad del peso del producto. |
| products.weight.unit | Obligatorio. Unidad de medida del peso del producto. |
| products.length | Largo del producto. |
| products.length.amount | Obligatorio. Unidad del largo del producto. |
| products.length.unit | Obligatorio. Unidad de medida del largo del producto. |
| products.height | Altura del producto. |
| products.height.amount | Obligatorio. Unidad de la altura del producto. |
| products.height.unit | Obligatorio. Unidad de medida de la altura del producto. |
| products.width | Ancho del producto. |
| products.width.amount | Obligatorio. Unidad del ancho del producto. |
| products.width.unit | Obligatorio. Unidad del ancho del producto. |
| products.price | Precio del producto. |
| products.sku | SKU del producto. |
| products.amount | Cantidad de producto. |
| retailerAlternativeAddress | Dirección de colecta alternativa. En el caso de completar un campo, se deben completar todos. |
| retailerAlternativeAddress.postalCode | Obligatorio. Código postal. |
| retailerAlternativeAddress.address | Obligatorio. Calle y número. |
| retailerAlternativeAddress.city | Obligatorio. Localidad/Ciudad. |
| retailerAlternativeAddress.province | Provincia |
| sla | SLA a utilizar para la transacción. |
| sla.id | Obligatorio. Id del SLA a utilizar. |
| customer | Datos del consumidor final al que corresponderá la transacción. |
| customer.name | Obligatorio. Nombre. |
| customer.lastName | Obligatorio. Apellido. |
| customer.pid | Obligatorio. Documento de identidad. |
| customer.email | Obligatorio. Correo. |
| customer.phone | Teléfono. |
| customer.address | Dirección del consumidor final. Obligatorio para envío y devolución a domicilio. |
| customer.address.postalCode | Obligatorio. Código postal. |
| customer.address.address | Obligatorio. Calle y número. |
| customer.address.city | Obligatorio. Localidad/Ciudad. |
| customer.address.province | Provincia |
| pointId | Id del punto pickit/locker. Obligatorio para envio a punto pickit, locker y stock y reposición de stock. |
| firstState | Obligatorio. Estado inicial a crear la transacción. |
| trackingInfo | Información de seguimiento del pedido |
| trackingInfo.order | Nro. de seguimiento del pedido para el retailer. |
| trackingInfo.shipment | Nro. de seguimiento del pedido del courier logístico. Aplica solo para estado inicial 3. |
| packageAmount | Cantidad de bultos de la transacción (se toma por defecto 1). |
| deliveryTimeRange | Obligatorio. Rango horario (aplica únicamente para devoluciones a domicilio). |
| deliveryTimeRange.start | Hora desde la cual el courier puede retirar la devolución. |
| deliveryTimeRange.end | Hora hasta la cual el courier puede retirar la devolución. |
| refundProbableCause | Motivo de la devolución (aplica solo para devolución a punto y domicilio). |
| observations | Observaciones adicionales sobre la transacción. |
Response
Pick It le retornará el valor acorde al punto seleccionado, el nro de seguimiento y tracking de la transacción.
| transactionId | Identificador de la transacción. |
| pickitCode | Nro. de seguimiento pickit. |
| urlTracking | Url del tracking de la transacción. |
| price | Valor de la transacción. |
GET/apiV2/map/point?page={page_number}&perPage={results_per_page}
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit devuelve el listado de los puntos con el detalle de cada uno.
| result.id | Id del resultado. |
| result.idService | Identificador del punto (acorde al servicio del mismo). |
| result.name | Nombre del punto. |
| result.serviceType | Servicio del punto. |
| result.lat | Latitud de la ubicación del punto. |
| result.lng | Longitud de la ubicación del punto. |
| result.address | Dirección del punto. |
| result.postalCode | Código postal del punto. |
| result.location | Localidad del punto. |
| result.province | Provincia del punto. |
| paginator | Los resultados de la consulta son paginados. |
| paginator.total | Total de resultados que se están paginando. |
| paginator.perPage | Cantidad de resultados que se devuelven por página. |
| paginator.page | Nro. de la página que se está consultando actualmente. |
| paginator.totalPages | Cantidad total de páginas. |
GET/apiV2/transaction/{transactionId}/label
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit devuelve la/las etiqueta/s con los datos de la transacción en el caso de querer armar una propia.
PUT/apiV2/transaction/{transactionId}/state
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Request
Se debe enviar el nuevo estado, y de querer realizar el cambio de cantidad de bultos, el nro. que corresponde.
| newState | Obligatorio. Siempre debe completarse con el valor “availableForDrop”, que corresponde al Disponible para colecta |
| additional | Datos adicionales a agregarle a la transacción. |
| additional.packageAmount | Este campo tomará por defecto el valor informado en la imposición de la cantidad de bultos. En el caso de querer modificarlo, se debe enviar la nueva cantidad, lo que actualizará la transacción y la cantidad de etiquetas. |
Response
Pickit ejecuta el cambio de estado sobre la transacción a “Disponible para colecta”, y devuelve el id de la transacción si se ejecutó correctamente.
| transactionId | Identificador de la transacción. |
DELETE/apiV2/retailer/transaction/{idTransaction}
Headers
| apiKey | Obligatorio. ApiKey otorgada por pickit, corresponde al retailer que quiere imponer. |
| token | Obligatorio. TokenId otorgado por pickit, corresponde al retailer que quiere imponer. |
Response
Pickit ejecuta el cambio de estado sobre la transacción a “Disponible para colecta”, y devuelve el id de la transacción si se ejecutó correctamente.
| transactionId | Identificador de la transacción. |