Etiquetas Americanas Entrega
Etiquetas Outros Marketplaces
Mercado Livre
Perguntas e Respostas Americanas
SAC
Serviço O2O
Consulta de Pedidos
A API Skyhub oferece a funcionalidade para que pedidos e produtos sejam filtrados de acordo com o status que ela se encontra.
Filtro de Pedidos por Status
Por exemplo, ao efetuar o GET através da endpoint:
https://api.skyhub.com.br/orders/, o resultado são todos os pedidos, não importando se eles estão aprovados, enviados, cancelado, entregues, etc.
Ao utilizar o filtro, podemos buscar o status desejados.
Para filtrar os pedidos por status é necessário saber quais status sua loja possui na Skyhub.
Para consultar os status já existentes via API, realize a operação através do Endpoint:
1
https://api.skyhub.com.br/statuses
Copied!
OBS: Os status utilizados para fazer o filtro é o campo: code
Como Filtrar Pedidos por Status?
Para filtrar devemos utilizar o método GET e as seguintes Headers:
1
X-User-Email: SEU_EMAIL_CADASTRO_NA_SKYHUB
2
X-Api-Key: SUA_API_KEY
3
X-Accountmanger: SEU_X_ACCOUNTMANAGER-KEY
4
Accept: application/json
5
Content-Type: application/json
Copied!
Utilizando os status padrão da Skyhub, as endpoints seriam:
- A url filtrará pelos pedidos Aprovados:
1
https://api.skyhub.com.br/orders?filters[statuses][]=payment_received
Copied!
- A url filtrará pelos pedidos com Nota Fiscal Emitida
1
https://api.skyhub.com.br/orders?filters[statuses][]=order_invoiced
Copied!
- A url filtrará pelos pedidos com Pagamento Pendente
1
https://api.skyhub.com.br/orders?filters[statuses][]=book_product
Copied!
- A url filtrará pelos pedidos Cancelados
1
https://api.skyhub.com.br/orders?filters[statuses][]=order_canceled
Copied!
- A url filtrará pelos pedidos Entregues ao Cliente
1
https://api.skyhub.com.br/orders?filters[statuses][]=complete
Copied!
- A url filtrará pelos Pedidos Enviado
1
https://api.skyhub.com.br/orders?filters[statuses][]=order_shipped
Copied!
Segue exemplo abaixo:
No caso da sua loja possuir muitos pedidos por status, é possível filtrar por paginação utilizando o “page” e “per_page”.
- Page: indica o número da página de registros que será retornada. Caso não seja especificado, a primeira página será retornada (valor padrão 1).
- Per_page: indica a quantidade de registros a serem retornados. Em ambos recursos (produtos e pedidos), per_page possui 100 como valor padrão e valor limite (valor máximo).
Por exemplo:
1
https://api.skyhub.com.br/orders?filters[statuses][]=payment_received&page=1&per_page=1
Copied!
Com a Endpoint acima foi pesquisado pedidos com status aprovado na primeira página e apenas 1 pedido, conforme print:
Mas atenção, a forma de filtros por status NÃO deve ser usada em hipótese alguma para o consumo de pedidos. Para tal, sempre utilize a fila de pedidos.
Como filtrar pedidos por data:
Para filtrar pedidos por data, será necessário utilizar o: filters[start_date]=DD/MM/AAAA
Por exemplo:
1
https://api.skyhub.com.br/orders?filters[start_date]=15/08/2018
Copied!
No exemplo acima é possível verificar que utilizamos o filters[start_date]=15/08/2018, neste caso o retorno será dos pedidos criados do dia 15/08/2018 em diante.
Para filtrar os pedidos apenas do dia 15/08/2018, será necessário utilizando também o filters[end_date]=DD/MM/AAAA.
Por exemplo:
1
https://api.skyhub.com.br/orders?filters[start_date]=15/08/2018&filters[end_date]=15/08/2018
Copied!
Se observarmos os retornos dos 2 prints acima, podemos verificar que o numero de pedidos que retornam são divergentes, pois o 1 exemplo retorna pedidos a partir do dia 15 e no 2 exemplo apenas pedidos do dia 15.
Para se certificar a respeito da data, será necessário verificar a informação apresentada no campo "placed_at".
O filtro por data será sempre pela data de criação do pedido e nunca pela data de atualização
Limite para consulta
Temos um limitador de retorno (GET) de no máximo 10000 registros para consulta de pedidos, caso tenha mais registros para serem retornados o ideal é realizar filtros para adequar a quantidade de retorno de acordo com o limite existente.