CData Python Connector for Shopify

Build 23.0.8839

GiftCards

Create, update, delete, and query gift cards.

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

The ID of the gift card.

APIClientId Long True

The ID of the client that issued the gift card.

Balance Decimal True

The balance of the gift card.

Code String False

The gift card code, which is a string of alphanumeric characters. For security reasons, this is available only upon creation of the gift card. (minimum: 8 characters, maximum: 20 characters)

CreatedAt Datetime True

The date and time (ISO 8601 format) when the gift card was created.

Currency String True

The currency of the gift card.

CustomerId Long True

Customers.Id

The ID of the customer associated with this gift card.

DisabledAt Datetime True

The date and time (ISO 8601 format) when the gift card was disabled.

ExpiresOn Date False

The date (YYYY-MM-DD format) when the gift card expires. Returns null if the gift card doesn't have an expiration date.

InitialValue Decimal False

The initial value of the gift card when it was created.

LastCharacters String True

The last four characters of the gift card code. Because gift cards are alternative payment methods, the full code cannot be retrieved.

LineItemId Long True

OrdersItems.ItemId

The ID of the line item that initiated the creation of this gift card, if it was created by an order.

Note String False

An optional note that a merchant can attach to the gift card that isn't visible to customers.

OrderId Long True

Orders.Id

The ID of the order that initiated the creation of this gift card, if it was created by an order.

TemplateSuffix String False

The suffix of the Liquid template that's used to render the gift card online. For example, if the value is birthday, then the gift card is rendered using the template gift_card.birthday.liquid. When the value is null, the default gift_card.liquid template is used.

UserId Long True

Users.Id

The ID of the user that issued the gift card, if it was issued by a user.

UpdatedAt Datetime True

The date and time (ISO 8601 format) when the gift card was last modified.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839