Glossary

Full reference for the fields and objects available in the Littledata Event Customiser.

Use this glossary to look up the fields and objects available in the Event Customiser.

Each section renders from the live OpenAPI specification.

That keeps this reference in sync with the event pipeline.

Properties

Top-level event properties. The fields available depend on the event type.

The Properties object

Attributes

Top-level event properties. The fields available depend on the event type. This object lists every property that can appear under properties across all supported events.

idstringOptional

The cart ID

Example: 5821934567

cart_idstringOptional

The associated cart ID

Example: 5821934567

error_typestringOptional

The type of charge error

Example: card_declined

namestringOptional

Fulfillment name

Example: Blue T-shirt / Medium

notestringOptional

The cart notes

Example: Leave at front door

subscription_idstringOptional

The subscription ID

Example: 5821934567

checkout_idstringOptional

The associated checkout ID

Example: 5821934567

create_checkout_urlstring · uriOptional

A synthetic URL that will create a checkout with the items in the cart.

Example: https://example.com

first_namestringOptional

Customer first name

Example: Alice

order_interval_frequencystringOptional

Order interval frequency (e.g. 30)

Example: 30

tokenstringOptional

The checkout token

Example: 5821934567

last_namestringOptional

Customer last name

Example: Smith

order_idstringOptional

The Shopify order ID

Example: 5821934567

order_interval_unitstringOptional

Order interval unit (e.g. day)

Example: day

checkout_tokenstringOptional

The checkout token

Example: abc123def456

statusstringOptional

Subscription status

Example: active

cancel_reasonstringOptional

Cancellation reason

Example: customer

emailstring · emailOptional

Customer email on the order

Example: [email protected]

payment_gatewaystringOptional

The payment gateway used

Example: shopify_payments

statestringOptional

Customer account state (enabled/disabled/invited/declined)

Example: subscribed

cancel_reason_commentsstringOptional

Cancellation reason comments

Example: Customer requested cancellation

landing_sitestringOptional

The landing site URL that led to the checkout

Example: https://example.com/products/blue-tshirt

phonestringOptional

Customer phone on the order

Example: +1-555-0123

payment_gatewaysstringOptional

Payment gateways used (array)

Example: shopify_payments

servicestringOptional

Fulfillment service

Example: manual

user_idstringOptional

The user who issued the refund

Example: 5821934567

verified_emailbooleanOptional

Whether the customer has verified their email

Example: true

abandoned_checkout_urlstring · uriOptional

Shopify URL to resume an abandoned checkout (valid for 3 months)

Example: https://example.com

return_idstringOptional

The associated return ID

Example: 5821934567

tax_exemptnumber · floatOptional

Whether the customer is tax exempt

Example: 19.99

tracking_companystringOptional

Tracking company

Example: UPS

order_status_urlstring · uriOptional

Shopify order status page URL

Example: https://example.com

shipment_statusstringOptional

Shipment status

Example: in_transit

tax_exemptionsnumber · floatOptional

Tax exemptions (array)

Example: 19.99

order_numberstringOptional

Order number (display)

Example: 1001

presentment_currencystringOptional

Customer presentment currency

Example: EUR

order_namestringOptional

Order name (e.g. #1001)

Example: #1001

tracking_numbersstringOptional

Tracking numbers (array)

Example: 1Z999AA10123456784

order_typestringOptional

Order type: REGULAR, FIRST_RECURRING, or RECURRING

Example: REGULAR

tracking_urlsstring · uriOptional

Tracking URLs (array)

Example: https://example.com

fulfillment_statusstringOptional

Fulfillment status of the order

Example: fulfilled

location_idstringOptional

Location ID where the order was placed

Example: 5821934567

importbooleanOptional

Whether this is an imported (historical) order

Example: true

tagsstring[]Optional

Order tags

Example: ["new","summer"]

cancelled_atstring · date-timeOptional

ISO-8601 timestamp of when the order was cancelled

Example: 2025-04-15T10:30:00Z

The Properties object

{
  "id": "5821934567",
  "cart_id": "5821934567",
  "error_type": "card_declined",
  "name": "Blue T-shirt / Medium",
  "note": "Leave at front door",
  "subscription_id": "5821934567",
  "checkout_id": "5821934567",
  "create_checkout_url": "https://example.com",
  "first_name": "Alice",
  "order_interval_frequency": "30",
  "token": "5821934567",
  "last_name": "Smith",
  "order_id": "5821934567",
  "order_interval_unit": "day",
  "checkout_token": "abc123def456",
  "status": "active",
  "cancel_reason": "customer",
  "email": "[email protected]",
  "payment_gateway": "shopify_payments",
  "state": "subscribed",
  "cancel_reason_comments": "Customer requested cancellation",
  "landing_site": "https://example.com/products/blue-tshirt",
  "phone": "+1-555-0123",
  "payment_gateways": "shopify_payments",
  "service": "manual",
  "user_id": "5821934567",
  "verified_email": true,
  "abandoned_checkout_url": "https://example.com",
  "return_id": "5821934567",
  "tax_exempt": 19.99,
  "tracking_company": "UPS",
  "order_status_url": "https://example.com",
  "shipment_status": "in_transit",
  "tax_exemptions": 19.99,
  "order_number": "1001",
  "presentment_currency": "EUR",
  "order_name": "#1001",
  "tracking_numbers": "1Z999AA10123456784",
  "order_type": "REGULAR",
  "tracking_urls": "https://example.com",
  "fulfillment_status": "fulfilled",
  "location_id": "5821934567",
  "import": true,
  "tags": [
    "new",
    "summer"
  ],
  "cancelled_at": "2025-04-15T10:30:00Z"
}

Event

Event-level metadata such as timestamp, event name, and identifiers.

The Event object

Attributes

Event-level metadata such as timestamp, event name, and identifiers.

idstringOptional

Unique identifier for this event

Example: 5821934567

created_atstring · date-timeOptional

The ISO-8601 for when this event was created

Example: 2025-04-15T10:30:00Z

timestampstring · date-timeOptional

The ISO-8601 for when this event was received

Example: 2025-04-15T10:30:00Z

app.idstringOptional

The app ID that issued this event

Example: 5821934567

app.namestringOptional

The app name that issued this event

Example: Blue T-shirt / Medium

source_namestringOptional

The source_name that issued this event

Example: web

is_subscription_appbooleanOptional

Whether this app ID is a known subscription app

Example: true

The Event object

{
  "id": "5821934567",
  "created_at": "2025-04-15T10:30:00Z",
  "timestamp": "2025-04-15T10:30:00Z",
  "app.id": "5821934567",
  "app.name": "Blue T-shirt / Medium",
  "source_name": "web",
  "is_subscription_app": true
}

Product

Enriched product object. Represents a product line item in a cart, order, or product event.

The Product object

Attributes

Enriched product object (IUTSEnrichedProduct). Represents a product line item in a cart, order, or product event.

product_idstringOptional

Product ID

Example: 5821934567

variant_idstringOptional

Product Variant ID

Example: 5821934567

titlestringOptional

Product title

Example: Blue T-shirt

namestringOptional

Product title + variant title

Example: Blue T-shirt / Medium

skustringOptional

SKU

Example: SKU-001

quantityintegerOptional

Quantity

Example: 1

price.shopnumber · floatOptional

Price in shop currency

Example: 19.99

price.presentmentnumber · floatOptional

Price in presentment currency

Example: 19.99

compare_at_price.shopnumber · floatOptional

Compare-at price in shop currency

Example: 19.99

compare_at_price.presentmentnumber · floatOptional

Compare-at price in presentment currency

Example: 19.99

total_discounts.shopnumber · floatOptional

Line-total discount in shop currency

Example: 19.99

total_discounts.presentmentnumber · floatOptional

Line-total discount in presentment currency

Example: 19.99

line_price.shopnumber · floatOptional

Line price (price * quantity) in shop currency

Example: 19.99

line_price.presentmentnumber · floatOptional

Line price (price * quantity) in presentment currency

Example: 19.99

discounted_price.shopnumber · floatOptional

Discounted unit price in shop currency

Example: 19.99

discounted_price.presentmentnumber · floatOptional

Discounted unit price in presentment currency

Example: 19.99

currency.shopstringOptional

Shop currency code

Example: USD

currency.presentmentstringOptional

Presentment currency code

Example: USD

currency.conversion_ratenumberOptional

Currency conversion rate

Example: 1

product_urlstring · uriOptional

Product URL

Example: https://example.com

product_typestringOptional

Product type

Example: Apparel

vendorstringOptional

Product vendor

Example: Acme

variant_titlestringOptional

Variant title

Example: Medium

handlestringOptional

Product handle

Example: blue-tshirt

tagsstring[]Optional

Product tags

Example: ["new","summer"]

image_urlstring · uriOptional

Product image URL

Example: https://example.com

categorystringOptional

Product category

Example: Apparel

gramsintegerOptional

Product weight in grams

Example: 1

taxablebooleanOptional

Whether the product is taxable

Example: true

gift_cardbooleanOptional

Whether the product is a gift card

Example: true

add_countintegerOptional

Number of times added to cart

Example: 1

The Product object

{
  "product_id": "5821934567",
  "variant_id": "5821934567",
  "title": "Blue T-shirt",
  "name": "Blue T-shirt / Medium",
  "sku": "SKU-001",
  "quantity": 1,
  "price.shop": 19.99,
  "price.presentment": 19.99,
  "compare_at_price.shop": 19.99,
  "compare_at_price.presentment": 19.99,
  "total_discounts.shop": 19.99,
  "total_discounts.presentment": 19.99,
  "line_price.shop": 19.99,
  "line_price.presentment": 19.99,
  "discounted_price.shop": 19.99,
  "discounted_price.presentment": 19.99,
  "currency.shop": "USD",
  "currency.presentment": "USD",
  "currency.conversion_rate": 1,
  "product_url": "https://example.com",
  "product_type": "Apparel",
  "vendor": "Acme",
  "variant_title": "Medium",
  "handle": "blue-tshirt",
  "tags": [
    "new",
    "summer"
  ],
  "image_url": "https://example.com",
  "category": "Apparel",
  "grams": 1,
  "taxable": true,
  "gift_card": true,
  "add_count": 1
}

Customer

Customer object representing the shopper associated with the event.

The Customer object

Attributes

Customer object representing the shopper associated with the event.

idstringOptional

Customer ID

Example: 5821934567

notestringOptional

Customer Note

Example: Leave at front door

emailstring · emailOptional

Customer Email

Example: [email protected]

first_namestringOptional

Customer First name

Example: Alice

last_namestringOptional

Customer Last name

Example: Smith

phonestringOptional

Customer Phone number

Example: +1-555-0123

address.address1stringOptional

Customer Address line 1

Example: 123 Main St

address.address2stringOptional

Customer Address line 2

Example: Apt 4

address.citystringOptional

Customer Address City

Example: New York

address.countrystringOptional

Customer Address Country

Example: US

address.country_codestringOptional

Customer Address Country code

Example: US

address.provincestringOptional

Customer Address Province

Example: NY

address.province_codestringOptional

Customer Address Province code

Example: NY

address.zipstringOptional

Customer Address ZIP

Example: 10001

orders_countintegerOptional

Customer's total number of orders

Example: 1

total_spentnumber · floatOptional

Customer's total amount spent in your shop

Example: 19.99

tagsstring[]Optional

Customer's tags

Example: ["new","summer"]

verified_emailbooleanOptional

Customer's Email verification status

Example: true

sms_marketing_consent.statestringOptional

Customer's SMS Marketing Consent state

Example: subscribed

sms_marketing_consent.opt_in_levelstringOptional

Customer's SMS Marketing Opt-in level

Example: single_opt_in

sms_marketing_consent.consent_updated_atstring · date-timeOptional

Customer's SMS Marketing Consent update time

Example: 2025-04-15T10:30:00Z

email_marketing_consent.statestringOptional

Customer's Email Marketing Consent state

Example: subscribed

email_marketing_consent.opt_in_levelstringOptional

Customer's Email Marketing Opt-in level

Example: single_opt_in

email_marketing_consent.consent_updated_atstring · date-timeOptional

Customer's Email Marketing Consent update time

Example: 2025-04-15T10:30:00Z

created_atstring · date-timeOptional

Customer's creation time

Example: 2025-04-15T10:30:00Z

updated_atstring · date-timeOptional

Customer's last update time

Example: 2025-04-15T10:30:00Z

The Customer object

{
  "id": "5821934567",
  "note": "Leave at front door",
  "email": "[email protected]",
  "first_name": "Alice",
  "last_name": "Smith",
  "phone": "+1-555-0123",
  "address.address1": "123 Main St",
  "address.address2": "Apt 4",
  "address.city": "New York",
  "address.country": "US",
  "address.country_code": "US",
  "address.province": "NY",
  "address.province_code": "NY",
  "address.zip": "10001",
  "orders_count": 1,
  "total_spent": 19.99,
  "tags": [
    "new",
    "summer"
  ],
  "verified_email": true,
  "sms_marketing_consent.state": "subscribed",
  "sms_marketing_consent.opt_in_level": "single_opt_in",
  "sms_marketing_consent.consent_updated_at": "2025-04-15T10:30:00Z",
  "email_marketing_consent.state": "subscribed",
  "email_marketing_consent.opt_in_level": "single_opt_in",
  "email_marketing_consent.consent_updated_at": "2025-04-15T10:30:00Z",
  "created_at": "2025-04-15T10:30:00Z",
  "updated_at": "2025-04-15T10:30:00Z"
}

Address

Address object. Used for customer default addresses, billing addresses, shipping addresses, and fulfillment origin and destination addresses.

The Address object

Attributes

Address object. Used for customer default addresses, billing addresses, shipping addresses, and fulfillment origin/destination addresses.

address1stringOptional

Address line 1

Example: 123 Main St

address2stringOptional

Address line 2

Example: Apt 4

citystringOptional

City

Example: New York

companystringOptional

Company

Example: Acme Inc

countrystringOptional

Country

Example: US

first_namestringOptional

First name

Example: Alice

last_namestringOptional

Last name

Example: Smith

full_namestringOptional

Full name

Example: Alice Smith

phonestringOptional

Phone

Example: +1-555-0123

provincestringOptional

Province/State

Example: NY

province_codestringOptional

Province/State code

Example: NY

postal_codestringOptional

Postal/ZIP code

Example: 10001

The Address object

{
  "address1": "123 Main St",
  "address2": "Apt 4",
  "city": "New York",
  "company": "Acme Inc",
  "country": "US",
  "first_name": "Alice",
  "last_name": "Smith",
  "full_name": "Alice Smith",
  "phone": "+1-555-0123",
  "province": "NY",
  "province_code": "NY",
  "postal_code": "10001"
}

Money

Monetary totals broken down by shop and presentment currency.

The Money object

Attributes

Monetary totals broken down by shop and presentment currency.

currency.shopstringOptional

Shop currency

Example: USD

currency.presentmentstringOptional

Presentment currency

Example: USD

currency.conversion_ratenumberOptional

Currency conversion rate

Example: 1

subtotal.shopnumber · floatOptional

Total price of the items before tax and shipping, but with discounts applied in the Shop currency

Example: 19.99

subtotal.presentmentnumber · floatOptional

Total price of the items before tax and shipping, but with discounts applied in the Presentment currency

Example: 19.99

total_items.shopnumber · floatOptional

Total price of the items before tax, shipping and discounts in the Shop currency

Example: 19.99

total_items.presentmentnumber · floatOptional

Total price of the items before tax, shipping and discounts in the Presentment currency

Example: 19.99

tax.shopnumber · floatOptional

Total tax paid in the Shop currency

Example: 19.99

tax.presentmentnumber · floatOptional

Total tax paid in the Presentment currency

Example: 19.99

shipping.shopnumber · floatOptional

Total shipping cost in the Shop currency

Example: 19.99

shipping.presentmentnumber · floatOptional

Total shipping cost in the Presentment currency

Example: 19.99

discounts.shopnumber · floatOptional

Total discounts applied in the Shop currency

Example: 19.99

discounts.presentmentnumber · floatOptional

Total discounts applied in the Presentment currency

Example: 19.99

total.shopnumber · floatOptional

Total price (subtotal + tax + shipping) in the Shop currency

Example: 19.99

total.presentmentnumber · floatOptional

Total price (subtotal + tax + shipping) in the Presentment currency

Example: 19.99

The Money object

{
  "currency.shop": "USD",
  "currency.presentment": "USD",
  "currency.conversion_rate": 1,
  "subtotal.shop": 19.99,
  "subtotal.presentment": 19.99,
  "total_items.shop": 19.99,
  "total_items.presentment": 19.99,
  "tax.shop": 19.99,
  "tax.presentment": 19.99,
  "shipping.shop": 19.99,
  "shipping.presentment": 19.99,
  "discounts.shop": 19.99,
  "discounts.presentment": 19.99,
  "total.shop": 19.99,
  "total.presentment": 19.99
}

Shop

Shop-level metadata about the Shopify store.

The Shop object

Attributes

Shop-level metadata about the Shopify store.

titlestringOptional

Shop's official title

Example: Blue T-shirt

domainstring · uriOptional

Shop's public domain

Example: https://example.com

shopify_domainstringOptional

Shop's shopify domain

Example: example.myshopify.com

currencystringOptional

Shop's currency

Example: USD

countrystringOptional

Shop's origin country code

Example: US

The Shop object

{
  "title": "Blue T-shirt",
  "domain": "https://example.com",
  "shopify_domain": "example.myshopify.com",
  "currency": "USD",
  "country": "US"
}

Market

Shopify Markets information for cross-border selling.

The Market object

Attributes

Shopify Markets information for cross-border selling.

idstringOptional

Market ID

Example: 5821934567

handlestringOptional

Market handle

Example: blue-tshirt

The Market object

{
  "id": "5821934567",
  "handle": "blue-tshirt"
}

Context

Event context including device, browser, page, campaign, and session metadata.

The Context object

Attributes

Event context including device, browser, page, campaign, and session metadata.

campaign.utm_idstringOptional

UTM campaign ID

Example: 5821934567

campaign.utm_sourcestringOptional

UTM source

Example: google

campaign.utm_mediumstringOptional

UTM medium

Example: cpc

campaign.utm_campaignstringOptional

UTM campaign name

Example: spring_sale

campaign.utm_termstringOptional

UTM term

Example: blue tshirt

campaign.utm_contentstringOptional

UTM content

Example: ad_variant_a

ipv4stringOptional

Client IPv4 address

Example: 192.0.2.42

ipv6stringOptional

Client IPv6 address

Example: 2001:db8::1

localestringOptional

Client locale

Example: en-US

countrystringOptional

Client country ISO code

Example: US

languagestringOptional

Client language ISO code

Example: en

page.pathstringOptional

Page path

Example: /products/blue-tshirt

page.referrerstring · uriOptional

Page referrer URL

Example: https://example.com

page.searchstringOptional

Page search/query string

Example: ?utm_source=google

page.titlestringOptional

Page title

Example: Blue T-shirt

page.urlstring · uriOptional

Page URL

Example: https://example.com

screen.densitystringOptional

Screen pixel density

Example: 2

screen.heightstringOptional

Screen height

Example: 1080

screen.widthstringOptional

Screen width

Example: 1920

timezonestringOptional

TZdata formatted timezone

Example: America/New_York

user_agentstringOptional

Client User-Agent string

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36

client_hints.mobilebooleanOptional

Client Hints: is mobile device

Example: true

client_hints.platformstringOptional

Client Hints: platform (e.g. Windows, macOS)

Example: macOS

client_hints.platform_versionstringOptional

Client Hints: platform version

Example: 14.0.1

client_hints.architecturestringOptional

Client Hints: CPU architecture

Example: x86

client_hints.bitnessstringOptional

Client Hints: CPU bitness

Example: 64

client_hints.modelstringOptional

Client Hints: device model

Example: iPhone15,2

client_hints.wow64booleanOptional

Client Hints: WoW64 emulation

Example: true

client_hints.device_typestringOptional

Client Hints: device type

Example: mobile

client_hints.vendorstringOptional

Client Hints: browser vendor

Example: Acme

user_consent.marketingbooleanOptional

User consent: marketing

Example: true

user_consent.analyticsbooleanOptional

User consent: analytics

Example: true

user_consent.preferencesbooleanOptional

User consent: preferences

Example: true

user_consent.sale_of_datastringOptional

User consent: sale of data

Example: denied

market_idstringOptional

Shopify Market identifier

Example: 5821934567

littledata_idstringOptional

Littledata ID

Example: 5821934567

shopify_ystringOptional

Shopify Y cookie

Example: 5821934567

The Context object

{
  "campaign.utm_id": "5821934567",
  "campaign.utm_source": "google",
  "campaign.utm_medium": "cpc",
  "campaign.utm_campaign": "spring_sale",
  "campaign.utm_term": "blue tshirt",
  "campaign.utm_content": "ad_variant_a",
  "ipv4": "192.0.2.42",
  "ipv6": "2001:db8::1",
  "locale": "en-US",
  "country": "US",
  "language": "en",
  "page.path": "/products/blue-tshirt",
  "page.referrer": "https://example.com",
  "page.search": "?utm_source=google",
  "page.title": "Blue T-shirt",
  "page.url": "https://example.com",
  "screen.density": "2",
  "screen.height": "1080",
  "screen.width": "1920",
  "timezone": "America/New_York",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
  "client_hints.mobile": true,
  "client_hints.platform": "macOS",
  "client_hints.platform_version": "14.0.1",
  "client_hints.architecture": "x86",
  "client_hints.bitness": "64",
  "client_hints.model": "iPhone15,2",
  "client_hints.wow64": true,
  "client_hints.device_type": "mobile",
  "client_hints.vendor": "Acme",
  "user_consent.marketing": true,
  "user_consent.analytics": true,
  "user_consent.preferences": true,
  "user_consent.sale_of_data": "denied",
  "market_id": "5821934567",
  "littledata_id": "5821934567",
  "shopify_y": "5821934567"
}

Client IDs

Client identifiers from analytics destinations such as GA4 and Meta.

The ClientId object

Attributes

Client identifiers from analytics destinations (GA4, Meta, etc.).

google_analytics4.cidstringOptional

Google Analytics Client ID

Example: GA1.2.123456789.1234567890

google_analytics4.sidstringOptional

Google Analytics Session ID

Example: 1234567890

facebook.fbpstringOptional

Meta CAPI FBP cookie

Example: fb.1.1554763741205.234567890

facebook.fbcstringOptional

Meta CAPI FBC cookie

Example: fb.1.1554763741205.AbCdEfGhIjKlMnOp

tiktok.ttpstringOptional

TikTok TTP cookie

Example: 01HXXXX

tiktok.ttclidstringOptional

TikTok TTCLID cookie

Example: E.C.P.AbCdEfGhIj

pinterest.epikstringOptional

Pinterest EPIK cookie

Example: dj0yJnU9...

klaviyo.exchange_idstringOptional

Klaviyo _kx cookie

Example: 5821934567

attentive.attentive_idstringOptional

Attentive _attentive_id cookie

Example: 5821934567

google_ads.gclidstringOptional

Google Ads GCLID cookie

Example: Cj0KCQjw...

google_ads.gbraidstringOptional

Google Ads GBRAID cookie

Example: 0AAAAA...

google_ads.wbraidstringOptional

Google Ads WBRAID cookie

Example: 0AAAAB...

microsoft.msclkidstringOptional

Bing Ads MSCLKID cookie

Example: abcdef1234567890abcdef1234567890

segment.anonymous_idstringOptional

Segment Anonymous ID

Example: 5821934567

The ClientId object

{
  "google_analytics4.cid": "GA1.2.123456789.1234567890",
  "google_analytics4.sid": "1234567890",
  "facebook.fbp": "fb.1.1554763741205.234567890",
  "facebook.fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOp",
  "tiktok.ttp": "01HXXXX",
  "tiktok.ttclid": "E.C.P.AbCdEfGhIj",
  "pinterest.epik": "dj0yJnU9...",
  "klaviyo.exchange_id": "5821934567",
  "attentive.attentive_id": "5821934567",
  "google_ads.gclid": "Cj0KCQjw...",
  "google_ads.gbraid": "0AAAAA...",
  "google_ads.wbraid": "0AAAAB...",
  "microsoft.msclkid": "abcdef1234567890abcdef1234567890",
  "segment.anonymous_id": "5821934567"
}

Discount codes

Discount code applied to the order.

The DiscountCode object

Attributes

Discount code applied to the order.

codestringOptional

Discount code

Example: SUMMER10

amountnumber · floatOptional

Discount amount

Example: 19.99

typestringOptional

Discount type

Example: shopify

The DiscountCode object

{
  "code": "SUMMER10",
  "amount": 19.99,
  "type": "shopify"
}

Note attributes

Custom note attribute (key/value pair) attached to the order.

The NoteAttribute object

Attributes

Custom note attribute (key/value pair) attached to the order.

namestringOptional

Note attribute name

Example: Blue T-shirt / Medium

valuenumber · floatOptional

Note attribute value

Example: 19.99

The NoteAttribute object

{
  "name": "Blue T-shirt / Medium",
  "value": 19.99
}

Shipping lines

Shipping line item on the order.

The ShippingLine object

Attributes

Shipping line item on the order.

codestringOptional

Shipping line code

Example: SUMMER10

titlestringOptional

Shipping line title

Example: Blue T-shirt

pricenumber · floatOptional

Shipping line price

Example: 19.99

The ShippingLine object

{
  "code": "SUMMER10",
  "title": "Blue T-shirt",
  "price": 19.99
}

Last updated 13 days ago

Was this helpful?