Gift Card Order Object


A Gift Card Order is a reflection of an order in a Sales Channel that includes a Gift Card.

Properties
idstringRead-onlyformat GUID

Order ID.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the Order is updated. To prevent conflicting changes, the current revision must be passed when updating the Order.

Ignored when creating a Order.


createdDatestringRead-onlyformat date-time

Date and time the Order was created.


updatedDatestringRead-onlyformat date-time

Date and time the Order was last updated.


sourceChannelIdstringformat GUIDimmutable

Source sales channel, i.e. Shopify.


sourceTenantIdstringminLength 1maxLength 50immutable

Tenant ID in source sales channel, i.e. shop ID.


sourceOrderIdstringminLength 1maxLength 50immutable

Order ID in source sales channel.


sourceOrderNumberstringmaxLength 50

The order number in source sales channel.


totalAmountstringformat DECIMAL_VALUEdecimalValue {"gte":"0","maxScale":5}

The total amount of the order that contains the Gift Card.


currencystringformat CURRENCY

The order's currency.


notestringmaxLength 120

Note to be added to the order.


paymentStatusstring

The payment status of the order.


fulfillmentStatusstring

Fulfillment status of the order in Rise.


statusstring

Status of the order in Rise.


buyerInfoBuyerInfo

Information about the buyer.


scheduleFulfillAtstringformat date-time

Date and time to fulfill the order by creating Gift Cards. Default is now.


riseFulfilledAtstringRead-onlyformat date-time

Date and time the order was fulfilled in Rise by creating Gift Cards.


sourceFulfilledAtstringformat date-time

Date and time the order was marked fulfilled in the Source sales channel.


lineItemsArray <GiftCardLineItem>maxItems 100

The line items in the order that are Gift Cards.


fraudMessagestringmaxLength 250

The fraud message.


fraudTypestring

The fraud logic type.


sourceLocationIdstringminLength 1maxLength 50immutable

Location ID in Source.

Did this help?