Status
Nesta seção explicamos sobre o recurso relacionado aos status de pedidos cadastrados previamente na SkyHub.

/statuses

Na SkyHub o pedido possui diversos status em seu ciclo de vida, como por exemplo "pedido faturado", "expedido", "entregue", entre outros. Esses status já são criados por padrão na SkyHub e podem ser utilizados para fazer as requisições para atualização dos pedidos na comunicação entre a sua plataforma e a SkyHub.
Contudo, eventualmente o parceiro pode necessitar de um nome diferente de status, por exemplo, ao invés de order_invoiced, utilizar somente invoiced; esse novo status deverá ser criado pelo endpoint /statuses, caso contrário retornará erro na request.

Como consultar o que já existe na conta?

Se a conta SkyHub já existe há algum tempo, pode ser que alguma outra plataforma tenha criado status de pedidos diferenciados para ela, então pode ser necessário que você consulte o que já existe na conta para seguir nos mesmos moldes ou até mesmo para não criar algum status duplicado. Para isso utilizará o método GET seguindo o processo abaixo:
1
https://api.skyhub.com.br/statuses
Copied!
Request Body:
1
curl -X GET \
2
https://api.skyhub.com.br/statuses \
3
-H 'accept: application/json' \
4
-H 'content-type: application/json' \
5
-H 'x-api-key: SuaApiKey' \
6
-H 'x-accountmanager-key: SUAXACCOUNT' \
7
-H 'x-user-email: [email protected]' \
Copied!

Como criar um novo Status na conta?

Se houver a necessidade é possível criar um novo status usando o método POST seguindo o processo abaixo:
1
https://api.skyhub.com.br/statuses
Copied!
Request Body:
1
curl -X POST \
2
https://api.skyhub.com.br/statuses \
3
-H 'accept: application/json' \
4
-H 'content-type: application/json' \
5
-H 'x-api-key: SuaApiKey' \
6
-H 'x-accountmanager-key: SUAXACCOUNT' \
7
-H 'x-user-email: [email protected]' \
8
-d '{
9
"status": {
10
"code": "codigo_do_status",
11
"label": "label_do_status",
12
"type": "NEW"
13
}
14
}
Copied!
O campo "code" se refere ao nome do status que será usado nas requisições e o mesmo não poderá ser alterado após a criação do novo status.
Swagger UI
Documentação: Status - SkyHub