Pedido Entregue

Nesta seção explicamos sobre os recursos relacionados a integração do status de entregue dos pedidos

Este endpoint será utilizado pelo Seller para informar que o pedido foi entregue.

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 "Entregue".

Endpoint

Order Delivered Notification

POST https://{environmentMarketplace}/api/oms/pub/orders/{marketplaceOrderId}/delivered

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": "2014-02-07T15:22:56.7612218-02:00" ,
    "orderId": "123543123" ,
    "receipt": "38e0e47da2934847b489216d208cfd91"
}

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

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

  • items *** (array de objetos) : itens que estão sendo entregues do pedido em questão.

    • id * (string) : ID do SKU do item entregue.

    • quantity * (integer) : quantidade deste item entregue.

  • deliveredDate * (string) : data de entrega do pedido.

• Response

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

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

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

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

Exemplo do Request

{
    "items": [
        {
            "id": "SGEFDT860BCNZ",
            "quantity": 1
        }
    ],
    "deliveredDate": "2023-05-17T12:15:46-03:00"
}

Exemplo do Response (200 - OK)

{
    "date": "2023-05-24T23:46:17.5942537+00:00",
    "orderId": "HQ0000304",
    "receipt": "61d04979-3e14-4353-be98-a094e7a5f005"
}