Ordergroove Developer Documentation

{
  "public_id": "8637c3fe9b7011eaa2c1bc764e107990",
  "external_code": "awesome_discount",
  "description": "One-time Incentive",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "customer": "00026001",
  "order": "c4e05d04ccc411e8ada3bc764e101db1",
  "created": "2020-05-21 09:36:57",
  "last_updated": "2020-05-21 09:36:57",
  "incentive": {
    "type": "Discount",
    "public_id": "c34a8c03eae641d0ab7015bedec6fbd0",
    "discount_type": "Discount Percent",
    "target": "item",
    "field": "total_price",
    "name": "awesome discount",
    "value": "10.00"
  }
}

Updates an existing one-time incentive.

This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Path parameters

one_time_incentive_idstringRequired

Request

This endpoint expects an object.

external_codestringOptional

External Code

descriptionstringOptional

Description

orderstringOptional

Order ID

itemstringOptional

Item ID

incentiveobjectOptional

Incentive Object

Response

200

public_idstringOptional

external_codestringOptional

descriptionstringOptional

merchantstringOptional

customerstringOptional

orderstringOptional

createdstringOptional

last_updatedstringOptional

incentiveobjectOptional

Errors

400

Bad Request Error