---
title: "Create"
method: POST
path: "/one_time_incentives/create/"
---

# Create

`POST /one_time_incentives/create/`

Creates a one-time discount and attaches it to a specific item, order, or shipping rate for an individual customer.

## Request body

- object
  - `merchant` string, required — Merchant ID
  - `customer` string, required — Customer ID
  - `description` string — Description
  - `expires` string, date — Date by which Order Must Place to Apply discount
  - `item` string — Send Item ID to apply a One Time Incentive to a specific item. This field and `order` are mutually exclusive, but one is required.
  - `order` string — Send Order ID to apply a One Time Incentive to a specific order. This field and `item` are mutually exclusive, but one is required.
  - `stacking_type` string — Choose 'base' or 'additional' for a standard discount or an additive one (defaults to 'base')
  - `external_code` string — External Code
  - `incentive` object — Incentive Object
    - `name` string, required — Anything to help identify this incentive
    - `discount_type` string, required — Choose 'Discount Percent' for a percent off discount or 'Discount Amount' for a flat dollar off discount.
    - `value` string, required — The value of the discount eg 5 for $5 off or 10 for 10% off
    - `field` string, required — If using `target: "item"`, field should be 'total_price'. If using `target: "order"`, field should be 'sub_total' or 'shipping_total'.
    - `type` string, required — Must send 'Discount'
    - `target` string, required — If an Order ID (`order: <Order ID>`) was provided the `target` can be 'item' or 'order'. If an Item ID ((`item: <Item ID>`) was provided `target` must be 'item'.
    - `limit_policy` string — Specifies the type of limit policy. Currently only `fixed` is supported. This policy indicates that the `limit_value` should be interpreted as a hard-coded dollar amount limit per incentive target. `limit_policy` and `limit_value` must be supplied together, or both left out.
    - `limit_value` number — Used to configure the discount limit. The exact behaviour depends on the defined `limit_policy`. `limit_policy` and `limit_value` must be supplied together, or both left out.

## Response `201`

201

- union
  - object
    - `public_id` string
    - `external_code` string
    - `description` string
    - `merchant` string
    - `customer` string
    - `item` string
    - `created` string
    - `last_updated` string
    - `order` unknown
    - `incentive` object
      - `type` string
      - `public_id` string
      - `discount_type` string
      - `target` string
      - `field` string
      - `name` string
      - `value` string
      - `threshold_field` unknown
      - `threshold_value` unknown
  - object
    - `public_id` string
    - `external_code` string
    - `description` string
    - `customer` string
    - `merchant` string
    - `order` string
    - `incentive` object
      - `name` string
      - `public_id` string
      - `type` string
      - `field` string
      - `discount_type` string
      - `value` string
      - `threshold_field` unknown
      - `threshold_value` unknown
      - `target` string
    - `created` string
    - `last_updated` string
    - `expires` string
    - `stacking_type` string
    - `item` unknown
  - object
    - `public_id` string
    - `external_code` string
    - `description` string
    - `customer` string
    - `merchant` string
    - `order` string
    - `incentive` object
      - `name` string
      - `public_id` string
      - `type` string
      - `field` string
      - `discount_type` string
      - `value` string
      - `threshold_field` unknown
      - `threshold_value` unknown
      - `target` string
    - `created` string
    - `last_updated` string
    - `expires` string
    - `stacking_type` string
    - `item` unknown
  - object
    - `public_id` string
    - `external_code` string
    - `description` string
    - `customer` string
    - `merchant` string
    - `order` string
    - `incentive` object
      - `name` string
      - `public_id` string
      - `type` string
      - `field` string
      - `discount_type` string
      - `value` string
      - `threshold_field` string
      - `threshold_value` string
      - `target` string
    - `created` string
    - `last_updated` string
    - `expires` string
    - `stacking_type` string
    - `item` unknown
  - object
    - `public_id` string
    - `external_code` string
    - `description` string
    - `customer` string
    - `merchant` string
    - `order` string
    - `incentive` object
      - `name` string
      - `public_id` string
      - `type` string
      - `field` string
      - `discount_type` string
      - `value` string
      - `threshold_field` unknown
      - `threshold_value` unknown
      - `target` string
    - `created` string
    - `last_updated` string
    - `expires` string
    - `stacking_type` string
    - `item` unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ordergroove/apis/ordergroove-restrpc.md) · [All operations](https://skmtc.net/ordergroove/apis/ordergroove-restrpc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ordergroove/ordergroove-restrpc/revisions/ba97e740d08c/schema)