GRgrubtech
Order amendments

GET /orders/{orderId}/substitute/{OrderItemLineId}

Grubtech will retrieve eligible substitutions for an item if the aggregator platform supports this feature.

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}/substitute/{OrderItemLineId}
  • Auth
    API key in header X-API-KEY

Path parameters

orderIdstring required

order id

OrderItemLineIdstring required

Unique Identifier for the line for the ordered item.

Query parameters

needleinteger required

Keyword describing the desired item to be used as a substitute.

limitinteger required

Number of substitutions to return

quantityinteger required

Quantity to substitute

Response

Successful response

lineIdstring

Unique identifier for each substitution suggestion

idstring required

Item identifier of the substitution item.

skustring

Stock keeping unit ID for the menu item, provided by GrubTech.

quantityinteger required

Quantity of items that can be used for substitution.

unitPriceinteger required

Specifies the unit price to charge for ordering the item. Price should always be an integer value (never decimals) because the price is set in the lowest denomination (e.g., cents for US currency, not dollars). Price should always be set even if the price is 0.

Example response

[
  {
    "name": {
      "translations": {
        "en-us": "grubtech"
      }
    },
    "unitPrice": 1200
  }
]

Changes

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