Para contas de desenvolvimento/homologação é possível criar e aprovar pedidos. Esta seção traz orientações para a criação e aprovação de pedidos
As operações descritas abaixo não estão disponíveis para contas em produção.
Caso ainda não possua um ambiente de teste para a homologação de seu sistema, consulte a guia Processo de Homologação.
POST - Criando um pedido
Como descrito em Integração Pedido, durante o processo de homologação de um sistema são solicitados os passos de criação, consumo e notificação de pedidos.
Criando um pedido teste (status NEW)
Para realizar a criação de um pedido via API deverá ser utilizado o método POST para o seguinte endpoint:
No objeto items é necessário informar o SKU adquirido na compra. Isto é, caso deseje simular um pedido realizado para um produto que contém variações, a criação requer que seja informado o SKU da variação e não do produto pai/agrupador.
É possível determinar numerações específicas para os pedidos criados. Para tal, basta incluir o campo "remote_code" no arrayORDER.
Durante a criação de pedido é possível enviar o método de cálculo do frete, feito através do campo "shipping_calculation_type". O retorno dessa informação no consumo do endpoint /queues/orders será no campo "calculation_type".
Response esperado:
201 [Success] - Created
POST - Aprovando um pedido teste (status APPROVED)
O ciclo de vida de um pedido comum é iniciado com a sua criação (status NEW) e o próximo passo é a sua aprovação (status APPROVED). No ambiente de produção estes dois status (NEW e APPROVED) são gerados no marketplace, porém em homologação/ambiente de teste, além da criação, é possível realizar também a aprovação do pedido.
A aprovação em ambiente de teste requer os headers apresentados acima e se dá através de um POST no endpoint:
https://api.skyhub.com.br/orders/{code}/approval
O code deve ser substituído pelo código do pedido, visualizado após o consumo.
Request body:
{
"status": "payment_received"
}
Example request:
curl --location --request POST 'https://api.skyhub.com.br/orders/Lojas Americanas-1000000000000/approval' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'x-accountmanager-key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"status": "payment_received"
}'
Response esperado:
204 [Success] - No content
POST - Criando pedido para o Fulfillment
Existem recursos disponíveis para homologação que requerem a criação de pedidos contendo campos específicos, como é o caso da homologação para o serviço Fulfillment.
Pedido Fulfillment
Criando um pedido teste para o serviço Fulfillment
Para homologação do recurso Fulfillment é imprescindível a identificação de pedidos que se enquadrem neste serviço.
No ambiente de teste é possível simular um pedido Fulfillment e para isto será necessário seguir o padrão disponibilizado na seção Criação de Pedido com atenção para o campo shipping_method:
