| Key | Type | Description |
|---|---|---|
| id | integer | Unique identifier for the order. |
| shopifyId | integer | Unique identifier of the order in Shopify. |
| scheduledAt | string (ISO 8601 date-time) | Date and time when the order was scheduled. |
| status | string | Status of the order (e.g., "SUCCESS"). |
| currencyCode | string | Currency code in ISO 4217 format (e.g., "USD"). |
| shippingPriceCurrencyCode | string | Currency code for the shipping price (e.g., "USD"). |
| totalLineItemsPrice | string | Total price of the line items (e.g., "100.00"). |
| totalDiscountAmount | string | Total discount amount applied to the order (e.g., "0.00"). |
| subtotalPrice | string | Subtotal price for the order (e.g., "100.00"). |
| totalShippingPrice | string | Total shipping price (e.g., "200.00"). |
| totalTaxes | string | Total taxes applied to the order (e.g., "0.00"). |
| totalPrice | string | Total price for the order (e.g., "300.00"). |
| note | string | Any additional note related to the order. |
| customAttributes | array | Custom attributes associated with the order (currently empty). |
| isDunning | boolean | Indicates dunning status of the order. true means the order has experienced at least one payment failure; false means the order was processed without any payment failure. |
| firstPaymentAttemptAt | string (ISO 8601 date-time) | Date and time of when the initial payment attempt was made on the order. Useful for determining when the first payment attempt for the order was made, especially when the order is in dunning |
discountCodes
| Key | Type | Description |
|---|---|---|
| discountCodes | array | Array of discount codes applied to the order (currently empty). |
lineItems
| Key | Type | Description | |
|---|---|---|---|
| lineItems[].name | string | Name of the line item (e.g., "Test Product - Month B"). | |
| lineItems[].variantImage | string \ | null | URL of the variant image, if available. |
| lineItems[].sku | string | SKU of the product. | |
| lineItems[].price | integer | Price of the line item (in cents). | |
| lineItems[].quantity | integer | Quantity of the item in the order. | |
| lineItems[].properties | array | Additional properties of the line item (currently empty). | |
| lineItems[].requiresShipping | boolean | Indicates if the item requires shipping. | |
| lineItems[].taxable | boolean | Indicates if the item is taxable. |
skippedLineItems
| Key | Type | Description |
|---|---|---|
| skippedLineItems | array | Array of skipped line items in the order (currently empty). |
shippingAddress
| Key | Type | Description | |
|---|---|---|---|
| shippingAddress.name | string | Full name of the customer (e.g., "Matt brownlee"). | |
| shippingAddress.phone | string \ | null | Customer’s phone number, if provided. |
| shippingAddress.company | string \ | null | Name of the company, if applicable. |
| shippingAddress.address1 | string | Primary address line. | |
| shippingAddress.address2 | string \ | null | Secondary address line, if applicable. |
| shippingAddress.zip | string | ZIP or postal code. | |
| shippingAddress.city | string | City name. | |
| shippingAddress.provinceCode | string | Province or state code (e.g., "ID"). | |
| shippingAddress.countryCode | string | ISO 3166 country code (e.g., "US"). |
chargeOffsetDays
| Key | Type | Description | |
|---|---|---|---|
| chargeOffsetDays | null \ | integer | Number of days to offset the charge, if applicable. |
shippingLines
| Key | Type | Description | |
|---|---|---|---|
| shippingLines | null \ | object | Shipping lines information (currently null). |
customer
| Key | Type | Description | |
|---|---|---|---|
| customer.shopifyId | integer | Shopify customer ID. | |
| customer.firstName | string | Customer’s first name. | |
| customer.lastName | string | Customer’s last name. | |
| customer.email | string | Customer’s email address. | |
| customer.phone | string \ | null | Customer’s phone number, if available. |
subscriptions
| Key | Type | Description |
|---|---|---|
| subscription.id | integer | Unique identifier for the subscription. |
| subscription.deliveryPrice | integer | Cost of delivery for the subscription (in cents). |
| subscription.pausedAt | null | string (ISO 8601 date-time) | Date and time when the subscription was paused, if applicable. |
| subscription.cancelledAt | null | string (ISO 8601 date-time) | Date and time when the subscription was canceled, if applicable. |
| subscription.cancellationReason | null | string | Reason for cancellation, if provided. |
| subscription.cancellationComment | null | string | Additional comments related to the cancellation. |
| subscription.hasCustomPlan | boolean | Indicates whether the subscription has a custom plan. |
| subscription.billingPolicy.interval | string | Billing interval (e.g., "MONTH"). |
| subscription.billingPolicy.intervalCount | integer | Number of intervals between billing cycles. |
| subscription.billingPolicy.minCycles | int | null | Minimum number of billing cycles. |
| subscription.billingPolicy.maxCycles | int | null | Maximum number of billing cycles. |
| subscription.billingPolicy.anchors | null | object | The anchors object can take the following format: For monthday type: {"type": "MONTHDAY", "day": 2, "month": null} For yearday type: {"type": "YEARDAY", "day": 1, "month": 1} |
| subscription.deliveryPolicy.interval | string | Delivery interval (e.g., "MONTH"). |
| subscription.deliveryPolicy.intervalCount | integer | Number of intervals between deliveries. |
| subscription.isPrepaid | boolean | Indicates if the subscription is prepaid. |
| subscription.nextOrderDate | string (ISO 8601 date-time) | Date of the next order in the subscription. |
| subscription.nextOrderDateEpoch | integer | Epoch timestamp of the next order in the subscription. |
| subscription.discounts | array | Array of discounts applied to the subscription (currently empty). |
| subscription.hasBundle | boolean | Indicates if the subscription contains a bundled item. |
| subscription.willAutoResume | boolean | Indicates if the subscription will automatically resume. |
| subscription.note | null | string | Additional notes related to the subscription. |
| subscription.customAttributes | array | Custom attributes related to the subscription (currently empty). |
| subscription.lineItems | array | Array of line items associated with the subscription. |
paymentAttempt
| Key | Type | Description |
|---|---|---|
createdAt | string (ISO 8601) | Timestamp when this payment attempt was created. |
errorCode | string | Machine-readable error code returned by the payment provider when the attempt failed (e.g. PAYMENT_PROVIDER_IS_NOT_ENABLED means the configured gateway isn't active for this shop). |
shopifyId | number | Shopify's unique identifier for this billing/payment attempt. |
updatedAt | string (ISO 8601) | Timestamp when this record was last updated. |
retryDelay | string | Delay (in days) before the next retry is scheduled. |
errorMessage | string | Human-readable version of errorCode, meant for display or logging. |
failureAction | string | null | Action to take once retries are exhausted (e.g. pause or cancel the subscription). null means no failure action is configured. |
idempotencyKey | string | Unique key used to prevent duplicate charge attempts for the same billing cycle. |
isHardDeclined | boolean | true if the decline is final and won't be retried (e.g. card reported stolen); false if it's a soft decline eligible for retry. |
retryLeftCount | number | Number of retry attempts still remaining before Loop gives up on this charge. |
retryAttemptCount | number | Number of retry attempts already made for this charge. |
metaData
| Key | Type | Description |
|---|---|---|
| metaData.myshopifyDomain | string | The domain name of the Shopify store. |