Esta API proporciona el estado actual del pedido, el calendario de envío del pedido y también la lista de artículos del pedido en función de los parámetros pasados en la solicitud.
La información devuelta se basa en la cuenta registrada.
Disponibilidad por País - Lista de países para los cuales ya hemos evaluado el rendimiento, disponibilidad y tiempo de respuesta del API:
- Argentina, Australia, Bélgica, Brasil, Bulgaria, Canadá, Chile, Colombia, Croacia, Dinamarca, Finlandia, Francia, Alemania, India, México, Países Bajos, Nueva Zelanda, Noruega, Perú, Portugal, Rumanía, Eslovenia, España, Suecia, Suiza, Turquía, Reino Unido y Estados Unidos.
Si tu país no se encuentra en la lista, puedes contactarnos directamente o comunicarte con tu Punto de Contacto de Schneider (POC) para verificar si tu país tiene acceso a este API.
El acceso a la API requerirá autenticación oAuth, consulte los detalles en el portal.
- Esta API soporta paginación, por favor refiérase a los detalles a continuación para entender cómo funciona la paginación:
- Cuando se solicita la API con parámetros para devolver una lista muy larga de elementos, la respuesta se pagina para evitar una carga pesada y la congestión de la red.
- Se puede establecer un parámetro de solicitud para indicar cuántos elementos deben devolverse en una única respuesta de la API. (tamaño de página<=100)
Nota: El tamaño de página por defecto es 10 - Cada respuesta de la API también devuelve parámetros como totalNumberOfRecords, totalNumberOfPages y pageNumber.
- totalNumberOfRecords : Cuántos registros pueden devolverse en la respuesta según los parámetros introducidos en la solicitud.
- totalNumberOfPages : Cuántas páginas se esperan basándose en el pageSize actual y el número total de registros. Por ejemplo, 100 registros con tamaño de página 10 requerirán 10 páginas.
- pageNumber : para qué número de página se requiere respuesta.
Parámetros admitidos en la API:
|
Parámetros |
Tipo de datos |
Descripción |
Example |
|
country |
cadena |
Código del país para el que se solicitan los datos del pedido. |
US |
|
order-number |
cadena |
Número de pedido en ERP, puede ser el valor completo del pedido o el valor "startingFrom". |
AB12345 |
|
order-status |
cadena |
Estado actual del pedido en ERP. |
Entregado |
|
page |
cadena |
Número de página actual según numberOfRecords y tamaño de página. |
1 |
|
page-size |
cadena |
Número de registros esperados en la respuesta; |
10 |
|
item-number |
cadena |
Número de artículo de un artículo concreto del pedido. |
79895 |
|
purchaser-id |
cadena |
Un ID de 10 o 5 dígitos del comprador utilizado en mySE. |
1000006792 |
Esta API admite las 3 operaciones siguientes:
| ResourcePath | Parámetros obligatorios | Parámetros opcionales | Respuesta esperada |
| /orders/{country} | país |
Order-number, order-status, page, page-size, purchaser-id |
Todos los pedidos vinculados a la cuenta en el país solicitado. |
| /orders/{country}/{order-number}/{item-number}/shipment-schedules | país, order-number, item-number |
purchaser-id |
Se devolverá el calendario de envíos de la línea solicitada en el pedido. |
| /orders/{country}/{order-number} | país, order-number |
Item-number, purchaser-id | Se devuelve la información general junto con el calendario de envío de los artículos/artículos del pedido. |
