Skip to main content
PATCH
Update a gift card order

Authorizations

x-api-key
string
header
required

Your API key, starting with ct_key_.

x-api-secret
string
header
required

Your API secret, starting with ct_secret_.

Path Parameters

id
string<uuid>
required

Order ID.

Body

application/json

Send only the fields to change. null clears a nullable field.

orderDate
string<date>

YYYY-MM-DD.

Example:

"2026-10-01"

orderTime
string | null

HH:mm or HH:mm:ss, in your local time.

Example:

"14:30"

retailer
string

Store name, such as Best Buy.

Example:

"Best Buy"

orderNumber
string

Must be unique across your orders. Surrounding spaces are trimmed.

Maximum string length: 100
Example:

"BBY01-123456"

shipping
integer
default:0

Shipping in cents.

Required range: x >= 0
tax
integer
default:0

Tax in cents.

Required range: x >= 0
Example:

4800

discount
integer
default:0

Discount in cents.

Required range: x >= 0
creditCardId
string | null

ID of one of your credit cards, from List credit cards.

subCreditCardId
string | null

ID of one of that card's subCards.

cardEarnRate
number
default:0

Points or cashback multiplier, e.g. 2 for 2x or 1.5 for 1.5x. Up to three decimal places; more are rounded.

Required range: x >= 0
retailerAccount
string | null

The retailer account the order was placed with, such as its email.

Maximum string length: 100
notes
string | null
Maximum string length: 1000
redemptionCodes
object[]

Gift card codes, vouchers, or credits for the order. Write-only: responses don't include them. Your plan's per-order limit applies.

Maximum array length: 50
platform
string

Resale platform: aligned_incentives, card_center, card_cash, qgcg, or one of your custom platforms.

Maximum string length: 100
Example:

"card_cash"

status
enum<string>
Available options:
purchased,
submitted,
partially_paid,
issue,
paid,
cancelled
Example:

"purchased"

orderLineItems
object[]

Replaces the whole list and recalculates the subtotal. An item with an id updates that line item, keeping fields you omit. An item without an id is new and needs every required field. Line items left out are removed.

Required array length: 1 - 10 elements

Response

The updated order.

data
object