Definição da URL e Siglas

Neste tópico detalha as URLs que envolvem a integração do Seller e Marketplace

Como descrito no "Fluxo de Integração" temos transações de ambos os lados, algumas partindo do Marketplace e outras do Seller. Teremos então algumas nomenclaturas que será utilizado para detalhar esta transação, são elas:

Sigla	Definição
{fulfillmentEndpoint}	URL da API do Seller informada no tópico "Ambientes de integração".
{environmentSeller}	URL padrão da API do Seller, descrito logo abaixo. Esta URL será fornecida pela FastShop.
{environmentMarketplace}	URL da API do Marketplace que irá receber as notificações de criação/alteração de produto, alterações de estoque e preço, e atualizações de status de pedido. A URL deverá ser utilizada o protocolo HTTPS.
{version}	Versão da API do HUB
{marketplaceId}	Identificação do Marketplace no HUB. Mais informações consulte o tópico "Primeiros passos"
{sellerId}	ID da conta do Seller fornecido pela Fast Shop, irá definir para onde será direcionado as consultas de preço, estoque, o envio dos pedidos, confirmação de pagamento ou cancelamento. Quando parceiro VTEX será o ID do Seller na conta VTEX. Quando parceiro não-VTEX será fixado o valor "FSH"
{sellerSkuId}	ID do SKU no Seller
{marketplaceOrderId}	ID do Pedido do Marketplace
{orderId}	ID do Pedido do Seller

URL padrão de comunicação entre as APIs

URL do Marketplace: https://{environmentMarketplace}/

URL do Seller (environmentSeller): https://{fulfillmentEndpoint}/api/{version}/{marketplaceId}/

Exemplos:

• APIs Marketplace: https://meumarketplace1.integracao.com.br/api/

• APIs Seller: https://mkp-hub.kaive.com.br/api/v1/meumarketplace1/

Endpoints

Seller -> Marketplace

Endpoints de responsabilidade do Marketplace, serão utilizados pelo Seller para envio das notificações de alteração de produto, estoque e preço, sugestão para cadastro, atualizações de status do pedido (tracking) e cancelamento de pedido

Etapa	API Request	Request Target
Notificação de Catálogo	https://{environmentMarketplace}/api/catalog_system/pvt/skuseller/changenotification/{sellerId}/{sellerSkuId}	-> Marketplace
Registro de Catálogo	https://{environmentMarketplace}/suggestions/{sellerId}/{sellerSkuId}	-> Marketplace
Atualização de Catálogo	https://{environmentMarketplace}/suggestions/{sellerId}/{sellerSkuId}/update	-> Marketplace
Pedido Confirmado pelo Seller	https://{environmentMarketplace}/api/oms/pvt/orders/{marketplaceOrderId}/confirm	-> Marketplace
Pedido Faturado ou Despachado	https://{environmentMarketplace}/api/oms/pub/orders/{marketplaceOrderId}/invoice	-> Marketplace
Pedido Entregue	https://{environmentMarketplace}/api/oms/pub/orders/{marketplaceOrderId}/delivered	-> Marketplace
Pedido Cancelado pelo Seller	https://{environmentMarketplace}/api/oms/pvt/orders/{marketplaceOrderId}/cancel	-> Marketplace

Marketplace -> Seller

Endpoints de responsabilidade do Seller, serão utilizados pelo Marketplace para consulta de estoque e preço e envio do pedido para criação, aprovação e cancelamento do pedido.

Etapa	API Request	Request Target
Atualização de preço / estoque	https://{environmentSeller}/pvt/orderForms/simulation	<- Seller
Cálculo de Frete	https://{environmentSeller}/pvt/orderForms/simulation	<- Seller
Bandeiras de Cartão	https://{environmentSeller}/pvt/payments/listcreditcards	<- Seller
Parcelamento no cartão	https://{environmentSeller}/pvt/payments/installments	<- Seller
Processar transação de pagamento	https://{environmentSeller}/pvt/payments	<- Seller
Criação de pedido	https://{environmentSeller}/pvt/orders	<- Seller
Pedido Aprovado/Confirmado pelo Marketplace	https://{environmentSeller}/pvt/orders/{orderId}/fulfill	<- Seller
Pedido Cancelado pelo Marketplace	https://{environmentSeller}/pvt/orders/{orderId}/cancel	<- Seller
Consulta Pedido no Seller	https://{environmentSeller}/pvt/orders/{orderId}	<- Seller

O detalhe de cada endpoint encontrará no próximo tópico "Recursos".