Pedido Cancelado pelo Marketplace

Nesta seção explicamos sobre os recursos relacionados a integração do status de cancelamento de pedidos originado pelo Marketplace.

Quando o Marketplace, por algum motivo, necessite cancelar um pedido, poderá chamar este endpoint.

No corpo da solicitação contém apenas uma informação: o “marketplaceOrderId”, que identifica o pedido no Marketplace. O Seller irá usar esse ID para acionar o processo decorrente do pedido correspondente.

O Seller irá responder com o mesmo “marketplaceOrderId” e também com o “orderId”, que identifica o pedido no Seller, data e hora do recebimento da notificação e um código de protocolo que confirma seu recebimento.

O pedido irá constar com o status "Cancelado".

Caso seja solicitado o cancelamento de um pedido após a aprovação, será apenas notificado o Seller para que "barre" o faturamento, despacho ou entrega do produto. Poderá ocorrer de não ser possível o cancelamento efetivo, então é conveniente que este tipo de cancelamento seja feito pelo próprio Seller para que tome a ação imediata.

Endpoint

Marketplace Order Cancellation

POST https://{environmentSeller}/pvt/orders/{orderId}/cancel

Path Parameters

Name	Type	Description
{environmentSeller}*	string	URL da API do Seller
{orderId}*	string	ID do pedido do Seller

Headers

Name	Type	Description
X-VTEX-API-AppKey*	string	{{appKey}}
X-VTEX-API-AppToken*	string	{{appToken}}
Accept*	string	application/json
Content-Type*	string	application/json

200: OK Se a notificação for realizada com sucesso

Consulte o Swagger API

400: Bad Request Se a requisição não atender os requisitos mínimos

401: Unauthorized Se a requisição não for autenticada

429: Too Many Requests Muitos requests simultâneos

500: Internal Server Error Se ocorrer um erro no servidor

403: Forbidden As credenciais não estão ativas para acessar o serviço

Exemplo do Request

{
    "marketplaceOrderId": "000004941"
}

Exemplo do Response (200 - OK)

{
    "date": "2023-05-17T11:44:59.79",
    "marketPlaceOrderId": "000004941",
    "orderId": "HB0033172",
    "receipt": "6e7cf8e1-9a70-404d-9452-6a97c2718db8"
}

Descrições dos campos consulte o "Swagger API"

Caso o pedido tenha sido cancelado anteriormente, não será aceita a notificação

A API permite até 5 requisições por segundo, caso ultrapasse esse limite será retornado status 429: Too Many Request

Caso ocorra um erro ao enviar o dado é importante que persista em um segundo momento para garantir a entrega. Caso persista o erro entre em contato conosco