Opera con Nuestras APIS

Para operar con nuestras APIs, es fundamental que tu negocio esté registrado como partner en Falabella y que cuentes con tu User ID y API Key, obtenidos a través de https://sellercenter.falabella.com/. Los detalles de este proceso se explicarán más adelante.

Es importante destacar que, ya sean llamadas GET o POST, siempre se generará una respuesta, la cual puede variar en detalle dependiendo de la acción solicitada, independientemente de si fue exitosa o no.

Estas respuestas pueden estar en formato XML o JSON, y esta preferencia se puede configurar mediante los parámetros de entrada según corresponda.

¿Cómo obtener tus credenciales?

Credenciales de acceso para un usuario ya creado en Falabella Seller Center

Como se mencionó anteriormente, para operar con nuestra API, necesitas tener acceso a la API Key. Para obtenerla, sigue estos pasos:

1. Ingresa a https://sellercenter.falabella.com/ con tu usuario y contraseña de Falabella Seller Center.
2. Una vez dentro, haz clic en "Mi cuenta".
3. En el menú desplegable, selecciona "Integraciones".
4. En la sección "API Explorer" encontrarás tu User ID y tu API Key.

Crear un nuevo usuario

El administrador debe ingresar a https://sellercenter.falabella.com/ con su usuario y contraseña de Falabella Seller Center.

1. Una vez dentro, haz clic en "Mi cuenta".
2. En el menú desplegable, haz clic en "Usuarios".
3. Luego haz clic en "Agregar Usuario".
4. Completa los datos como correo electrónico, nombre, rol, entre otros.
5. Para que el nuevo usuario pueda acceder a la API Key, debe seguir los pasos descritos en "Credenciales de acceso para un usuario ya creado en Falabella Seller Center".

Roles y privilegios

No todos los usuarios de Falabella Seller Center pueden invocar todos los métodos de la API.

Las llamadas a la API no pueden ser anónimas. Cada llamada se realiza en nombre de un usuario específico de Falabella Seller Center, identificado mediante el parámetro UserID y autenticado con su correspondiente API Key. Para poder hacer una llamada a un método en particular, el usuario debe tener un rol específico, según se detalla a continuación.

Roles y Métodos Disponibles

Headers de la Solicitud

🚧

Headers requeridos

Todas las solicitudes deben incluir el header User-Agent con el siguiente formato:

SELLER_ID/TECNOLOGÍA_USADA/VERSIÓN_TECNOLOGÍA/TIPO_INTEGRACIÓN/CÓDIGO_UNIDAD_DE_NEGOCIO

• SELLER_ID: Corresponde a tu ID de vendedor. Si no lo recuerdas, puedes encontrarlo en el Seller Center de Falabella bajo "Mi cuenta", o consultarlo mediante el endpoint GetSellerByUser.
• TECNOLOGÍA_USADA: Lenguaje o tecnología utilizada en la integración (por ejemplo, PHP, Node, Python).
• VERSIÓN_TECNOLOGÍA: Versión de la tecnología utilizada (por ejemplo, 8.1.7).
• TIPO_INTEGRACIÓN: Este campo varía según el tipo de integración:
  1. Si eres un negocio que se integra directamente con Falabella: PROPIA
  2. Si eres un integrador que conecta múltiples negocios: NOMBRE_DEL_INTEGRADOR
• CÓDIGO_UNIDAD_DE_NEGOCIO: Código del país con el que te integras:
  • Chile: FACL
  • Colombia: FACO
  • Perú: FAPE

¿Eres un negocio que se integra directamente con Falabella?

Ejemplo:
User-Agent: JJJ123/PHP/8.1.7/PROPIA/FACL

¿Eres un integrador de múltiples negocios?

Ejemplo:
User-Agent: JJJ123/PHP/8.1.7/MYINTEGRATOR/FACL

Puedes revisar más detalles sobre este header en MDN - User-Agent

Datos adicionales en POST

Como hemos visto, todos los métodos se ejecutan vía HTTP, algunos mediante GET y otros mediante POST.

Todas las llamadas siempre deben incluir los siguientes parámetros:
Action, Timestamp, UserID, Version, y Signature.

A menudo se agregan parámetros adicionales según el método.
Por ejemplo, el endpoint GetProducts acepta parámetros adicionales como Search.

A continuación, se muestra un ejemplo del contenido adicional enviado en el body para el método ProductUpdate:

XML

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
  <Product>
   <SellerSku>SKU-AAAA</SellerSku>
   <Price>10.0</Price>
   <SaleStartDate>2015-07-01T11:11:11+0000</SaleStartDate>
   <SaleEndDate>2015-07-01T11:11:11+0000</SaleEndDate>
   <SalePrice>8.0</SalePrice>
  </Product>
  <Product>
   <SellerSku>SKU-BBBB</SellerSku>
   <Price>32.5</Price>
  </Product>
</Request>

📘 GET o POST

El uso de los métodos GET o POST depende de la acción a ejecutar y está definido en esta documentación. Incluso si no es necesario enviar datos adicionales en la solicitud, se debe usar POST si así lo especifica el método.

📘 Límite de tamaño en solicitudes POST

Según la configuración estándar del servidor de Seller Center, el tamaño máximo del cuerpo de una solicitud POST es de 128MB.

📘 Consideraciones con JSON

Cuando trabajes con JSON, todos los valores deben tratarse como strings, incluyendo números o booleanos. Ejemplo:

XMLJSON

<data>
  <PackageHeight>12</PackageHeight>
  <PackageWeight>2</PackageWeight>
  <isMandatory>true</isMandatory>
</data>

{ "PackageHeight": "12",

"PackageWeight": "2",

"isMandatory": "true" }

Resultados sin datos

Algunos métodos devuelven documentos XML extensos. Por ejemplo, GetProducts devuelve un documento XML muy largo con el listado de cada producto. La sintaxis de estas respuestas se explica en detalle en la página de referencia del método correspondiente.

Sin embargo, varios métodos no devuelven información en el cuerpo. En estos casos, igualmente se genera una respuesta que llamamos SuccessResponse. Dependiendo del parámetro Format enviado, puede devolverse en formato JSON o XML (puedes ver ambos ejemplos a continuación):

<?xml version="1.0" encoding="UTF-8"?>
<SuccessResponse>
  <Head>
    <RequestId>13e55362-3cc4-446b-b3db-c1df0900ae9e</RequestId>
    <RequestAction>PriceFeed</RequestAction>
    <ResponseType></ResponseType>
    <Timestamp>2015-07-01T11:11:11+0000</Timestamp>
  </Head>
  <Body/>
</SuccessResponse>

{
 "SuccessResponse": {
   "Head": {
     "RequestId": "13e55362-3cc4-446b-b3db-c1df0900ae9e",
     "RequestAction": "PriceFeed",
     "ResponseType": "",
     "Timestamp": "2015-07-01T11:11:11+0000"
   },
   "Body": ""
 }
}

Los campos dentro de la sección <Head> siempre son los mismos, independientemente de si el método devuelve datos dentro del <Body> o no. El significado de cada campo en una SuccessResponse es el siguiente:

De forma similar, existe una estructura de respuesta para errores: ErrorResponse. Esta también contiene una sección <Body>, que muchas veces puede estar vacía, pero que puede incluir detalles adicionales sobre el error. A continuación, un ejemplo de mensaje de error con contenido en el cuerpo:

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse>
  <Head>
    <RequestAction>Price</RequestAction>
    <ErrorType>Sender</ErrorType>
    <ErrorCode>1000</ErrorCode>
    <ErrorMessage>Format Error Detected</ErrorMessage>
  </Head>
  <Body>
    <ErrorDetail>
      <Field>StandardPrice</Field>
      <Message>Field must contain a positive number with a dot as decimal
        separator and 2 decimals (e.g. 120.00)
      </Message>
      <Value>10.0x</Value>
      <SellerSku>Example Seller SKU</SellerSku>
    </ErrorDetail>
  </Body>
</ErrorResponse>

Response:
{
  "ErrorResponse": {
    "Head": {
      "RequestAction": "ProductUpdate",
      "ErrorType": "Platform",
      "ErrorCode": "1000",
      "ErrorMessage": "Could not save product: 0, A exact match of the document is being processed"
    },
    "Body": ""
  }
}

Aquí también, los campos tienen un significado fijo en todos los métodos:

Errores

Como se describió anteriormente, cuando un endpoint no puede ejecutarse, se devuelve un mensaje de error con el siguiente formato:

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse>
  <Head>
    <RequestAction>GetOrder</RequestAction>
    <ErrorType>Sender</ErrorType>
    <ErrorCode>[number]</ErrorCode>
    <ErrorMessage>E0[number]: [error message]</ErrorMessage>
  </Head>
  <Body/>
</ErrorResponse>

 

Errores Globales