Esta API fornece o status atual do pedido, o cronograma de embarque do pedido e também a lista de itens no pedido com base nos parâmetros passados no pedido.
As informações devolvidas são baseadas em conta registrada.
Disponibilidade por País - Lista de países para os quais já testamos o desempenho, disponibilidade e tempo de resposta do API:
- Argentina, Austrália, Áustria, Bélgica, Brasil, Bulgária, Canadá, Chile, Colômbia, Croácia, Dinamarca, Equador, Estônia, Finlândia, França, Alemanha, Grécia, Hungria, Índia, Indonésia, Irlanda, Cazaquistão, Letônia, Lituânia, México, Países Baixos, Nova Zelândia, Noruega, Peru, Polônia, Portugal, Romênia, Rússia, Sérvia, Singapura, Eslovênia, Espanha, Suécia, Suíça, Turquia, Ucrânia, Estados Unidos e Vietnã.
Se o seu país não consta na lista, você pode entrar em contato diretamente conosco ou com o seu Ponto de Contato da Schneider (POC) para verificar se o seu país tem acesso a este API.
O acesso API exigirá autenticação oAuth, por favor consulte os detalhes no portal.
- Esta API suporta paginação, favor consultar os detalhes abaixo para entender como funciona a paginação:
- Quando API é solicitado com parâmetros para retornar uma lista muito longa de itens, a resposta é paginada a fim de evitar carga pesada e congestionamento n/w.
- Um parâmetro de solicitação pode ser definido para indicar quantos itens devem ser devolvidos em uma única resposta API. (tamanho da página<=100)
Nota: O tamanho padrão da página é 10 - Cada resposta API também retorna parâmetros como totalNumberOfRecords, totalNumberOfPages e pageNumber.
- totalNumberOfRecords : Quantos registros podem ser devolvidos em resposta, de acordo com os params aprovados no pedido
- totalNumberOfPages : Quantas páginas são esperadas com base no tamanho atual da página e no número total de registros. Por exemplo, 100 registros com tamanho de página 10 exigirão 10 páginas.
- pageNumber : para qual resposta de número de página é necessária.
O acesso API exigirá autenticação oAuth, por favor consulte os detalhes no portal.
Parâmetros suportados no API:
Parâmetros | Tipo de dados | Descrição | Exemplo |
country | corda | Código do país para o qual os detalhes do pedido são necessários. | US |
order-number | corda | Número do pedido no ERP, este pode ser o valor total do pedido ou o valor "a partir de". | AB12345 |
order-status | corda | Status atual do pedido no ERP | Entregue em |
page | corda | Número de página atual por númeroOfRecords e tamanho de página | 1 |
page-size | corda | Número de registros esperados em resposta | 10 |
item-number | corda | Número de item de um determinado item no pedido | 79895 |
purchaser-id | corda | Um ID de 10 ou 5 dígitos do comprador utilizado em mySE. | 1000006792 |
Esta API suporta 3 operações como se segue:
| ResourcePath | Parames Obrigatórios | Parames opcionais | Resposta Esperada |
| /orders/{country} | country | Order-number, order-status, page, page-size, purchaser-id | Todos os pedidos vinculados à conta no país solicitado |
| /orders/{country}/{order-number}/{item-number}/shipment-schedules | Country, order-number, item-number | purchaser-id | O cronograma de envio do item de linha solicitado será devolvido |
| /orders/{country}/{order-number} | Country, order-number | Item-number, purchaser-id | Informações gerais juntamente com o cronograma de embarque dos itens/itens em ordem são devolvidos. |
