shopify-api-types
Version:
typings for Shopify Admin API
1,615 lines • 327 kB
JSON
{
"id": 0,
"name": "Shopify API Types",
"kind": 1,
"flags": {},
"children": [
{
"id": 1,
"name": "2021/01",
"kind": 2,
"kindString": "Module",
"flags": {},
"children": [
{
"id": 177,
"name": "AccessScopes",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"comment": {
"shortText": "https://shopify.dev/docs/admin-api/access-scopes"
},
"children": [
{
"id": 189,
"name": "ReadAllOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Abandoned checkouts](https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts)\n* [Customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer)\n* [Fulfillment](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment)\n* [Order](https://shopify.dev/docs/admin-api/rest/reference/orders/order)\n* [Transaction](https://shopify.dev/docs/admin-api/rest/reference/orders/transaction)",
"text": "and grants access to all orders rather than the default window of 60 days worth of orders\n"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 106,
"character": 1
}
],
"defaultValue": "\"read_all_orders\""
},
{
"id": 208,
"name": "ReadAnalytics",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Analytics API](https://shopify.dev/tutorials/get-store-metrics-with-analytics-api)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 211,
"character": 1
}
],
"defaultValue": "\"read_analytics\""
},
{
"id": 200,
"name": "ReadAssignedFulfillmentOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to [Fulfillment Order](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder) resources assigned to a location managed by your [fulfillment service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 168,
"character": 1
}
],
"defaultValue": "\"read_assigned_fulfillment_orders\""
},
{
"id": 211,
"name": "ReadCheckouts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Checkout](https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 228,
"character": 1
}
],
"defaultValue": "\"read_checkouts\""
},
{
"id": 178,
"name": "ReadContent",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Article](https://shopify.dev/docs/admin-api/rest/reference/online-store/article)\n* [Blog](https://shopify.dev/docs/admin-api/rest/reference/online-store/blog)\n* [Comment](https://shopify.dev/docs/admin-api/rest/reference/online-store/comment)\n* [Page](https://shopify.dev/docs/admin-api/rest/reference/online-store/page)\n* [Redirect](https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 13,
"character": 1
}
],
"defaultValue": "\"read_content\""
},
{
"id": 185,
"name": "ReadCustomers",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer)\n* [Saved Search](https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 70,
"character": 1
}
],
"defaultValue": "\"read_customers\""
},
{
"id": 217,
"name": "ReadDiscounts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to GraphQL Admin API [Discounts features](https://shopify.dev/tutorials/create-and-manage-discounts-with-admin-api)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 260,
"character": 1
}
],
"defaultValue": "\"read_discounts\""
},
{
"id": 191,
"name": "ReadDraftOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Draft Order](https://shopify.dev/docs/admin-api/rest/reference/orders/draftorder)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 117,
"character": 1
}
],
"defaultValue": "\"read_draft_orders\""
},
{
"id": 198,
"name": "ReadFulfillments",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Fulfullment Service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 158,
"character": 1
}
],
"defaultValue": "\"read_fulfillments\""
},
{
"id": 193,
"name": "ReadInventory",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Inventory Level](https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel)\n* [Inventory Item](https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 129,
"character": 1
}
],
"defaultValue": "\"read_inventory\""
},
{
"id": 227,
"name": "ReadLocales",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Shop Locale](https://shopify.dev/docs/admin-api/graphql/reference/translations/shoplocale)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 317,
"character": 1
}
],
"defaultValue": "\"read_locales\""
},
{
"id": 195,
"name": "ReadLocations",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Location](https://shopify.dev/docs/admin-api/rest/reference/inventory/location)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 141,
"character": 1
}
],
"defaultValue": "\"read_locations\""
},
{
"id": 219,
"name": "ReadMarketingEvents",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Marketing Event](https://shopify.dev/docs/admin-api/rest/reference/marketingevent)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 270,
"character": 1
}
],
"defaultValue": "\"read_marketing_events\""
},
{
"id": 202,
"name": "ReadMerchantManagedFulfillmentOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to [Fulfillemtn Order](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder) resources assigned to merchant-managed locations"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 177,
"character": 1
}
],
"defaultValue": "\"read_merchant_managed_fulfillment_orders\""
},
{
"id": 187,
"name": "ReadOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Abandoned checkouts](https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts)\n* [Customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer)\n* [Fulfillment](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment)\n* [Order](https://shopify.dev/docs/admin-api/rest/reference/orders/order)\n* [Transaction](https://shopify.dev/docs/admin-api/rest/reference/orders/transaction)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 86,
"character": 1
}
],
"defaultValue": "\"read_orders\""
},
{
"id": 215,
"name": "ReadPriceRules",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Price Rules](https://shopify.dev/docs/admin-api/rest/reference/discounts/pricerule)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 250,
"character": 1
}
],
"defaultValue": "\"read_price_rules\""
},
{
"id": 184,
"name": "ReadProductListings",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Product Listing](https://shopify.dev/docs/admin-api/rest/reference/sales-channels/productlisting)\n* [Collection Listing](https://shopify.dev/docs/admin-api/rest/reference/sales-channels/collectionlisting)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 63,
"character": 1
}
],
"defaultValue": "\"read_product_listings\""
},
{
"id": 182,
"name": "ReadProducts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Product](https://shopify.dev/docs/admin-api/rest/reference/products/product)\n* [Product Variant](https://shopify.dev/docs/admin-api/rest/reference/products/product-variant)\n* [Product Image](https://shopify.dev/docs/admin-api/rest/reference/products/product-image)\n* [Collect](https://shopify.dev/docs/admin-api/rest/reference/products/collect)\n* [Custom Collection](https://shopify.dev/docs/admin-api/rest/reference/products/customcollection)\n* [Smart Collection](https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 46,
"character": 1
}
],
"defaultValue": "\"read_products\""
},
{
"id": 213,
"name": "ReadReports",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Reports](https://shopify.dev/docs/admin-api/rest/reference/analytics/report)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 239,
"character": 1
}
],
"defaultValue": "\"read_reports\""
},
{
"id": 221,
"name": "ReadResourceFeedbacks",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [ResourceFeedback](https://shopify.dev/docs/admin-api/rest/reference/sales-channels/resourcefeedback)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 281,
"character": 1
}
],
"defaultValue": "\"read_resource_feedbacks\""
},
{
"id": 196,
"name": "ReadScriptTags",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Script Tag](https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 147,
"character": 1
}
],
"defaultValue": "\"read_script_tags\""
},
{
"id": 206,
"name": "ReadShipping",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Carrier Service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice)\n* [Country](https://shopify.dev/docs/admin-api/rest/reference/store-properties/country)\n* [Province](https://shopify.dev/docs/admin-api/rest/reference/store-properties/province)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 198,
"character": 1
}
],
"defaultValue": "\"read_shipping\""
},
{
"id": 224,
"name": "ReadShopifyPaymentsDisputes",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Disputes](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/dispute)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 300,
"character": 1
}
],
"defaultValue": "\"read_shopify_payments_disputes\""
},
{
"id": 223,
"name": "ReadShopifyPaymentsPayouts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Payout](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout)\n* [Balance](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/balance)\n* [Transaction](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/transaction)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 294,
"character": 1
}
],
"defaultValue": "\"read_shopify_payments_payouts\""
},
{
"id": 180,
"name": "ReadThemes",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Asset](https://shopify.dev/docs/admin-api/rest/reference/online-store/asset)\n* [Theme](https://shopify.dev/docs/admin-api/rest/reference/online-store/theme)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 29,
"character": 1
}
],
"defaultValue": "\"read_themes\""
},
{
"id": 204,
"name": "ReadThirdPartyFulfillmentOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to [Fulfillment Order]https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder() resources assigned to a location managed by any [fulfillment service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 186,
"character": 1
}
],
"defaultValue": "\"read_third_party_fulfillment_orders\""
},
{
"id": 225,
"name": "ReadTranslations",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Translatable Resouce](https://shopify.dev/docs/admin-api/graphql/reference/translations/translatableresource)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 306,
"character": 1
}
],
"defaultValue": "\"read_translations\""
},
{
"id": 209,
"name": "ReadUsers",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [User]https://shopify.dev/docs/admin-api/rest/reference/plus/user() (Shopify Plus)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 217,
"character": 1
}
],
"defaultValue": "\"read_users\""
},
{
"id": 201,
"name": "WriteAssignedFulfillmentOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to [Fulfillment Order](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder) resources assigned to a location managed by your [fulfillment service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 172,
"character": 1
}
],
"defaultValue": "\"write_assigned_fulfillment_orders\""
},
{
"id": 212,
"name": "WriteCheckouts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Checkout](https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 233,
"character": 1
}
],
"defaultValue": "\"write_checkouts\""
},
{
"id": 179,
"name": "WriteContent",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Article](https://shopify.dev/docs/admin-api/rest/reference/online-store/article)\n* [Blog](https://shopify.dev/docs/admin-api/rest/reference/online-store/blog)\n* [Comment](https://shopify.dev/docs/admin-api/rest/reference/online-store/comment)\n* [Page](https://shopify.dev/docs/admin-api/rest/reference/online-store/page)\n* [Redirect](https://shopify.dev/docs/admin-api/rest/reference/online-store/redirect)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 22,
"character": 1
}
],
"defaultValue": "\"write_content\""
},
{
"id": 186,
"name": "WriteCustomers",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer)\n* [Saved Search](https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 76,
"character": 1
}
],
"defaultValue": "\"write_customers\""
},
{
"id": 218,
"name": "WriteDiscounts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to GraphQL Admin API [Discounts features](https://shopify.dev/tutorials/create-and-manage-discounts-with-admin-api)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 264,
"character": 1
}
],
"defaultValue": "\"write_discounts\""
},
{
"id": 192,
"name": "WriteDraftOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Draft Order](https://shopify.dev/docs/admin-api/rest/reference/orders/draftorder)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 122,
"character": 1
}
],
"defaultValue": "\"write_draft_orders\""
},
{
"id": 199,
"name": "WriteFulfillments",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Fulfullment Service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 163,
"character": 1
}
],
"defaultValue": "\"write_fulfillments\""
},
{
"id": 194,
"name": "WriteInventory",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Inventory Level](https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel)\n* [Inventory Item](https://shopify.dev/docs/admin-api/rest/reference/inventory/inventoryitem)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 135,
"character": 1
}
],
"defaultValue": "\"write_inventory\""
},
{
"id": 228,
"name": "WriteLocales",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Shop Locale](https://shopify.dev/docs/admin-api/graphql/reference/translations/shoplocale)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 322,
"character": 1
}
],
"defaultValue": "\"write_locales\""
},
{
"id": 220,
"name": "WriteMarketingEvents",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Marketing Event](https://shopify.dev/docs/admin-api/rest/reference/marketingevent)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 275,
"character": 1
}
],
"defaultValue": "\"write_marketing_events\""
},
{
"id": 203,
"name": "WriteMerchantManagedFulfillmentOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to [Fulfillemtn Order](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder) resources assigned to merchant-managed locations"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 181,
"character": 1
}
],
"defaultValue": "\"write_merchant_managed_fulfillment_orders\""
},
{
"id": 190,
"name": "WriteOrderEdits",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to GraphQL Admin API [order editing](https://shopify.dev/tutorials/edit-an-existing-order-with-admin-api) features"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 111,
"character": 1
}
],
"defaultValue": "\"write_order_edits\""
},
{
"id": 188,
"name": "WriteOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `read` access to:\n* [Abandoned checkouts](https://shopify.dev/docs/admin-api/rest/reference/orders/abandoned-checkouts)\n* [Customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer)\n* [Fulfillment](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillment)\n* [Order](https://shopify.dev/docs/admin-api/rest/reference/orders/order)\n* [Transaction](https://shopify.dev/docs/admin-api/rest/reference/orders/transaction)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 95,
"character": 1
}
],
"defaultValue": "\"write_orders\""
},
{
"id": 216,
"name": "WritePriceRules",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Price Rules](https://shopify.dev/docs/admin-api/rest/reference/discounts/pricerule)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 255,
"character": 1
}
],
"defaultValue": "\"write_price_rules\""
},
{
"id": 183,
"name": "WriteProducts",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Product](https://shopify.dev/docs/admin-api/rest/reference/products/product)\n* [Product Variant](https://shopify.dev/docs/admin-api/rest/reference/products/product-variant)\n* [Product Image](https://shopify.dev/docs/admin-api/rest/reference/products/product-image)\n* [Collect](https://shopify.dev/docs/admin-api/rest/reference/products/collect)\n* [Custom Collection](https://shopify.dev/docs/admin-api/rest/reference/products/customcollection)\n* [Smart Collection](https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 56,
"character": 1
}
],
"defaultValue": "\"write_products\""
},
{
"id": 214,
"name": "WriteReports",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Reports](https://shopify.dev/docs/admin-api/rest/reference/analytics/report)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 244,
"character": 1
}
],
"defaultValue": "\"write_reports\""
},
{
"id": 222,
"name": "WriteResourceFeedbacks",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [ResourceFeedback](https://shopify.dev/docs/admin-api/rest/reference/sales-channels/resourcefeedback)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 286,
"character": 1
}
],
"defaultValue": "\"write_resource_feedbacks\""
},
{
"id": 197,
"name": "WriteScriptTags",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Script Tag](https://shopify.dev/docs/admin-api/rest/reference/online-store/scripttag)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 152,
"character": 1
}
],
"defaultValue": "\"write_script_tags\""
},
{
"id": 207,
"name": "WriteShipping",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Carrier Service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/carrierservice)\n* [Country](https://shopify.dev/docs/admin-api/rest/reference/store-properties/country)\n* [Province](https://shopify.dev/docs/admin-api/rest/reference/store-properties/province)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 205,
"character": 1
}
],
"defaultValue": "\"write_shipping\""
},
{
"id": 181,
"name": "WriteThemes",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Asset](https://shopify.dev/docs/admin-api/rest/reference/online-store/asset)\n* [Theme](https://shopify.dev/docs/admin-api/rest/reference/online-store/theme)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 35,
"character": 1
}
],
"defaultValue": "\"write_themes\""
},
{
"id": 205,
"name": "WriteThirdPartyFulfillmentOrders",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to [Fulfillment Order](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentorder) resources assigned to a location managed by any [fulfillment service](https://shopify.dev/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 190,
"character": 1
}
],
"defaultValue": "\"write_third_party_fulfillment_orders\""
},
{
"id": 226,
"name": "WriteTranslations",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [Translatable Resouce](https://shopify.dev/docs/admin-api/graphql/reference/translations/translatableresource)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 311,
"character": 1
}
],
"defaultValue": "\"write_translations\""
},
{
"id": 210,
"name": "WriteUsers",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Grants `write` access to:\n* [User](https://shopify.dev/docs/admin-api/rest/reference/plus/user) (Shopify Plus)"
},
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 222,
"character": 1
}
],
"defaultValue": "\"write_users\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
189,
208,
200,
211,
178,
185,
217,
191,
198,
193,
227,
195,
219,
202,
187,
215,
184,
182,
213,
221,
196,
206,
224,
223,
180,
204,
225,
209,
201,
212,
179,
186,
218,
192,
199,
194,
228,
220,
203,
190,
188,
216,
183,
214,
222,
197,
207,
181,
205,
226,
210
]
}
],
"sources": [
{
"fileName": "2021/01/payloads/access.ts",
"line": 4,
"character": 12
}
]
},
{
"id": 339,
"name": "ApplicationChargeStatus",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 341,
"name": "Active",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The application charge has been activated by the app and will be paid out to the Partner"
},
"sources": [
{
"fileName": "2021/01/payloads/billing.ts",
"line": 11,
"character": 1
}
],
"defaultValue": "\"active\""
},
{
"id": 342,
"name": "Declined",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The application charge was declined by the merchant"
},
"sources": [
{
"fileName": "2021/01/payloads/billing.ts",
"line": 15,
"character": 1
}
],
"defaultValue": "\"declined\""
},
{
"id": 343,
"name": "Expired",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The application charge was not accepted within two days of being created"
},
"sources": [
{
"fileName": "2021/01/payloads/billing.ts",
"line": 19,
"character": 1
}
],
"defaultValue": "\"expired\""
},
{
"id": 340,
"name": "Pending",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The application charge is pending approval by the merchant"
},
"sources": [
{
"fileName": "2021/01/payloads/billing.ts",
"line": 7,
"character": 1
}
],
"defaultValue": "\"pending\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
341,
342,
343,
340
]
}
],
"sources": [
{
"fileName": "2021/01/payloads/billing.ts",
"line": 3,
"character": 12
}
]
},
{
"id": 244,
"name": "CustomerAccountState",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 248,
"name": "Declined",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The customer declined the email invite to crate an account"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 20,
"character": 1
}
],
"defaultValue": "\"declined\""
},
{
"id": 245,
"name": "Disabled",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The customer doesn't have an active account"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 8,
"character": 1
}
],
"defaultValue": "\"disabled\""
},
{
"id": 247,
"name": "Enabled",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The customer has crated an account"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 16,
"character": 1
}
],
"defaultValue": "\"enabled\""
},
{
"id": 246,
"name": "Invited",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "The customer has recieved an email to create an account"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 12,
"character": 1
}
],
"defaultValue": "\"invited\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
248,
245,
247,
246
]
}
],
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 4,
"character": 12
}
]
},
{
"id": 317,
"name": "CustomerSavedSearchQueries",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"comment": {
"shortText": "https://shopify.dev/docs/admin-api/rest/reference/customers/customersavedsearch#customer-saved-search-queries-2020-04"
},
"children": [
{
"id": 318,
"name": "AcceptsMarketing",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Filters customers by whether they accept email marketing.\n0 = doesn't accept\n1 = accepts"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 309,
"character": 1
}
],
"defaultValue": "\"accepts_marketing\""
},
{
"id": 319,
"name": "Country",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Retrieves customers from a specified country"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 313,
"character": 1
}
],
"defaultValue": "\"country\""
},
{
"id": 320,
"name": "CustomerDate",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Retrieves customers who were created within a set period of time:",
"text": "\t* `past_week`: Return customers who were created in the last week.\n\t* `past_month`: Return customers who were created in the last month.\n\t* `last_3_months`: Return customers who were created in the last 3 months.\n\t* `past_quarter`: Return customers who were created in the last quarter.\n\t* `past_year`: Return customers who were created in the last year.\n\t* `yyyy-m-d`: Return customers who were created on a set date.\n\t* `>yyyy-m-d`: Return customers who were created after a set date.\n\t* `<yyyy-m-d`: Return customers who were created before a set date.\n"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 326,
"character": 1
}
],
"defaultValue": "\"customer_date\""
},
{
"id": 321,
"name": "LastAbandonedOrderDate",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Retrieves customers who abandoned a cart within a set period of time:",
"text": "* `last_week`: Returns customers who abandoned a cart in the last week\n* `last_month`: Returns customers who abandoned a cart within the last month\n"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 333,
"character": 1
}
],
"defaultValue": "\"last_abandoned_order_date\""
},
{
"id": 322,
"name": "OrderDate",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Retrieves customers who placed an order within a set period of time:",
"text": "\t* `last_week`: Return customers who placed an order in the last week.\n\t* `last_month`: Return customers who placed an order in the last month.\n\t* `last_3_months`: Return customers who placed an order in the last 3 months.\n\t* `last_year`: Return customers who placed an order in the last year.\n\t* `>yyyy-m-d`: Return customers who placed an order after a set date.\n\t* `<yyyy-m-d`: Return customers placed an order before a set date.\n"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 344,
"character": 1
}
],
"defaultValue": "\"order_date\""
},
{
"id": 323,
"name": "OrdersCount",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Retreives customers by the number of orders they've placed with the store:",
"text": "* `>number_of_orders`: Returns customers who have placed fewer than the specified number of orders\n* `<number_of_orders`: Returns customers who have placed more than the specified number of orders\n* `number_of_orders`: Returns customers who have placed the specified number of orders\n"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 352,
"character": 1
}
],
"defaultValue": "\"orders_count\""
},
{
"id": 324,
"name": "Status",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Filter customers by their customer account status:",
"text": "* `declined`: Returns customers who have been invited to create an account but declined\n* `disabled`: Returns customers whose account is disabled\n* `enabled`: Returns customers who have a customer account\n* `invited`: Returns customers who have been invited to create an account\n"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 361,
"character": 1
}
],
"defaultValue": "\"status\""
},
{
"id": 325,
"name": "Tag",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Filter customers by tag. Valid values are any existing customer tag contained in quotation marks:",
"tags": [
{
"tag": "example",
"text": "`\"Big Spender\"`\n"
}
]
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 366,
"character": 1
}
],
"defaultValue": "\"tag\""
},
{
"id": 326,
"name": "TotalSpent",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "Retreives customers by the total amount that they have spent across all of their orders:",
"text": "* `>money_amount`: Returns customers who have spent less than the specified amount of money\n* `<money_amount`: Returns customers who have spent more than the specified amount of money\n* `money_amount`: Returns customers who have spent the specified amount of money\n"
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 374,
"character": 1
}
],
"defaultValue": "\"total_spent\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
318,
319,
320,
321,
322,
323,
324,
325,
326
]
}
],
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 303,
"character": 12
}
]
},
{
"id": 249,
"name": "CustomerTaxExceptions",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 256,
"name": "CABCCommercialFisheryExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 57,
"character": 1
}
],
"defaultValue": "\"CA_BC_COMMERCIAL_FISHERY_EXEMPTION\""
},
{
"id": 265,
"name": "CABCContractorExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 102,
"character": 1
}
],
"defaultValue": "\"CA_BC_CONTRACTOR_EXEMPTION\""
},
{
"id": 261,
"name": "CABCProductionAndMachineryExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 82,
"character": 1
}
],
"defaultValue": "\"CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION\""
},
{
"id": 253,
"name": "CABCResellerExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 42,
"character": 1
}
],
"defaultValue": "\"CA_BC_RESELLER_EXEMPTION\""
},
{
"id": 263,
"name": "CABCSubContractorExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 92,
"character": 1
}
],
"defaultValue": "\"CA_BC_SUB_CONTRACTOR_EXEMPTION\""
},
{
"id": 252,
"name": "CADiplomatExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 37,
"character": 1
}
],
"defaultValue": "\"CA_DIPLOMAT_EXEMPTION\""
},
{
"id": 257,
"name": "CAMBCommercialFisheryExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 62,
"character": 1
}
],
"defaultValue": "\"CA_MB_COMMERCIAL_FISHERY_EXEMPTION\""
},
{
"id": 268,
"name": "CAMBFarmerExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 117,
"character": 1
}
],
"defaultValue": "\"CA_MB_FARMER_EXEMPTION\""
},
{
"id": 254,
"name": "CAMBResellerExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 47,
"character": 1
}
],
"defaultValue": "\"CA_MB_RESELLER_EXEMPTION\""
},
{
"id": 258,
"name": "CANSCommercialFisheryExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia."
},
"sources": [
{
"fileName": "2021/01/payloads/customer.ts",
"line": 67,
"character": 1
}
],
"defaultValue": "\"CA_NS_COMMERCIAL_FISHERY_EXEMPTION\""
},
{
"id": 269,
"name": "CANSFarmerExemption",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"comment": {
"shortText": "This customer is exempt from specific taxes for holding a valid FA