Pedido Cancelado pelo Seller

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

Caso o Seller tenha problemas com o pedido e não possa, por algum, realizar a entrega, irá informar o cancelamento ao Marketplace. Tal ação só poderá ser realizada caso o pedido se encontre em um status que permita o cancelamento.

Pode ocorrer tambem de ser notificado o cancelamento quando o pedido for pago utilizando o Gateware de Pagamento da Fast Shop e o mesmo não ser efetivado.

O Marketplace irá receber na solicitação o ID do Pedido enviado no request no campo "marketplaceOrderId” para acionar o processo decorrente do pedido correspondente.

No corpo da resposta contém a informação: 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".

Endpoint

Seller Cancel Order

POST https://{environmentMarketplace}/api/oms/pvt/orders/{marketplaceOrderId}/cancel

Path Parameters

Name	Type	Description
{environmentMarketplace}*	string	URL da API do Marketplace
{marketplaceOrderId}*	string	ID do pedido do Marketplace

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 recebida com sucesso

{
    "date": "2021-08-18T21:52:48.5554949+00:00",
    "marketPlaceOrderId": "959311095",
    "orderId": "123543123",
    "receipt": "e39d05f9-0c54-4469-a626-8bb5cff169f8"
}

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

{
  "errorCode": "string",
  "message": "string"
}

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

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

500: Internal Server Error Se ocorrer um erro no servidor

Será enviado no Header as chaves de autenticação que poderão ser utilizadas pelo Marketplace para validação caso seja conveniente

Descrição dos campos:

• Request

  • Não existirá para este endpoint

• Response

  • date * (string) : data e horário de recebimento da notificação

  • orderId * (string) : identificador do pedido no Seller.

  • receipt (string) : protocolo gerado pela atualização, pode ser null.

* Campos obrigatórios *** Lista que irá conter pelo menos 1 objeto.

Exemplo do Response (200 - OK)

{
    "date": "2023-05-24T23:51:40.3444829+00:00",
    "orderId": "HQ0000304",
    "receipt": "828855a1-638a-4182-9ccd-211151a85622"
}