BRIDGE API - REST - Consulta de un pedido recibido en BRIDGE

Este documento detalla la consulta a Bridge API de un pedido particular

Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/order/info - Ejemplo: https://200.100.100.100:8090/order/info
Se invoca vía GET

Tener en cuenta:

Primero se debe invocar al servicio de autenticación para obtener un token.
Cuando se llama a cualquier servicio este token se envía como un parámetro más de la llamada en el header (x-access-token.
Si al llamar al servicio el token expiró, se recibirá respuesta de token inválido y se deberá volver a pedir uno nuevo.

Ver BRIDGE API - REST – Autenticación: token

Se podrán recibir en el body de la consulta algunos parámetros:

Disponible a partir de v7.5.4

{

"internalNumber": "bridge0000000001",

"externalNumber": "000101250000006",

"channel": "bridge"

}

	Descripción	Requerido	Ejemplo
1	Nro de pedido de BRIDGE	No	"internalNumber": "bridge0000000001",
2	Nro de pedido externo	No	"externalNumber": "000101250000006",
3	Código del canal	No	"channel": "bridge"

NOTA: debe ser enviado el nro del pedido BRIDGE o la combinación del nro de pedido externo + canal

JSON ejemplo

Allí, recibirá, en formato JSON, lo siguiente:

  "ack": 0,
  "order": [
    {
      "externalNumber": "000101250000006",
      "internalNumber": "bridge0000000001",
      "creationDate": "2023-01-20 15:35:30",
      "channelCode": "bridge",
      "currencyCode": "PESO ARGENTINO",
      "netAmount": "1000",
      "manualDiscountAmount": "0",
      "orderTypeCode": "order",
      "isPaid": true,
      "perceptionAmount": "0",
      "notes": "Orden creada desde POS",
      "party": {
        "code": "22000111",
        "firstName": "Gustavo",
        "lastName": "Morales",
        "email": "[email protected]",
        "typeCode": "PRS",
        "identifier": "22000111",
        "partyContactMethods": [
          {
            "name": "casa",
            "address": {
              "firstLine": "avenida siempre viva 762",
              "cityCode": "SLU_0038",
              "stateCode": "SLU",
              "countryCode": "ARG"
            },
            "emailAddress": "[email protected]",
            "telephone": {}
          },
          {
            "name": "prueba",
            "address": {
              "firstLine": "11 de septiembre",
              "cityCode": "BSAS_090",
              "stateCode": "BSAS",
              "countryCode": "ARG"
            },
            "telephone": {}
          }
        ]
      },
      "detail": [
        {
          "itemCode": "A123", 
          "storeCode": "1",
          "locationCode": "DEP1",
          "description": "A123 con atributos",
          "orderedQty": "1",
          "unitPrice": "1000",
          "deliveryOrPickup": "delivery",
          "pickupLocationCode": "",
          "pickupInformation": "INFORMACION",
          "requiredDate": "2023-01-20 15:25:04",
          "partyContactMethodName": "",
          "priceModifiers": [],
          "netAmount": "1000",
          "serializedUnits": []
        }
      ],
      "transaction": [
        {
          "id": "63cadc800da2bb6195d61202",
          "storeCode": "1",
          "terminalCode": "125",
          "operatorCode": "JuanO",
          "trxNumber": 6,
          "trxDate": "2023-01-20T15:25:04"
        }
      ],
      "payments": [
        {
          "tender": "Peso",
          "amount": "1000",
          "sellerName": "",
          "authorizationCode": "",
          "couponNumber": "",
          "lotNumber": "",
          "installments": "",
          "referenceNumber": ""
        }
      ]
    }
  ]
}

Descripción de campos

	Campo	Tipo	Descripción	Requerido	Ejemplos
	externalNumber	String	Código de la orden del originante	SI	000001
	internalNumber	String	Nro de pedido interno de BRIDGE	SI	bridge000014
	notes	String	Comentarios sobre la orden	NO	Enviar por la tarde
	creationDate	String	Fecha de creación	SI	2020-07-01 08:51:00 Formato: yyyy-MM-dd HH:mm:ss
	channelCode	String	Canal de Origen	NO	Este código será asignado por Napse de acuerdo al canal.
	originStore	String	Tienda que origina la orden	SI	Unicenter
	currencyCode	String	Moneda	SI	peso
	netAmount:	Number	Monto final del pedido, incluyendo el costo de entrega, menos los descuentos.	SI	1000
	manualDiscountAmount	Number	Importe de descuentos a la transacción	NO	Informar 0 si no existe ninguno
	orderTypeCode	String	Codigo del tipo de orden	NO	Por default: 'web'
	isPaid	Boolean	Indicador de cobrado	NO
	percepttionAmount	Number	Monto de percepciones (impuesto del cliente en Argentina)	NO
party (cliente asociado a la transacción). Requerido
	code	String	Código del cliente	SI	024314537
	firstName	String	Nombre del Cliente	SI	Martin
	lastName	String	Apellido del cliente	SI (solo si es typeCode = 'Person')	Malievac
	email	String	Correo del cliente	SI	[email protected]
	identifier	String	Número de documento	SI	24314537
partyContactMethods (direcciones del cliente)
	name	String	Nombre del método de contacto	SI	Personal, Trabajo, etc. Este dato debe ser único, en caso de encontrarse repetido dentro de la lista, se informará: "No puede realizar un pedido con dos métodos de contacto con el mismo nombre"
	address.firstLine	String	Calle y número	SI	Almafuerte 1000
	address.secondLine	String	Otra info	NO	Piso 10, Puerta 12
	address.cityCode	String	Ciudad	SI	MUN. Importante: código del listado de ciudades existentes, ver servicio city/all
	address.stateCode	String	Provincia	SI	BsAs. Importante: código del listado de provincias existentes, ver servicio state/all
	address.countryCode	String	Pais	SI	ARG. Importante: código del listado de países existentes, ver servicio country/all
	emailAddress	String	Email asociado a ese método de contacto	SI	Se puede poner el principal si no es diferente
	telephone.countryCode	String	código de País	NO	54
	telephone.areaCode	String	código de area	NO	11
	telephone.telephoneNumber	String	número de teléfono	SI	36637777
	extensionNumber	String	extensión	NO	066
detail (Detalle del pedido). Debe haber al menos
	itemCode	String	SKU del producto	SI	SAM01
	storeCode	String	Código de tienda desde donde saldrá el stock.	SI	UNICENTER
	locationCode	String	Código de depósito desde donde saldrá el stock	NO	VENTAS2
	description	String	Descripción del producto	SI	Samsung Galaxy S2
	orderedQty	Number	Cantidad pedida	SI	1
	unitPrice	Number	Precio unitario	SI	1000
	deliveryOrPickup	String	Si la linea será con retiro en tienda o envío	SI	delivery o pickup
	pickupLocationCode	String	Código de la locación en donde retirará	SI (si eligió la opción pickup)	UNICENTER. El código debe estar estipulado. Ver servicio customerOrderPickupLocation/all
	pickupInformation	String	Descripción de quien hará el retiro	Si, si eligió la opción pickup	Juan Perez retirará, teléfono: XXXXX
	partyContactMethodName	String	Dirección de envío del cliente	SI (si eligió como opción delivery)	Personal, debe existir entre una de las direcciones informadas para el cliente
serializedUnits: en caso de que BRIDGE ya haya surtido el pedido en las tiendas, se detallan los números de serie
	SerialNumber	String	Nro de serie del item	SI	Requerido sólo si se envía lista de series
	importDocNumber	String	Nro de despacho	NO
	customsNumber	String	Aduana	NO
	customsDate	String	Fecha de despacho	NO
	unitCount	Number	Cantidad	SI	Requerido sólo si se envía lista de series
transaction: este campo se usa en el caso de que la transacción haya sido facturada en bridge, no se usa en caso de que la orden venga de canales externos.
	id	String	El ID de mongodb de la transacción	SI
	storeCode	String	El código de tienda BRIDGE	SI
	terminalCode	String	El código de terminal BRIDGE	SI
	operatorCode	String	El código de operador BRIDGE	SI
	trxNumber	Number	El número de transacción BRIDGE	SI
	trxDate	Date	La fecha de la transacción BRIDGE	SI	Formato: yyyy-MM-dd HH:mm:ss
.priceModifiers : descuentos otorgados a los productos, esto se encuentra dentro de la colección detail
	percent	Number	Porcentaje de descuento	SI (si es informada la línea)	5
	amount	Number	Monto de descuento	SI (si es informada la línea)	1000
	reasonText	String	Razón del descuento	SI	Oferta del día
payments (pagos asociados al pedido)
	tender	String	Código del medio de pago	SI	peso. Importante: ver servicio tender/all para los códigos de pago permitidos.
	amount:	Number	Monto del pago	SI	1000
	planDescriptor	String	Descripción del plan de pagos elegido	SI (para pagos con tarjeta)	9 meses sin intereses
	sellerName	String	Nombre de la entidad	SI (para pagos con tarjeta)
	authorizationCode	String	Codigo de autorización de la tarjeta	SI (para pagos con tarjeta)	En el caso de MercadoPago, aquí se informa el id de pago.
	couponNumber	String	Número de cupón	SI (para pagos con tarjeta)	1
	lotNumber	String	Número de Lote	SI (para pagos con tarjeta)	1
	installments	String	Cuotas	SI (para pagos con tarjeta)	9
	referenceNumber	String	Referencia de la tarjeta	SI (para pagos con tarjeta)	44444444, en el caso de MercadoPago, allí va el id de la cuenta.