chore(docs): Generated DML JSON files (automated) (#13790)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-10-21 11:56:47 +03:00
committed by GitHub
parent 858b3e3b9b
commit 5bc9de9d2e
24 changed files with 342 additions and 2 deletions

View File

@@ -12,6 +12,9 @@
"created_by": "The ID of the user that created the API key",
"revoked_by": "The ID of the user that revoked the API key",
"revoked_at": "The date the API key was revoked."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"auth_identity": "The associated `AuthIdentity`.\n\n@expandable",
"user_metadata": "The user metadata of the provider identity.",
"provider_metadata": "The provider metadata of the provider identity."
},
"deprecated": {
"is_deprecated": false
}
},
"AuthIdentity": {
@@ -16,6 +19,9 @@
"id": "The ID of the auth identity.",
"provider_identities": "The associated `ProviderIdentity` records.\n\n@expandable",
"app_metadata": "The app metadata of the auth identity"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -15,6 +15,9 @@
"postal_code": "The postal code of the address",
"phone": "The phone of the address",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"LineItemTaxLine": {
@@ -28,6 +31,9 @@
"metadata": "Holds custom data in key-value pairs.",
"tax_rate_id": "The ID of the applied tax rate.",
"item": "The associated line item.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"LineItemAdjustment": {
@@ -42,6 +48,9 @@
"metadata": "Holds custom data in key-value pairs.",
"item": "The associated line item.\n\n@expandable",
"is_tax_inclusive": "Whether the line item adjustment is tax inclusive."
},
"deprecated": {
"is_deprecated": false
}
},
"LineItem": {
@@ -76,6 +85,9 @@
"cart": "The associated cart.\n\n@expandable",
"is_custom_price": "Whether the line item's price is custom.",
"is_giftcard": "Whether the line item is a giftcard."
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingMethodAdjustment": {
@@ -89,6 +101,9 @@
"metadata": "Holds custom data in key-value pairs.",
"promotion_id": "The ID of the promotion applied",
"shipping_method": "The associated shipping_method.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingMethodTaxLine": {
@@ -102,6 +117,9 @@
"tax_rate_id": "The ID of the applied tax rate.",
"metadata": "Holds custom data in key-value pairs.",
"shipping_method": "The associated shipping_method.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingMethod": {
@@ -118,6 +136,9 @@
"cart": "The associated cart.\n\n@expandable",
"tax_lines": "The associated tax_lines.\n\n@expandable",
"adjustments": "The associated adjustments.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Cart": {
@@ -136,6 +157,9 @@
"items": "The associated items.\n\n@expandable",
"shipping_methods": "The associated shipping_methods.\n\n@expandable",
"credit_lines": "The associated credit_lines.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"CreditLine": {
@@ -148,6 +172,9 @@
"amount": "The amount of the credit line",
"raw_amount": "The raw amount of the credit line",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"name": "The name of the currency",
"decimal_digits": "How many digits are after the decimal separator for prices in this currency.",
"rounding": "The rounding percision of prices in this currency."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -7,6 +7,9 @@
"metadata": "Holds custom data in key-value pairs.",
"created_by": "The ID of the user that created the customer group.",
"customers": "The associated customers.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"CustomerGroupCustomer": {
@@ -17,6 +20,9 @@
"metadata": "Holds custom data in key-value pairs.",
"customer": "The associated customer.\n\n@expandable",
"customer_group": "The associated customer group.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Customer": {
@@ -33,6 +39,9 @@
"created_by": "The ID of the user that created the customer.",
"groups": "The associated groups.\n\n@expandable",
"addresses": "The associated addresses.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"CustomerAddress": {
@@ -54,6 +63,9 @@
"phone": "The phone of the customer address",
"metadata": "Holds custom data in key-value pairs.",
"customer": "The associated customer.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -14,6 +14,9 @@
"postal_code": "The postal code of the fulfillment address",
"phone": "The phone of the fulfillment address",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"FulfillmentItem": {
@@ -27,6 +30,9 @@
"line_item_id": "The ID the line item being fulfilled.",
"inventory_item_id": "The ID of the inventory item being fulfilled.",
"fulfillment": "The associated fulfillment.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"FulfillmentLabel": {
@@ -37,6 +43,9 @@
"tracking_url": "The tracking URL of the fulfillment label",
"label_url": "The label URL of the fulfillment label",
"fulfillment": "The associated fulfillment.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"FulfillmentProvider": {
@@ -44,6 +53,9 @@
"properties": {
"id": "The ID of the fulfillment provider.",
"is_enabled": "Whether the fulfillment provider is enabled."
},
"deprecated": {
"is_deprecated": false
}
},
"FulfillmentSet": {
@@ -54,6 +66,9 @@
"type": "The type of the fulfillment set",
"service_zones": "The associated service zones.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"GeoZone": {
@@ -67,6 +82,9 @@
"postal_expression": "The postal expression of the geo zone",
"service_zone": "The associated service zone.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"ServiceZone": {
@@ -78,6 +96,9 @@
"geo_zones": "The associated geo_zones.\n\n@expandable",
"shipping_options": "The associated shipping options.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingOptionRule": {
@@ -88,6 +109,9 @@
"operator": "The operator used in the condition.\n\n@example eq",
"value": "The value of the shipping option rule",
"shipping_option": "The associated shipping option.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingOptionType": {
@@ -98,6 +122,9 @@
"description": "The description of the shipping option type",
"code": "The code of the shipping option type",
"shipping_option": "The associated shipping option.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingProfile": {
@@ -108,6 +135,9 @@
"type": "The type of the shipping profile",
"shipping_options": "The associated shipping options.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"ShippingOption": {
@@ -124,6 +154,9 @@
"type": "The associated type.\n\n@expandable",
"rules": "The associated rules.\n\n@expandable",
"fulfillments": "The associated fulfillments.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Fulfillment": {
@@ -145,6 +178,9 @@
"shipping_option": "The associated shipping option.\n\n@expandable",
"delivery_address": "The associated delivery address.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -9,6 +9,9 @@
"parent_id": "The ID of the parent index relation.",
"child_id": "The ID of the child index relation.",
"staled_at": "The date the index relation was staled."
},
"deprecated": {
"is_deprecated": false
}
},
"IndexData": {
@@ -18,6 +21,9 @@
"name": "The name of the index data",
"data": "The data of the index",
"staled_at": "The date the index data was staled."
},
"deprecated": {
"is_deprecated": false
}
},
"IndexMetadata": {
@@ -28,6 +34,9 @@
"fields": "The fields of the index metadata",
"fields_hash": "The fields hash of the index metadata",
"status": "The status of the index metadata"
},
"deprecated": {
"is_deprecated": false
}
},
"IndexSync": {
@@ -36,6 +45,9 @@
"id": "The ID of the index sync.",
"entity": "The entity of the index sync",
"last_key": "The last key of the index sync"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -10,6 +10,9 @@
"metadata": "Holds custom data in key-value pairs.",
"inventory_item": "The associated inventory item.\n\n@expandable",
"available_quantity": "The available quantity of the inventory level"
},
"deprecated": {
"is_deprecated": false
}
},
"ReservationItem": {
@@ -26,6 +29,9 @@
"created_by": "The ID of the user that created the reservation item.",
"metadata": "Holds custom data in key-value pairs.",
"inventory_item": "The associated inventory item.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"InventoryItem": {
@@ -50,6 +56,9 @@
"reservation_items": "The associated reservation items.\n\n@expandable",
"reserved_quantity": "The reserved quantity of the inventory item",
"stocked_quantity": "The stocked quantity of the inventory item"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"is_enabled": "Whether the notification provider is enabled.",
"channels": "The channels the notification provider can be used for. For example, `email`.",
"notifications": "The associated notifications.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Notification": {
@@ -27,6 +30,9 @@
"external_id": "The id of the notification in the external system.",
"provider": "The associated provider used to send the notification.\n\n@expandable",
"status": "The status of the notification"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -15,6 +15,9 @@
"postal_code": "The postal code of the order address",
"phone": "The phone of the order address",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"OrderClaimItemImage": {
@@ -24,6 +27,9 @@
"claim_item": "The associated claim item.\n\n@expandable",
"url": "The URL of the order claim item image",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"OrderLineItemAdjustment": {
@@ -37,6 +43,9 @@
"provider_id": "The ID of the provider used to apply the adjustment.",
"item": "The associated item that the adjustment is applied on.\n\n@expandable",
"is_tax_inclusive": "Whether the order line item adjustment is tax inclusive."
},
"deprecated": {
"is_deprecated": false
}
},
"OrderLineItemTaxLine": {
@@ -49,6 +58,9 @@
"rate": "The rate of the order line item tax line",
"provider_id": "The ID of the tax provider used to calculate the tax line.",
"item": "The associated item that the tax line is for.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderLineItem": {
@@ -81,6 +93,9 @@
"tax_lines": "The associated tax lines.\n\n@expandable",
"adjustments": "The associated adjustments.\n\n@expandable",
"is_giftcard": "Whether the order line item is a giftcard."
},
"deprecated": {
"is_deprecated": false
}
},
"OrderClaimItem": {
@@ -95,6 +110,9 @@
"claim": "The associated claim.\n\n@expandable",
"item": "The associated order item.\n\n@expandable",
"images": "The associated images.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderCreditLine": {
@@ -107,6 +125,9 @@
"amount": "The amount of the order credit line",
"raw_amount": "The raw amount of the order credit line",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"OrderItem": {
@@ -127,6 +148,9 @@
"metadata": "Holds custom data in key-value pairs.",
"order": "The associated order.\n\n@expandable",
"item": "The associated line item.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderExchangeItem": {
@@ -138,6 +162,9 @@
"metadata": "Holds custom data in key-value pairs.",
"exchange": "The associated exchange.\n\n@expandable",
"item": "The associated item.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ReturnReason": {
@@ -150,6 +177,9 @@
"metadata": "Holds custom data in key-value pairs.",
"parent_return_reason": "The associated parent_return_reason.\n\n@expandable",
"return_reason_children": "The associated return_reason_children.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ReturnItem": {
@@ -164,6 +194,9 @@
"reason": "The reason of the return item",
"return": "The associated return.\n\n@expandable",
"item": "The associated item.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderTransaction": {
@@ -179,6 +212,9 @@
"return": "The associated return.\n\n@expandable",
"exchange": "The associated exchange.\n\n@expandable",
"claim": "The associated claim.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Return": {
@@ -202,6 +238,9 @@
"items": "The associated order items.\n\n@expandable",
"shipping_methods": "The associated shipping methods used to return the items.\n\n@expandable",
"transactions": "The associated transactions, which can include refunds made to the customer.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderExchange": {
@@ -221,6 +260,9 @@
"additional_items": "The associated additional (outbound) items that are send to the customer.\n\n@expandable",
"shipping_methods": "The associated shipping_methods.\n\n@expandable",
"transactions": "The associated transactions, which can hold payments made due to the `difference_due`.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderShippingMethodAdjustment": {
@@ -233,6 +275,9 @@
"amount": "The amount of the adjustment",
"provider_id": "The ID of the provider used to apply the adjustment.",
"shipping_method": "The associated shipping method that the adjustment is applied on.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderShippingMethodTaxLine": {
@@ -245,6 +290,9 @@
"rate": "The applied tax rate",
"provider_id": "The ID of the tax provider used to calculate the tax line.",
"shipping_method": "The associated shipping_method that the tax line is for.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderShippingMethod": {
@@ -261,6 +309,9 @@
"metadata": "Holds custom data in key-value pairs.",
"tax_lines": "The associated tax lines.\n\n@expandable",
"adjustments": "The applied adjustments.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderShipping": {
@@ -273,6 +324,9 @@
"exchange": "The associated exchange, if the shipping is used to send an item in an exchange.\n\n@expandable",
"claim": "The associated claim, if the shipping is used to send an item in a claim.\n\n@expandable",
"shipping_method": "The associated shipping method.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderSummary": {
@@ -282,6 +336,9 @@
"version": "The version that the summary belongs to.",
"totals": "The totals of the order summary",
"order": "The associated order.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Order": {
@@ -308,6 +365,9 @@
"transactions": "The associated transactions, which include amounts captured and refunded.\n\n@expandable",
"credit_lines": "The associated credit lines, which include additional payment amounts for an order.\n\n@expandable",
"returns": "The associated returns.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderClaim": {
@@ -328,6 +388,9 @@
"claim_items": "The associated claim (outbound) items.\n\n@expandable",
"shipping_methods": "The associated shipping methods used to send the new items.\n\n@expandable",
"transactions": "The associated transactions, which can hold the payments refunded.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderChangeAction": {
@@ -348,6 +411,9 @@
"internal_note": "The internal note of the order change action",
"applied": "Whether the order change action is applied.",
"order_change": "The order change that the action belongs to.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"OrderChange": {
@@ -375,6 +441,9 @@
"canceled_at": "The date that the change was canceled",
"order": "The associated order that the change applies to.\n\n@expandable",
"actions": "The associated actions.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -5,6 +5,9 @@
"id": "The ID of the payment provider.",
"is_enabled": "Whether the payment provider is enabled.",
"payment_collections": "The associated payment collections.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PaymentSession": {
@@ -21,6 +24,9 @@
"payment_collection": "The associated payment collection.\n\n@expandable",
"payment": "The associated payment.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"PaymentCollection": {
@@ -38,6 +44,9 @@
"payment_providers": "The associated payment providers.\n\n@expandable",
"payment_sessions": "The associated payment sessions.\n\n@expandable",
"payments": "The associated payments.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"RefundReason": {
@@ -47,7 +56,11 @@
"label": "The label of the refund reason",
"description": "The description of the refund reason",
"metadata": "Holds custom data in key-value pairs.",
"refunds": "The associated refunds.\n\n@expandable"
"refunds": "The associated refunds.\n\n@expandable",
"code": "The code of the refund reason"
},
"deprecated": {
"is_deprecated": false
}
},
"Refund": {
@@ -60,6 +73,9 @@
"note": "A note with more explanation about the refund",
"created_by": "The ID of the user that created the refund.",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"Payment": {
@@ -77,6 +93,9 @@
"payment_session": "The associated payment session.\n\n@expandable",
"refunds": "The associated refunds.\n\n@expandable",
"captures": "The associated captures.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Capture": {
@@ -87,6 +106,9 @@
"payment": "The associated payment.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs.",
"created_by": "The created by of the capture"
},
"deprecated": {
"is_deprecated": false
}
},
"AccountHolder": {
@@ -98,6 +120,9 @@
"email": "The email of the account holder",
"data": "The data returned by the payment provider when the account holder is created.",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -6,6 +6,9 @@
"attribute": "The attribute of the price list rule. For example, `region_id`.",
"value": "The value of the price list rule. For example, `reg_123`.",
"price_list": "The associated `PriceList`.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PriceList": {
@@ -21,6 +24,9 @@
"rules_count": "The total number of rules of the price list.",
"prices": "The associated `Price` records.\n\n@expandable",
"price_list_rules": "The associated `PriceListRule` records.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PriceRule": {
@@ -32,6 +38,9 @@
"operator": "The operator of the price rule. For example, `eq`.",
"priority": "The priority of the price rule.",
"price": "The associated `Price`.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PriceSet": {
@@ -39,6 +48,9 @@
"properties": {
"id": "The ID of the price set.",
"prices": "The associated `Price` records.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Price": {
@@ -54,6 +66,9 @@
"price_set": "The associated `PriceSet`.\n\n@expandable",
"price_rules": "The associated `PriceRule` records.\n\n@expandable",
"price_list": "The associated `PriceList`.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PricePreference": {
@@ -63,6 +78,9 @@
"attribute": "The attribute of the price preference. For example, `region_id`.",
"value": "The value of the price preference. For example, `reg_123`.",
"is_tax_inclusive": "Whether prices matching this preference include taxes."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -6,6 +6,9 @@
"value": "The value of the product tag",
"metadata": "Holds custom data in key-value pairs.",
"products": "The associated products.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductType": {
@@ -15,6 +18,9 @@
"value": "The value of the product type",
"metadata": "Holds custom data in key-value pairs.",
"products": "The associated products.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductImage": {
@@ -25,6 +31,9 @@
"metadata": "Holds custom data in key-value pairs.",
"rank": "The rank of the product image among its sibling images.",
"product": "The associated product.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductOptionValue": {
@@ -35,6 +44,9 @@
"metadata": "Holds custom data in key-value pairs.",
"option": "The associated option.\n\n@expandable",
"variants": "The associated variants.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductOption": {
@@ -45,6 +57,9 @@
"metadata": "Holds custom data in key-value pairs.",
"product": "The associated product.\n\n@expandable",
"values": "The associated values.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductVariant": {
@@ -70,6 +85,9 @@
"variant_rank": "The variant's rank among its siblings.",
"product": "The associated product.\n\n@expandable",
"options": "The associated options.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductCategory": {
@@ -87,6 +105,9 @@
"parent_category": "The associated parent_category.\n\n@expandable",
"category_children": "The associated category_children.\n\n@expandable",
"products": "The associated products.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"ProductCollection": {
@@ -97,6 +118,9 @@
"handle": "The unique handle of the product collection",
"metadata": "Holds custom data in key-value pairs.",
"products": "The associated products.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Product": {
@@ -128,6 +152,9 @@
"images": "The associated images.\n\n@expandable",
"collection": "The associated collection.\n\n@expandable",
"categories": "The associated categories.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -7,7 +7,12 @@
"currency_code": "The currency code of the campaign budget.\n\n@example usd",
"limit": "The limit of the campaign budget",
"used": "How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.",
"campaign": "The associated campaign.\n\n@expandable"
"campaign": "The associated campaign.\n\n@expandable",
"attribute": "The attribute of the campaign budget\n\n@since 2.11.0",
"usages": "The associated usages.\n\n@expandable\n\n@since 2.11.0"
},
"deprecated": {
"is_deprecated": false
}
},
"Campaign": {
@@ -21,6 +26,9 @@
"ends_at": "The date that the campaign ends.",
"budget": "The associated budget.\n\n@expandable",
"promotions": "The associated promotions.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PromotionRuleValue": {
@@ -29,6 +37,9 @@
"id": "The ID of the promotion rule value.",
"value": "The value of the promotion rule.",
"promotion_rule": "The associated promotion rule.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"PromotionRule": {
@@ -42,6 +53,9 @@
"promotions": "The associated promotions.\n\n@expandable",
"method_target_rules": "The associated method target rules.\n\n@expandable",
"method_buy_rules": "The associated method buy rules.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"Promotion": {
@@ -56,6 +70,9 @@
"rules": "The associated rules.\n\n@expandable",
"status": "The status of the promotion",
"is_tax_inclusive": "Whether the promotion is tax inclusive."
},
"deprecated": {
"is_deprecated": false
}
},
"ApplicationMethod": {
@@ -73,6 +90,22 @@
"promotion": "The associated promotion.\n\n@expandable",
"target_rules": "The associated target rules.\n\n@expandable",
"buy_rules": "The associated buy rules.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"CampaignBudgetUsage": {
"filePath": "packages/modules/promotion/src/models/campaign-budget-usage.ts",
"properties": {
"id": "The ID of the campaign budget usage.",
"attribute_value": "The attribute value of the campaign budget usage",
"used": "The used of the campaign budget usage",
"budget": "The associated budget.\n\n@expandable"
},
"since": "2.11.0",
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -5,6 +5,9 @@
"id": "The ID of the locking.",
"owner_id": "The ID of the locking's owner.",
"expiration": "The expiration date of the locking"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"automatic_taxes": "Whether taxes are calculated automatically during checkout in the region.",
"countries": "The countries that belong to the region.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"Country": {
@@ -20,6 +23,9 @@
"display_name": "The display name of the country",
"region": "The region it belongs to.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -7,6 +7,9 @@
"description": "The description of the sales channel",
"is_disabled": "Whether the sales channel is disabled.",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"user_id": "The user id of the view configuration",
"is_system_default": "Whether the view configuration is system default.",
"configuration": "The configuration of the view configuration"
},
"deprecated": {
"is_deprecated": false
}
},
"UserPreference": {
@@ -17,6 +20,9 @@
"user_id": "The user id of the user preference",
"key": "The key of the user preference",
"value": "The value of the user preference"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -13,6 +13,9 @@
"postal_code": "The postal code of the stock location address",
"metadata": "Holds custom data in key-value pairs.",
"stock_locations": "The associated stock locations.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"StockLocation": {
@@ -22,6 +25,9 @@
"name": "The name of the stock location",
"metadata": "Holds custom data in key-value pairs.",
"address": "The associated address.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -6,6 +6,9 @@
"currency_code": "The ISO 3 currency code. For example, `usd`.",
"is_default": "Whether the currency is the default in the store.",
"store": "The store this currency belongs to."
},
"deprecated": {
"is_deprecated": false
}
},
"Store": {
@@ -18,6 +21,9 @@
"default_location_id": "The ID of the store's default stock location.",
"metadata": "Holds custom data in key-value pairs.",
"supported_currencies": "The associated supported_currencies.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"tax_rate": "The associated tax rate.\n\n@expandable",
"reference": "The name of the table this rule references.\n\n@example product_type",
"reference_id": "The id of a record in the table that this rule references.\n\n@example ptyp_1"
},
"deprecated": {
"is_deprecated": false
}
},
"TaxProvider": {
@@ -16,6 +19,9 @@
"id": "The ID of the tax provider.",
"is_enabled": "Whether the tax provider is enabled.",
"regions": "The regions that use this provider to calculate taxes.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"TaxRegion": {
@@ -30,6 +36,9 @@
"parent": "The tax region's parent.\n\n@expandable",
"children": "The tax region's children..\n\n@expandable",
"tax_rates": "The associated tax rates.\n\n@expandable"
},
"deprecated": {
"is_deprecated": false
}
},
"TaxRate": {
@@ -45,6 +54,9 @@
"rules": "The associated rules.\n\n@expandable",
"metadata": "Holds custom data in key-value pairs.",
"created_by": "The ID of the user that created the tax rate"
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -8,6 +8,9 @@
"email": "The email of the user.",
"avatar_url": "The image URL of the user's avatar.",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
},
"Invite": {
@@ -19,6 +22,9 @@
"token": "The token of the invite.",
"expires_at": "When the invite expires.",
"metadata": "Holds custom data in key-value pairs."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -10,6 +10,9 @@
"state": "The state of the workflow execution",
"retention_time": "The number of seconds to store the workflow execution.",
"run_id": "The ID of the workflow execution run."
},
"deprecated": {
"is_deprecated": false
}
}
}

View File

@@ -10,6 +10,9 @@
"state": "The state of the workflow execution",
"retention_time": "The number of seconds to store the workflow execution.",
"run_id": "The ID of the workflow execution run."
},
"deprecated": {
"is_deprecated": false
}
}
}