Ordergroove Developer Documentation

curl -X POST https://restapi.ordergroove.com/one_time_incentives/create/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "customer": "00026001",
  "description": "One-Time Order Total Discount",
  "expires": "2024-05-21 00:00:00",
  "order": "a4f656f6ed4511eebfaf6a353c182723",
  "stacking_type": "base",
  "external_code": "one_time_order_total_discount",
  "incentive": {
    "type": "Discount",
    "name": "One-Time Order Total Discount",
    "discount_type": "Discount Amount",
    "value": "25.00",
    "field": "sub_total",
    "target": "order"
  }
}'

{
  "public_id": "52df97b4f0fa11eeafd33e19316267db",
  "external_code": "one_time_order_total_discount",
  "description": "One-Time Order Total Discount",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "customer": "00026001",
  "created": "2024-04-02 09:07:21",
  "last_updated": "2024-04-02 09:07:21",
  "order": "a4f656f6ed4511eebfaf6a353c182723",
  "incentive": {
    "type": "Discount",
    "public_id": "a8cf39af36e14bdabb1a397360883096",
    "discount_type": "Discount Amount",
    "target": "order",
    "field": "sub_total",
    "name": "One Time Order Total Discount",
    "value": "25.00"
  },
  "expires": "2024-05-21 00:00:00",
  "stacking_type": "base"
}

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

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.

Request

This endpoint expects an object.

merchantstringRequired

Merchant ID

customerstringRequired

Customer ID

descriptionstringOptional

Description

expiresdateOptional

Date by which Order Must Place to Apply discount

itemstringOptional

Send Item ID to apply a One Time Incentive to a specific item. This field and order are mutually exclusive, but one is required.

orderstringOptional

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_typestringOptionalDefaults to base

Choose ‘base’ or ‘additional’ for a standard discount or an additive one (defaults to ‘base’)

external_codestringOptional

External Code

incentiveobjectOptional

Incentive Object. type selects the shape: send Discount for a discount incentive or Gift to add a free product. The remaining fields differ between the two.

Response

201

One Time Item Discountobject

One Time Order Total Discountobject

One Time Order Shipping Discountobject

One Time Order Total Discount (With Threshold)object

One Time All Order Items Discountobject

Errors

400

Bad Request Error