Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.



Image Modified

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




© 2024 Napse. Todos los derechos reservados.

Painel
borderColor#E4E3E3
titleColor#ffffff
borderWidth1
titleBGColor#704581
titleCONTENIDO


Expandir
titleExpandir contenido
Índice


...

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

Disponible a partir de v7.5.4

...

  "externalNumber": "000101250000006",

  "channel": "bridge"

}


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

NOTA: para la consulta debe ser enviado enviado 

a) el nro. del pedido BRIDGE o (este valor es único porque es centralizado) ó

b) la combinación del nro. de pedido externo + canal 

JSON ejemplo

canal (esta combinación es necesaria porque puede repetirse el nro de pedido externo por canal) 

  • Sólo se responde un pedido (no una lista) 


JSON ejemplo

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

Bloco de código
  "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",
      "orderState": "LISTO PARA SURTIR", 
      "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",
        }
  "billNumber": "TF B B-1994-00000283"
       }
      ],
      "payments": [
        {
          "tender": "Peso",
          "amount": "1000",
          "sellerName": "",
          "authorizationCode": "",
          "couponNumber": "",
          "lotNumber": "",
          "installments": "",
          "referenceNumber": ""
        }
      ]
    }
  ]
}


Descripción de campos de la respuesta



CampoTipoDescripción
Requerido
Ejemplos

externalNumberStringCódigo de la orden del originante
SI
000001

internalNumberStringNro de pedido interno de BRIDGE
SI
bridge000014

notesStringComentarios sobre la orden
NO
Enviar por la tarde

creationDateStringFecha de creación
SI
2020-07-01 08:51:00 Formato: yyyy-MM-dd HH:mm:ss


channelCodeStringCanal de Origen
NO
Este código será asignado por Napse de acuerdo al canal.

originStoreStringTienda que origina la orden
SI
Unicenter


currencyCodeStringMoneda
SI
peso

netAmount:NumberMonto final del pedido, incluyendo el costo de entrega, menos los descuentos.
SI
1000

manualDiscountAmountNumberImporte de descuentos a la transacción
NO
Informar 0 si no existe ninguno


orderTypeCode
StringCodigo del tipo de orden
NO
Por default: 'web'

isPaid
BooleanIndicador de cobrado
NOparty


percepttionAmountNumberMonto de percepciones (impuesto del cliente en Argentina) 

externalSellerID
NO
StringID del vendedor externo del pedido

externalSellerNameStringNombre del vendedor externo del pedido 

orderStateStringEstado del pedido Ej: LISTO PARA SURTIR (a partir de v7.8)
party (cliente asociado a la transacción). Requerido

codeStringCódigo del cliente
SI
024314537

firstNameStringNombre del Cliente
SI
Martin

lastNameStringApellido del cliente
SI (solo si es typeCode = 'Person')MalievacemailString
Malievac

emailStringCorreo del cliente
SI
[email protected]

identifierStringNúmero de documento
SI
24314537
partyContactMethods (direcciones del cliente)

nameStringNombre 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.firstLineStringCalle y número
SI
Almafuerte 1000

address.secondLineStringOtra info
NO
Piso 10, Puerta 12


address.cityCodeStringCiudad
SI
MUN. Importante: código del listado de ciudades existentes, ver servicio city/all


address.stateCodeStringProvincia
SI
BsAs. Importante: código del listado de provincias existentes, ver servicio state/all


address.countryCodeStringPais
SI
ARG. Importante: código del listado de países existentes, ver servicio country/all


emailAddressStringEmail asociado a ese método de contacto
SI
Se puede poner el principal si no es diferente

telephone.countryCodeStringcódigo de País
NO
54

telephone.areaCodeStringcódigo de area
NO
11

telephone.telephoneNumberStringnúmero de teléfono
SI
36637777

extensionNumberStringextensión
NO
066
detail (Detalle del pedido). Debe haber al menos


itemCodeStringSKU del producto
SI
SAM01


storeCodeStringCódigo de tienda desde donde saldrá el stock.
SI
UNICENTER


locationCodeStringCódigo de depósito desde donde saldrá el stock
NO
VENTAS2

descriptionStringDescripción del producto
SI
Samsung Galaxy S2

orderedQtyNumberCantidad pedida
SI
1
unitPricepartyContactMethodNameStringDirección de envío del clienteSI (si eligió como opción delivery)Personal, debe existir entre una de las direcciones informadas para el clienteserializedUnits: en caso de que BRIDGE ya haya surtido el pedido en las tiendas, se detallan los números de serieSerialNumberStringNro de serie del itemSI

fulfilledQtyNumber
Precio unitarioSI1000deliveryOrPickupStringSi la linea será con retiro en tienda o envíoSIdelivery o pickuppickupLocationCodeStringCó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/allpickupInformationStringDescripción de quien hará el retiroSi, si eligió la opción pickupJuan Perez retirará, teléfono: XXXXX
Cantidad surtida/controlada1

unitsNumberCantidad de unidades de la presentación asociada al código de barras (si fue ingresado)6

magnitudeNumberMagnitud (si el item requiere de peso, longitud) 1,5 

barcodeStringCódigo de barras utilizado para el pedido 771234567891

unitPriceNumberPrecio unitario1000

deliveryOrPickupStringSi la linea será con retiro en tienda o envíodelivery o pickup


pickupLocationCodeStringCódigo de la locación en donde retiraráUNICENTER. El código debe estar estipulado. Ver servicio customerOrderPickupLocation/all

pickupInformationStringDescripción de quien hará el retiroJuan Perez retirará, teléfono: XXXXX

partyContactMethodNameStringDirección de envío del clientePersonal, 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

SerialNumberStringNro de serie del itemRequerido sólo si se envía lista de series

importDocNumberStringNro de despacho
NO


customsNumberStringAduana
NO


customsDateStringFecha de despacho
NO


unitCountNumberCantidad
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.

idStringEl ID de mongodb de la transacción
SI


storeCodeStringEl código de tienda BRIDGE
SI


terminalCodeStringEl código de terminal BRIDGE
SI


operatorCodeStringEl código de operador BRIDGE
SI


trxNumberNumberEl número de transacción BRIDGE
SI


trxDate
DateLa fecha de la transacción BRIDGE
SI
Formato: yyyy-MM-dd HH:mm:ss

billNumberStringTipo y nro de comprobante (a partir de v7.8)

Ejemplo "billNumber":

"TF B B-1994-00000283"

"NC B B-1994-00000284"

.priceModifiers : descuentos otorgados a los productos, esto se encuentra dentro de la colección detail

percentNumberPorcentaje de descuento
SI (si es informada la línea)5
5

amountNumberMonto de descuento
SI (si es informada la línea)
1000

reasonTextStringRazón del descuento
SI
Oferta del día
payments (pagos asociados al pedido)

Image Modified

tenderStringCódigo del medio de pago
SI
peso. Importante: ver servicio tender/all para los códigos de pago permitidos.

amount:NumberMonto del pago
SI
1000

planDescriptorStringDescripción del plan de pagos elegido
SI (para pagos con tarjeta)
9 meses sin intereses

sellerNameStringNombre de la entidad
SI (para pagos con tarjeta)


authorizationCodeStringCodigo de autorización de la
tarjetaSI (para pagos con
tarjeta
)
  • En el caso de MercadoPago, aquí se informa el id de pago.

couponNumberStringNúmero de cupón
SI (para pagos con tarjeta)
1

lotNumberStringNúmero de Lote
SI (para pagos con tarjeta)
1

installmentsStringCuotas
SI (para pagos con tarjeta)
9

referenceNumberStringReferencia de la
tarjetaSI (para pagos con
tarjeta
)
44444444, en el caso de MercadoPago, allí va el id de la cuenta.


Respuesta del servicio: 

  1. ack es el código de respuesta
  2. message: descripción del error en caso de existir.


Código de Error

Descripción

0

Status 200

ack = 0

La operación se ha ejecutado con éxito e informa el pedido encontrado


Ejemplos de otras respuestas : 

Status 500

{
    "message": "La orden no existe en la base de datos."
}


{
    "message": "No hay registros con el canal ODV2."
}


{
    "message": "Debe enviar por lo menos 1 filtro."
}