Order

POST /{applicationId}/orders/{id}/cancel

This endpoint allows an order to be cancelled on the Grubtech platform.

Request

  • Base URL
    https://virtserver.swaggerhub.com/GrubTech/grubtech-grocery-integration-apis/1.0.0
  • URL
    https://virtserver.swaggerhub.com/GrubTech/grubtech-grocery-integration-apis/1.0.0/{applicationId}/orders/{id}/cancel
  • Auth
    OAuth 2
    Authorization code: https://id.staging.grubtech.io/oauth2/authorize
    Token URL: https://id.staging.grubtech.io/oauth2/token

Path parameters

applicationIdstring required

Application ID provided by GrubTech to identify the integration

idstring required

Order id provided by aggregator platform.

Request body

reason'OUT_OF_ITEMS' | 'STORE_TOO_BUSY' | 'OTHER' required

Order cancellation reasons

notestring

Reason or note for cancellation

canceledAtstring required

Order cancellation time. Represented in ISO 8601 format.

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.