Cancellations

Utilizamos a especificação Open Delivery para o tratamento de pedidos. https://abrasel-nacional.github.io/docs/#tag/ordersCancellation

Solicita o cancelamento de um pedido

POST https://{account}.myhubdelivery.io/orders/api/v1/{orderId}/requestCancellation

Path Parameters

Name	Type	Description
orderId*	String	Identificador do pedido

Headers

Name	Type	Description
Authorization*	String	Bearer ...

Request Body

Name	Type	Description
reason*	String	Razão do cancelamento
code*	String	"SYSTEMIC_ISSUES" "DUPLICATE_APPLICATION" "UNAVAILABLE_ITEM" "RESTAURANT_WITHOUT_DELIVERY_MAN" "OUTDATED_MENU" "ORDER_OUTSIDE_THE_DELIVERY_AREA" "BLOCKED_CUSTOMER" "OUTSIDE_DELIVERY_HOURS" "INTERNAL_DIFFICULTIES_OF THE RESTAURANT" "RISK_AREA"
mode	String	"AUTO" "MANUAL"
outOfStockItems	Array<String>
invalidItems	Array<String>

201: Created

{
    // Response
}

400: Bad Request

{
    // Response
}

401: Unauthorized

{
    // Response
}

Exemplo do conteúdo da requisição

{
  "reason": "",
  "code": "",
  "mode": "AUTO|MANUAL",
  "outOfStockItems": [
    ""
  ],
  "invalidItems": [
    ""
  ]
}

Aceita a solicitação de cancelamento enviada pelo canal de vendas

POST https://{account}.myhubdelivery.io/orders/api/v1/{orderId}/acceptCancellation

Rejeita a solicitação de cancelamento enviada pelo canal de vendas

POST https://{account}.myhubdelivery.io/orders/api/v1/{orderId}/denyCancellation

Exemplo do conteúdo da requisição

{
  "reason": "",
  "code": ""
}

Força o cancelamento do pedido pelo canal

PATCH https://{account}.myhubdelivery.io/orders/api/v1/{orderId}/cancellation/force

Esta operação só é permitida em sandbox, não existindo em produção

Path Parameters

Name	Type	Description
orderId*	UUID	Identificação do pedido

200: OK