createCoupon

mutation · in the family Coupon

What it does

Create a new coupon — a code a customer presents for a reduction at your organization.

Create a Coupon in the caller's org group; requires the unrestricted capability.

Who may call it

Capability area: Pricing — Prices, price schedules, promotions, coupons and the money rules of selling.

• Owner
• Manager
• An API key whose scope allows api:createCoupon

Arguments

Returns

Coupon Coupon! — A Coupon — the CODE-GATED entry to the discount engines: a normalized code (trim+UPPERCASE, stored normalized-only, IMMUTABLE at birth — re-code = a new coupon) that either UNLOCKS a couponGated Promotion (trigger flavor — the reduction is source=promo at position 3) or CARRIES its own simple effect (discount flavor — source=coupon at position 2, BEFORE promotions). Attach to an OPEN order via applyOrderCoupon (HARD 1 coupon/order — the strict default); redemption counts per ORDER in the place transaction — a capped-out coupon refuses CONFLICT/COUPON_EXHAUSTED. NAMED deferrals: CouponBatch (unique single-use child codes) · per-customer caps.

Example request

mutation ExampleCreateCoupon($input: NewCouponInput!) {
  createCoupon(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    flavor
    code
    promotionId
    startAt
    endAt
    totalUsesCap
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "code": "BJ-001",
    "flavor": "trigger"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createCoupon": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CP-EXMP-0000-000F",
      "type": "Coupon",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "flavor": "trigger",
      "code": "BJ-001",
      "promotionId": "01900000-0000-7000-8000-59bbd0c70000",
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z",
      "totalUsesCap": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Issue coupon codes — one code or a batch