Referencia de la API Futurlog

Introducción

Los Web Services Futurlog (FuturWeb) permiten intercambiar información entre sus sistemas y los de Futurlog. El principio: son sus programas los que llaman a nuestros servicios para transmitir (bajada) sus catálogos y pedidos, y para recuperar (subida) el stock, los estados y el seguimiento. La API es REST e intercambia JSON.

Autenticación

Cada llamada se autentica directamente en la URL, mediante su código de comerciante, su login y su clave. La estructura general de una solicitud es:

https://jws.futurlog.com/{Application}/{Action}/{MerchantCode}/{Login}/{Key}/{Parameter}

Formato y gestión de errores

Todas las solicitudes envían la cabecera Accept: application/json. Una respuesta correcta devuelve un código HTTP 200 (un booleano para las creaciones, una lista para las lecturas). En caso de error, el cuerpo contiene un objeto Error:

{
  "Error": {
    "Message": "...",
    "Code": "E_UNKNOWN_MERCHANT",
    "Data": [ { "Key": "...", "Value": "..." } ]
  }
}

Pedidos

Productos y stock

Recepciones

Modelos de datos

Objetos enviados / recibidos, lista exhaustiva de campos. (O) = obligatorio, (O/F) = obligatorio según sus parámetros FuturLog, string[n] = longitud máx. n, ? = nullable. Los campos sin anotación son facultativos.

Order solicitud

{
  "OrderNumber": "string[9]",                // (O) único
  "BrandCode": "string[3]",                  // (O/F) código de la enseña
  "CurrencyCode": "string[3]",               // divisa (EUR, USD, ...)
  "CustomerNumber": "string[50]",            // n.º de pedido cliente (B2B)
  "Language": "string[2]",                   // idioma de la enseña
  "Incoterm": "string[3]",
  "DateUtc": "datetime?",                    // fecha del pedido
  "ScheduledTransmissionDate": "datetime?",  // transmisión programada al logístico
  "MerchantCarrierCode": "string[7]",        // transportista del comerciante: código
  "MerchantCarrierLabel": "string[50]",      // transportista del comerciante: nombre
  "ShippingServiceCode": "string[3]",        // A2P, CIT, BPR, CDI, ACP, DOM, RDV, MRL...
  "StockType": "string[3]",              // tipo de stock (STD, DEF, BLQ), STD por defecto
  "PickerComments": "string[500]",           // comentario del preparador
  "EshopId": "string", "EshopCustom1": "string",     // ref. / info e-shop
  "CustomInvoiceBase64": "string",          // factura personalizada (Base64)
  "CustomDocumentBase64": "string",         // documento personalizado (Base64)
  "Address": {                                    // (O) dirección de entrega
    "CorporateName": "string[100]",
    "LastName": "string[50]", "FirstName": "string[50]",
    "Address1": "string[35]",              // (O)
    "Address2": "string[35]", "Address3": "string[35]",
    "ZipCode": "string[10]",               // (O)
    "City": "string[50]",                  // (O)
    "ProvinceCode": "string[2]",            // EE. UU. / Canadá
    "CountryCode": "string[2]",             // (O)
    "MobilePhone": "string[30]",            // (O)
    "Phone": "string[30]",
    "Email": "string[100]",
    "PickupPointNumber": "string[10]",       // punto de recogida
    "Comments": "string[500]"
  },
  "Billing": {                                    // facturación
    "CorporateName": "string[50]",
    "LastName": "string[50]", "FirstName": "string[50]",
    "Address1": "string[35]",              // (O)
    "Address2": "string[35]", "Address3": "string[35]",
    "ZipCode": "string[10]",               // (O)
    "City": "string[50]",                  // (O)
    "ProvinceCode": "string[2]",            // EE. UU. / Canadá
    "CountryCode": "string[2]",             // (O)
    "BillNumber": "string[50]",            // n.º de factura
    "TotalAmount": "decimal?",            // (O) total del pedido con IVA
    "ShipmentPrice": "decimal?",          // gastos de envío con IVA
    "ShipmentVAT": "decimal?",            // (O/F) IVA de los gastos de envío
    "Discount": "decimal?", "DiscountHT": "decimal?", "DiscountTTC": "decimal?"  // descuento (sin/con IVA según parámetros)
  },
  "Gift": {                                       // regalo
    "Message": "string",                   // mensaje de la tarjeta regalo
    "PackageType": "int?"                  // tipo de papel de regalo
  },
  "OrderLines": [ {                               // (O) líneas de pedido
    "ProductCode": "string[30]",            // (O) ref. de producto
    "InternalProductCode": "string[30]",    // (O) ref. interna
    "ProductLabel": "string[120]",         // (O)
    "ProductBatchNumber": "string[30]",      // n.º de lote
    "Quantity": 0,                         // (O)
    "UnitPrice": "decimal?", "UnitPriceHT": "decimal?", "UnitPriceTTC": "decimal?",  // (O/F) precio unitario (sin/con IVA según parámetros)
    "VATRate": "decimal?"                  // (O/F) tipo de IVA
  } ]
}

Product solicitud

{
  "Code": "string[30]",               // (O) código de producto
  "Label": "string[120]",            // (O) descripción del producto
  "BarCode": "string[60]",           // código de barras
  "BrandCode": "string[3]",          // código de la enseña
  "ExternalCode": "string[60]",      // código de proveedor
  "HsCode": "string[10]",            // nomenclatura aduanera
  "OriginCountryCode": "string[2]",  // país de origen
  "Family": "string[100]",           // categoría de producto
  "Model": "string[100]", "Color": "string[50]", "Size": "string[100]",
  "Type": "string[100]",            // 'p' = físico, 'v' = virtual
  "Weight": "decimal?",             // peso en kg
  "Height": "decimal?", "Width": "decimal?", "Length": "decimal?",   // dimensiones en cm
  "UnitPriceHT": "decimal?",        // último precio sin IVA
  "TvaRate": "decimal?",            // tipo de IVA
  "WeePrice": "decimal?",           // eco-participación
  "AlertThreshold": 0,               // umbral de alerta de stock
  "IsActive": true, "IsLotManaged": false,
  "PictureUrl": "string[300]",       // URL de la imagen
  "EshopId": "string", "EshopCustom1": "string",     // ref. / info e-shop
  "Parameter1": "string", "Parameter2": "string",  // parámetros personalizados
  "ProductsInBundle": [ { "Code": "string[30]", "Quantity": 1 } ]  // componentes (si es un producto compuesto)
}

Receipt solicitud recepción prevista

{
  "ScheduledDate": "datetime",      // (O) fecha de recepción prevista
  "StockType": "string[3]",    // tipo de stock objetivo: STD (defecto), DEF (defectuoso), BLQ (bloqueado)
  "SupplierName": "string[100]",    // (O) proveedor
  "ReceiptNumber": "string[12]",    // n.º de recepción
  "CarrierName": "string[100]",     // transportista
  "DeliveryComments": "string[500]", // comentario de entrega
  "ReceiptLines": [ {                       // (O) líneas de recepción
    "ProductCode": "string[30]",          // (O) ref. de producto
    "Quantity": 0                        // (O) cantidad anunciada
  } ]
}

StockReturn respuesta

{
  "Data": [ {
    "Code": "string[30]",
    "AvailableQuantity": 0,
    "ReservedQuantity": 0,
    "BatchesStock": [ { "Number": "string[50]", "OnHandQuantity": 0 } ]
  } ]
}

Códigos de error

Devueltos en el objeto Error.Code. Principales códigos por dominio: