---
title: "POST /orders/{orderId}/amendments"
method: POST
path: "/orders/{orderId}/amendments"
tags: ["Order amendments"]
---

# POST /orders/{orderId}/amendments

`POST /orders/{orderId}/amendments`

## 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/orders/{orderId}/amendments`
- Auth: API key in header `X-API-KEY`

This endpoint will notify all the eligible amendments from Grubtech to the aggregator platform if the platform supports getting confirmation from the customer for the suggested amendments.

## Path parameters

- `orderId` string, required

## Request body

- Amendments
  - `amendmentId` string: Unique identifier to identify the amendment request
  - `timeToConfirm` string: Suggested amendments should be confirmed before the defined time. Otherwise, the order will be cancelled from the Grubtech platform and represented in ISO 8601 format.
  - `itemAmendments` ItemAmendment[]
    - `itemId` string: Unique identifier for the original Item, provided by Grubtech
    - `lineId` string: Unique identifying ID for the order line item within the order provided by the store.
    - `quantity` integer: Quantity of the item in the initial Order
    - `alternatives` Alternative[]
      - `itemId` string: Unique identifier for the suggested item for amendment, provided by Grubtech
      - `quantity` integer: The quantity can be amended with the suggested item.
      - `adjustmentType` 'ITEM_REMOVAL' | 'ITEM_SUBSTITUTION' | 'QTY_ADJUSTMENT'

## Response `204`

Successful response

## Other responses

- `400`: Bad request
- `500`: Internal server error

---

[API](https://skmtc.dev/grubtech/apis/grubtech-grocery-apis.md) - [All operations](https://skmtc.dev/grubtech/apis/grubtech-grocery-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/grubtech/apis/grubtech-grocery-apis/revisions/38664609b45c?raw)