© 2024 Napse. Todos los derechos reservados.

REVISIONES

Fecha

Revisión

Cambios – Motivo

Autor

 

1.0

Creación del documento


CONTENIDO


Alcance

Se detallan algunos ejemplos de request de pedidos y servicios de OMNI


Ejemplos


ServicioDescripciónRequest de ejemplo Respuesta
1

/auth/login

LOGIN

Para solicitar el token

el clientSecret es el mismo y dura 24hs

POST

{
"clientId": "bridge-api",
"clientSecret": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
}


EJEMPLO


2

/order/create


Crear pedido con delivery y pagos

Para crear un pedido 

  • DELIVERY
  • CON PAGOS

POST

http://10.4.201.54:8381/order/create

{
   "externalNumber":"AA089920",
   "creationDate":"2024-08-16T10:33:34.280Z",
   "channelCode":"M002",
   "currencyCode":"ARS",
   "manualDiscountAmount":0,
   "netAmount":1000.0,
   "orderTypeCode":"web",
   "isPaid":true,
   "party":{
      "code":"23805069",
      "firstName":"Claudia",
      "lastName":"Martinez",
      "email":"contacto@electroweb.com.ar",
      "typeCode":"Person",
      "identificationType":1,
      "identifier":"23805069",
      "partyContactMethods":[
         {
            "name":"Facturacion",
            "address":{
               "firstLine":"Av. San Luis 1122",
               "countryCode":"ARG",
               "cityCode":"CRR_0027",
               "stateCode":"BSAS"
            },
            "emailAddress":"[email protected]",
            "telephone":{
               "telephoneNumber":"011 4990900"
            },
            "principalForDelivery":true,
            "principalForBilling":true
         }
      ]
   },
   "detail":[
      {
         "itemCode":"REM29",
         "description":"REM29",
         "storeCode":"1",
         "locationCode":"DEP1",
         "unitPrice":500,
         "orderedQty":2,        
         "deliveryOrPickup":"delivery",
         "deliveryCompany": "FEDEX",
         "pickupLocationCode":"1",
         "packageId":"0",
         "partyContactMethodName":"Facturacion",
         "pickupInformation":"Info: Cliente retira por tienda."
      }



     
   ],
   "payments": [
        {
            "tender": "Peso",
            "amount": 1000.0
        }
    ]
}

a) TOKEN VENCIDO


b) Nro de pedido externo ya existe

{
    "ack": 999,
    "message": "[\"Ya existe el código de orden originante AA089920\"]"
}


c) Pedido creado

{
    "ack": 0,
    "message": "El pedido ha ingresado con éxito.",
    "internalNumber": "bridge0000000386"
}

3

Crear pedido con delivery  y sin pagos

Para crear un pedido 

  • DELIVERY
  • SIN PAGOS

{
   "externalNumber":"AA089922",
   "creationDate":"2024-08-16T10:33:34.280Z",
   "channelCode":"M002",
   "currencyCode":"ARS",
   "manualDiscountAmount":0,
   "netAmount":1000.0,
   "orderTypeCode":"web",
   "isPaid":true,
   "party":{
      "code":"23805069",
      "firstName":"Claudia",
      "lastName":"Martinez",
      "email":"contacto@electroweb.com.ar",
      "typeCode":"Person",
      "identificationType":1,
      "identifier":"23805069",
      "partyContactMethods":[
         {
            "name":"Facturacion",
            "address":{
               "firstLine":"Av. San Luis 1122",
               "countryCode":"ARG",
               "cityCode":"CRR_0027",
               "stateCode":"BSAS"
            },
            "emailAddress":"[email protected]",
            "telephone":{
               "telephoneNumber":"011 4990900"
            },
            "principalForDelivery":true,
            "principalForBilling":true
         }
      ]
   },
   "detail":[
      {
         "itemCode":"REM29",
         "description":"REM29",
         "storeCode":"1",
         "locationCode":"DEP1",
         "unitPrice":500,
         "orderedQty":2,        
         "deliveryOrPickup":"delivery",
         "deliveryCompany": "FEDEX",
         "pickupLocationCode":"1",
         "packageId":"0",
         "partyContactMethodName":"Facturacion",
         "pickupInformation":"Info: Cliente retira por tienda."
      }



     
   ]
}

{
    "ack": 0,
    "message": "El pedido ha ingresado con éxito.",
    "internalNumber": "bridge0000000387"
}

4

Crear pedido con descuentos al ítem

Para crear un pedido con descuentos al articulo


Se le debe restar al monto neto del pedido 

 {
         "itemCode":"ADIDAS1",
         "description":"ADIDAS zapatillas",
         "storeCode":"1",        
         "unitPrice":50000,
         "locationCode":"DEP1",
         "orderedQty":1,
         "deliveryOrPickup":"pickup",
         "deliveryCompany":"",
         "packageId":"0",
         "pickupLocationCode":"1",
         "partyContactMethodName":"Facturacion",
         "priceModifiers": [
                {
                    "percent": 10,
                    "amount": 5000,
                    "reasonText": "Segunda Unidad"
                }
          ],


5

Crear pedido con pago con tarjeta y recargo financiero

Pago con tarjeta y recargo financiero


  • articulo vendido por magnitud (PESO)

{
   "externalNumber":"AA1052",
   "creationDate":"2024-07-18T10:33:34.280Z",
   "channelCode":"Farma",
   "currencyCode":"ARS",
   "manualDiscountAmount":0,
   "netAmount":3100.0,
   "orderTypeCode":"web",
   "isPaid":true,
   "party": {
        "code": "31821907",
        "firstName": "Lorena",
        "lastName": "Ruiz",
        "email": "lorenaeliruiz@gmail.com",
        "typeCode": "Person",
        "identificationType": 1,
        "identifier": "31821907",
        "partyContactMethods": [
            {
                "name": "Lorena Ruiz",
                "address": {
                    "firstLine": "Colon 1475 11 1ro",
                    "countryCode": "ARG",
                    "cityCode": "BSAS_090",
                    "stateCode": "BSAS"
                },
                "emailAddress": "lorenaeliruiz@gmail.com",
                "telephone": {
                    "telephoneNumber": "5492235210362"
                },
                "principalForDelivery": true,
                "principalForBilling": true,
                "useForBilling": true
            }
        ]
    },
   "detail":[
      {
         "itemCode":"0303457",
         "description":"JAMON CRUDO",
         "storeCode":"1",
         "locationCode":"DEP1",
         "unitPrice":2000,
         "orderedQty":1,
         "magnitude": 1.5,
         "deliveryOrPickup":"pickup",
         "pickupLocationCode":"1",
         "deliveryCompany":"",
         "packageId":"0",
         "partyContactMethodName":"Facturacion",
         "pickupInformation":"Info: Cliente retira por tienda."
      },
 {
            "itemCode": "998877",
            "description": "RECARGO",
            "storeCode": "1",
            "locationCode": "DEP1",
            "unitPrice": 100.0,
            "orderedQty": 1,
            "deliveryOrPickup": "pickup",
            "pickupLocationCode": "1",
            "packageId": "0",
            "partyContactMethodName": "Facturacion",
            "pickupInformation": "Pickup",
            "priceModifiers": [
               
            ]
            }   ],
    "payments": [
       
        {
            "tender": "DI",
            "amount": 3100.0,
            "planDescriptor": "Cantidad de Cuotas: 6",
            "sellerName": "Visa",
            "authorizationCode": "003836",
            "couponNumber": "7933",
            "lotNumber": "1234",
            "installments": "6",
            "referenceNumber": "433830******6200",
             "planSurcharge":10,
             "paymentDate":"2024-06-25T10:33:34.280Z",
             "surcharge": 100
        }
    ]
}



6

Crear pedido con un ítem costo de envío y pagos parciales 

Pedido con costo de envío y dos pagos parciales


{
   "externalNumber":"AA049",
   "creationDate":"2024-06-26T10:33:34.280Z",
   "channelCode":"ODV",
   "currencyCode":"ARS",
   "manualDiscountAmount":0,
   "netAmount":26100.0,
   "orderTypeCode":"order",
   "isPaid":true,
   "party": {
        "code": "31821907",
        "firstName": "Lorena",
        "lastName": "Ruiz",
        "email": "lorenaeliruiz@gmail.com",
        "typeCode": "Person",
        "identificationType": 1,
        "identifier": "31821907",
        "partyContactMethods": [
            {
                "name": "Lorena Ruiz",
                "address": {
                    "firstLine": "Colon 1475 11 1ro",
                    "countryCode": "ARG",
                    "cityCode": "BSAS_090",
                    "stateCode": "BSAS"
                },
                "emailAddress": "lorenaeliruiz@gmail.com",
                "telephone": {
                    "telephoneNumber": "5492235210362"
                },
                "principalForDelivery": true,
                "principalForBilling": true,
                "useForBilling": true
            }
        ]
    },
   "detail":[
      {
         "itemCode":"PEPITOS",
         "description":"PEPITOS x10",
         "storeCode":"1",
         "locationCode":"DEP1",
         "unitPrice":100,
         "orderedQty":2,
         "units": 10,
         "deliveryOrPickup":"delivery",
         "pickupLocationCode":"1",
         "deliveryCompany":"OCA",
         "packageId":"0",
         "partyContactMethodName":"Lorena Ruiz",
         "pickupInformation":"Info: envio por la mañana."
      },
      {
         "itemCode":"coca600",
         "description":"Coca 600",
         "storeCode":"1",        
         "unitPrice":2000,
         "locationCode":"DEP1",
         "orderedQty":2,
         "units": 6,
         "deliveryOrPickup":"delivery",
         "deliveryCompany":"OCA",
         "packageId":"0",
         "pickupLocationCode":"1",
         "partyContactMethodName":"Lorena Ruiz",
         "pickupInformation":"Info: envio por la mañana"        
      },
       {
            "itemCode": "111",
            "description": "COSTO DE ENVIO",
            "storeCode": "1",
            "locationCode": "DEP1",
            "unitPrice": 100.0,
            "orderedQty": 1,
            "deliveryOrPickup": "delivery",
            "deliveryCompany":"OCA",
            "pickupLocationCode": "1",
            "packageId": "0",
            "partyContactMethodName": "Lorena Ruiz",
            "pickupInformation": "envio por la mañana",
            "priceModifiers": [
               
            ]
        }
   ],
    "payments": [
        {
            "tender": "Peso",
            "amount": 6000.00      },            
        {
            "tender": "DI",
            "amount": 20100.0,
            "planDescriptor": "Cantidad de Cuotas: 6",
            "sellerName": "Diners",
            "authorizationCode": "003836",
            "couponNumber": "7933",
            "lotNumber": "1234",
            "installments": "6",
            "referenceNumber": "433830******6200",            
             "paymentDate":"2024-06-25T10:33:34.280Z"
        }
    ]
}



7

Consultar por el estado de un pedido 

order/state/bridge0000000199


GET

http://10.4.201.54:8381/order/state/bridge0000000199


8

Solicitar el cambio de estado de un pedido 

order/state/change


POST

http://10.4.201.54:8381/order/state/change

{
    "orderState": "cancelled",
    "internalNumber": "bridge0000000021",
    "notes": "el pedido ha sido cancelado por el cliente"
}



9

Consultar por el estado de la solicitud de un cambio de estado de un pedido 

order/state/change/status


GET

http://10.4.201.54:8381/order/state/change/status

{
       "internalNumber": "bridge0000000199"
   }



10

Devolución sin referencia por servicio

order/returnBill


POST

http://10.4.201.54:8381/order/returnBill

{
   "internalNumber":"bridge0000000033",
   "manualDiscountAmount":0,
   "detail":[
      {
         "itemCode":"c10",
         "description":"Bolsa de Carbon",
         "storeCode":"1",
         "locationCode":"DEP1",
         "unitPrice":1000,
         "orderedQty":1               }
         ]


}


11

Consulta del estado de la devolución pedida

order/returnBill/status


GET

http://10.4.201.54:8381/order/returnBill/status

{
   "internalNumber":"bridge0000000036"  
}



12

Consulta de maestros: items

item/CODIGOITEM


POST

http://10.4.201.54:8381/item/REM028

{
"moreDetail": true



}


13

Obtener los datos de un pedido

order/info



GET 

http://10.4.201.54:8481/order/info

{
"internalNumber": "bridge0000000135"
}


14

Consulta de precios 

/itemPriceCurrent/all


POST

http://10.4.201.54:8381/itemPriceCurrent/all

{
    "store": "1",
   "channel": "OD"
}