asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
a8df528c65747270facb2ee7c3e434f06c0a6c33
medusa-store/www/apps/resources/generated/sidebar.mjs
Shahed Nasser a8df528c65 docs: add a need help button (#8069) 
* docs: add a need help button

* change github issue link

* responsive fixes
2024-07-11 10:29:13 +03:00

8217 lines
306 KiB
JavaScript
Raw Blame History

export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"path": "/",
"title": "Overview",
"hasTitleStyling": true,
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules",
"title": "Commerce Modules",
"isChildSidebar": true,
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/api-key",
"title": "API Key Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/api-key/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/api-key/concepts",
"title": "API Key Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/api-key/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "API Key Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/api_key/IApiKeyModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/authenticate",
"title": "authenticate",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/createApiKeys",
"title": "createApiKeys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/deleteApiKeys",
"title": "deleteApiKeys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/listAndCountApiKeys",
"title": "listAndCountApiKeys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/listApiKeys",
"title": "listApiKeys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/retrieveApiKey",
"title": "retrieveApiKey",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/revoke",
"title": "revoke",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/updateApiKeys",
"title": "updateApiKeys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/upsertApiKeys",
"title": "upsertApiKeys",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "API Key Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/api_key_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/api-key/models/ApiKey",
"title": "ApiKey",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth",
"title": "Auth Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/module-options",
"title": "Module Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/auth-identity-and-actor-types",
"title": "Identity and Actor Types",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/auth-providers",
"title": "Auth Providers",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/auth-providers/emailpass",
"title": "Emailpass Auth Provider Module",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/authentication-route",
"title": "Authentication Route",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/auth-flows",
"title": "Auth Flows",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/create-actor-type",
"title": "Create an Actor Type",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/provider",
"title": "Create Auth Provider Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Auth Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/auth/IAuthModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/authenticate",
"title": "authenticate",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/createAuthIdentities",
"title": "createAuthIdentities",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/deleteAuthIdentities",
"title": "deleteAuthIdentities",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/listAndCountAuthIdentities",
"title": "listAndCountAuthIdentities",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/listAuthIdentities",
"title": "listAuthIdentities",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/retrieveAuthIdentity",
"title": "retrieveAuthIdentity",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/updateAuthIdentites",
"title": "updateAuthIdentites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/validateCallback",
"title": "validateCallback",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Auth Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/auth_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/models/AuthIdentity",
"title": "AuthIdentity",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/auth/models/ProviderIdentity",
"title": "ProviderIdentity",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart",
"title": "Cart Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart/concepts",
"title": "Cart Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart/promotions",
"title": "Promotion Adjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart/tax-lines",
"title": "Tax Lines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart/relations-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Cart Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/cart/ICartModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/addLineItemAdjustments",
"title": "addLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/addLineItemTaxLines",
"title": "addLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/addLineItems",
"title": "addLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/addShippingMethodAdjustments",
"title": "addShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/addShippingMethodTaxLines",
"title": "addShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/addShippingMethods",
"title": "addShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/createAddresses",
"title": "createAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/createCarts",
"title": "createCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteAddresses",
"title": "deleteAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteCarts",
"title": "deleteCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteLineItemAdjustments",
"title": "deleteLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteLineItemTaxLines",
"title": "deleteLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteLineItems",
"title": "deleteLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteShippingMethodAdjustments",
"title": "deleteShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteShippingMethodTaxLines",
"title": "deleteShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/deleteShippingMethods",
"title": "deleteShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listAddresses",
"title": "listAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listAndCountCarts",
"title": "listAndCountCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listCarts",
"title": "listCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listLineItemAdjustments",
"title": "listLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listLineItemTaxLines",
"title": "listLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listLineItems",
"title": "listLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listShippingMethodAdjustments",
"title": "listShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listShippingMethodTaxLines",
"title": "listShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/listShippingMethods",
"title": "listShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreAddresses",
"title": "restoreAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreCarts",
"title": "restoreCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreLineItemAdjustments",
"title": "restoreLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreLineItemTaxLines",
"title": "restoreLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreLineItems",
"title": "restoreLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreShippingMethodAdjustments",
"title": "restoreShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreShippingMethodTaxLines",
"title": "restoreShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/restoreShippingMethods",
"title": "restoreShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/retrieveCart",
"title": "retrieveCart",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/retrieveLineItem",
"title": "retrieveLineItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/setLineItemAdjustments",
"title": "setLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/setLineItemTaxLines",
"title": "setLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/setShippingMethodAdjustments",
"title": "setShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/setShippingMethodTaxLines",
"title": "setShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteAddresses",
"title": "softDeleteAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteCarts",
"title": "softDeleteCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteLineItemAdjustments",
"title": "softDeleteLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteLineItemTaxLines",
"title": "softDeleteLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteLineItems",
"title": "softDeleteLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteShippingMethodAdjustments",
"title": "softDeleteShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteShippingMethodTaxLines",
"title": "softDeleteShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/softDeleteShippingMethods",
"title": "softDeleteShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/updateAddresses",
"title": "updateAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/updateCarts",
"title": "updateCarts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/updateLineItems",
"title": "updateLineItems",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Cart Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/cart_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/Address",
"title": "Address",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/Cart",
"title": "Cart",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/LineItem",
"title": "LineItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/LineItemAdjustment",
"title": "LineItemAdjustment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/LineItemTaxLine",
"title": "LineItemTaxLine",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/ShippingMethod",
"title": "ShippingMethod",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/ShippingMethodAdjustment",
"title": "ShippingMethodAdjustment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/cart/models/ShippingMethodTaxLine",
"title": "ShippingMethodTaxLine",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/currency",
"title": "Currency Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/currency/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/currency/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Cart Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/currency/ICurrencyModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/listAndCountCurrencies",
"title": "listAndCountCurrencies",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/listCurrencies",
"title": "listCurrencies",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/retrieveCurrency",
"title": "retrieveCurrency",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Currency Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/currency_models/variables",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/models/Currency",
"title": "Currency",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/customer",
"title": "Customer Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/customer/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/customer/customer-accounts",
"title": "Customer Accounts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/customer/relations-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Customer Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/customer/ICustomerModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/addCustomerToGroup",
"title": "addCustomerToGroup",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/createAddresses",
"title": "createAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/createCustomerGroups",
"title": "createCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/createCustomers",
"title": "createCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/deleteAddresses",
"title": "deleteAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/deleteCustomerGroups",
"title": "deleteCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/deleteCustomers",
"title": "deleteCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listAddresses",
"title": "listAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listAndCountAddresses",
"title": "listAndCountAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listAndCountCustomerGroups",
"title": "listAndCountCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listAndCountCustomers",
"title": "listAndCountCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listCustomerGroupCustomers",
"title": "listCustomerGroupCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listCustomerGroups",
"title": "listCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/listCustomers",
"title": "listCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/removeCustomerFromGroup",
"title": "removeCustomerFromGroup",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/restoreCustomerGroups",
"title": "restoreCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/restoreCustomers",
"title": "restoreCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/retrieveCustomer",
"title": "retrieveCustomer",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/retrieveCustomerGroup",
"title": "retrieveCustomerGroup",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/softDeleteCustomerGroups",
"title": "softDeleteCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/softDeleteCustomers",
"title": "softDeleteCustomers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/updateAddresses",
"title": "updateAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/updateCustomerGroups",
"title": "updateCustomerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/updateCustomers",
"title": "updateCustomers",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Customer Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/customer_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/models/Address",
"title": "Address",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/models/Customer",
"title": "Customer",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/models/CustomerGroup",
"title": "CustomerGroup",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/customer/models/CustomerGroupCustomer",
"title": "CustomerGroupCustomer",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment",
"title": "Fulfillment Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/module-options",
"title": "Module Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/concepts",
"title": "Fulfillment Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/fulfillment-provider",
"title": "Fulfillment Provider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/shipping-option",
"title": "Shipping Option",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/item-fulfillment",
"title": "Item Fulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/relations-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/provider",
"title": "Create Fulfillment Provider Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Fulfillment Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/fulfillment/IFulfillmentModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/cancelFulfillment",
"title": "cancelFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createFulfillment",
"title": "createFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createFulfillmentSets",
"title": "createFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createGeoZones",
"title": "createGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createReturnFulfillment",
"title": "createReturnFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createServiceZones",
"title": "createServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createShippingOptionRules",
"title": "createShippingOptionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createShippingOptions",
"title": "createShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/createShippingProfiles",
"title": "createShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteFulfillmentSets",
"title": "deleteFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteGeoZones",
"title": "deleteGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteServiceZones",
"title": "deleteServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteShippingOptionRules",
"title": "deleteShippingOptionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteShippingOptionTypes",
"title": "deleteShippingOptionTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteShippingOptions",
"title": "deleteShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/deleteShippingProfiles",
"title": "deleteShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountFulfillmentSets",
"title": "listAndCountFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountFulfillments",
"title": "listAndCountFulfillments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountGeoZones",
"title": "listAndCountGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountServiceZones",
"title": "listAndCountServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountShippingOptionRules",
"title": "listAndCountShippingOptionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountShippingOptionTypes",
"title": "listAndCountShippingOptionTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountShippingOptions",
"title": "listAndCountShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listAndCountShippingProfiles",
"title": "listAndCountShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listFulfillmentProviders",
"title": "listFulfillmentProviders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listFulfillmentSets",
"title": "listFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listFulfillments",
"title": "listFulfillments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listGeoZones",
"title": "listGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listServiceZones",
"title": "listServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listShippingOptionRules",
"title": "listShippingOptionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listShippingOptionTypes",
"title": "listShippingOptionTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listShippingOptions",
"title": "listShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listShippingOptionsForContext",
"title": "listShippingOptionsForContext",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/listShippingProfiles",
"title": "listShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/restoreFulfillmentSets",
"title": "restoreFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/restoreGeoZones",
"title": "restoreGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/restoreServiceZones",
"title": "restoreServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/restoreShippingOptions",
"title": "restoreShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/restoreShippingProfiles",
"title": "restoreShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveFulfillment",
"title": "retrieveFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveFulfillmentOptions",
"title": "retrieveFulfillmentOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveFulfillmentSet",
"title": "retrieveFulfillmentSet",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveGeoZone",
"title": "retrieveGeoZone",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveServiceZone",
"title": "retrieveServiceZone",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveShippingOption",
"title": "retrieveShippingOption",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveShippingOptionRule",
"title": "retrieveShippingOptionRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveShippingOptionType",
"title": "retrieveShippingOptionType",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/retrieveShippingProfile",
"title": "retrieveShippingProfile",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/softDeleteFulfillmentSets",
"title": "softDeleteFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/softDeleteGeoZones",
"title": "softDeleteGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/softDeleteServiceZones",
"title": "softDeleteServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/softDeleteShippingOptions",
"title": "softDeleteShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/softDeleteShippingProfiles",
"title": "softDeleteShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateFulfillment",
"title": "updateFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateFulfillmentSets",
"title": "updateFulfillmentSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateGeoZones",
"title": "updateGeoZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateServiceZones",
"title": "updateServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateShippingOptionRules",
"title": "updateShippingOptionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateShippingOptions",
"title": "updateShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/updateShippingProfiles",
"title": "updateShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/upsertServiceZones",
"title": "upsertServiceZones",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/upsertShippingOptions",
"title": "upsertShippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/upsertShippingProfiles",
"title": "upsertShippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/validateFulfillmentOption",
"title": "validateFulfillmentOption",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/validateShippingOption",
"title": "validateShippingOption",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Fulfillment Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/fulfillment_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/Address",
"title": "Address",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/Fulfillment",
"title": "Fulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/FulfillmentItem",
"title": "FulfillmentItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/FulfillmentLabel",
"title": "FulfillmentLabel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/FulfillmentProvider",
"title": "FulfillmentProvider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/FulfillmentSet",
"title": "FulfillmentSet",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/GeoZone",
"title": "GeoZone",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/ServiceZone",
"title": "ServiceZone",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/ShippingOption",
"title": "ShippingOption",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/ShippingOptionRule",
"title": "ShippingOptionRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/ShippingOptionType",
"title": "ShippingOptionType",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/fulfillment/models/ShippingProfile",
"title": "ShippingProfile",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/inventory",
"title": "Inventory Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/inventory/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/inventory/concepts",
"title": "Inventory Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/inventory/inventory-in-flows",
"title": "Inventory in Flows",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/inventory/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory_next",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Inventory Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/inventory_next/IInventoryService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/adjustInventory",
"title": "adjustInventory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/confirmInventory",
"title": "confirmInventory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/createInventoryItems",
"title": "createInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/createInventoryLevels",
"title": "createInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/createReservationItems",
"title": "createReservationItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteInventoryItemLevelByLocationId",
"title": "deleteInventoryItemLevelByLocationId",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteInventoryItems",
"title": "deleteInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteInventoryLevel",
"title": "deleteInventoryLevel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteInventoryLevels",
"title": "deleteInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteReservationItemByLocationId",
"title": "deleteReservationItemByLocationId",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteReservationItems",
"title": "deleteReservationItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/deleteReservationItemsByLineItem",
"title": "deleteReservationItemsByLineItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/listAndCountInventoryItems",
"title": "listAndCountInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/listAndCountInventoryLevels",
"title": "listAndCountInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/listAndCountReservationItems",
"title": "listAndCountReservationItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/listInventoryItems",
"title": "listInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/listInventoryLevels",
"title": "listInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/listReservationItems",
"title": "listReservationItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/restoreInventoryItems",
"title": "restoreInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/restoreInventoryLevels",
"title": "restoreInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/restoreReservationItems",
"title": "restoreReservationItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/restoreReservationItemsByLineItem",
"title": "restoreReservationItemsByLineItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveAvailableQuantity",
"title": "retrieveAvailableQuantity",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveInventoryItem",
"title": "retrieveInventoryItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveInventoryLevel",
"title": "retrieveInventoryLevel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveInventoryLevelByItemAndLocation",
"title": "retrieveInventoryLevelByItemAndLocation",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveReservationItem",
"title": "retrieveReservationItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveReservedQuantity",
"title": "retrieveReservedQuantity",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/retrieveStockedQuantity",
"title": "retrieveStockedQuantity",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/softDeleteInventoryItems",
"title": "softDeleteInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/softDeleteInventoryLevels",
"title": "softDeleteInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/softDeleteReservationItems",
"title": "softDeleteReservationItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/updateInventoryItems",
"title": "updateInventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/updateInventoryLevels",
"title": "updateInventoryLevels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/updateReservationItems",
"title": "updateReservationItems",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory_next/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Inventory Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/inventory_next_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/models/InventoryItem",
"title": "InventoryItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/models/InventoryLevel",
"title": "InventoryLevel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/inventory-next/models/ReservationItem",
"title": "ReservationItem",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order",
"title": "Order Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/concepts",
"title": "Order Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/promotion-adjustments",
"title": "Promotions Adjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/tax-lines",
"title": "Tax Lines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/transactions",
"title": "Transactions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/order-versioning",
"title": "Order Versioning",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/return",
"title": "Return",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/exchange",
"title": "Exchange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/claim",
"title": "Claim",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/relations-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/order",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Order Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/order/IOrderModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/addOrderAction",
"title": "addOrderAction",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/addTransactions",
"title": "addTransactions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/applyPendingOrderActions",
"title": "applyPendingOrderActions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/archive",
"title": "archive",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancel",
"title": "cancel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelClaim",
"title": "cancelClaim",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelExchange",
"title": "cancelExchange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelFulfillment",
"title": "cancelFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelOrderChange",
"title": "cancelOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/cancelReturn",
"title": "cancelReturn",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/completeOrder",
"title": "completeOrder",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/confirmOrderChange",
"title": "confirmOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createAddresses",
"title": "createAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createClaim",
"title": "createClaim",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createExchange",
"title": "createExchange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createLineItemAdjustments",
"title": "createLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createLineItemTaxLines",
"title": "createLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createLineItems",
"title": "createLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createOrderChange",
"title": "createOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createOrders",
"title": "createOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createReturn",
"title": "createReturn",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createReturnReasons",
"title": "createReturnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createShippingMethodAdjustments",
"title": "createShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createShippingMethodTaxLines",
"title": "createShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/createShippingMethods",
"title": "createShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/declineOrderChange",
"title": "declineOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteAddresses",
"title": "deleteAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteLineItemAdjustments",
"title": "deleteLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteLineItemTaxLines",
"title": "deleteLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteLineItems",
"title": "deleteLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteOrderChanges",
"title": "deleteOrderChanges",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteOrders",
"title": "deleteOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteReturnReasons",
"title": "deleteReturnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteShippingMethodAdjustments",
"title": "deleteShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteShippingMethodTaxLines",
"title": "deleteShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteShippingMethods",
"title": "deleteShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/deleteTransactions",
"title": "deleteTransactions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listAddresses",
"title": "listAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listAndCountOrderClaims",
"title": "listAndCountOrderClaims",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listAndCountOrderExchanges",
"title": "listAndCountOrderExchanges",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listAndCountOrders",
"title": "listAndCountOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listAndCountReturns",
"title": "listAndCountReturns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listLineItemAdjustments",
"title": "listLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listLineItemTaxLines",
"title": "listLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listLineItems",
"title": "listLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listOrderClaims",
"title": "listOrderClaims",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listOrderExchanges",
"title": "listOrderExchanges",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listOrders",
"title": "listOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listReturnReasons",
"title": "listReturnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listReturns",
"title": "listReturns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listShippingMethodAdjustments",
"title": "listShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listShippingMethodTaxLines",
"title": "listShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listShippingMethods",
"title": "listShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/listTransactions",
"title": "listTransactions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/previewOrderChange",
"title": "previewOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/receiveReturn",
"title": "receiveReturn",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/registerFulfillment",
"title": "registerFulfillment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/registerShipment",
"title": "registerShipment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreAddresses",
"title": "restoreAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreLineItemAdjustments",
"title": "restoreLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreLineItemTaxLines",
"title": "restoreLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreLineItems",
"title": "restoreLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreOrderChanges",
"title": "restoreOrderChanges",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreOrders",
"title": "restoreOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreReturnReasons",
"title": "restoreReturnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreShippingMethodAdjustments",
"title": "restoreShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreShippingMethodTaxLines",
"title": "restoreShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreShippingMethods",
"title": "restoreShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/restoreTransactions",
"title": "restoreTransactions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveLineItem",
"title": "retrieveLineItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveOrder",
"title": "retrieveOrder",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveOrderChange",
"title": "retrieveOrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveOrderClaim",
"title": "retrieveOrderClaim",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveOrderExchange",
"title": "retrieveOrderExchange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveReturn",
"title": "retrieveReturn",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/retrieveReturnReason",
"title": "retrieveReturnReason",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/revertLastVersion",
"title": "revertLastVersion",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/setLineItemAdjustments",
"title": "setLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/setLineItemTaxLines",
"title": "setLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/setShippingMethodAdjustments",
"title": "setShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/setShippingMethodTaxLines",
"title": "setShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteAddresses",
"title": "softDeleteAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteLineItemAdjustments",
"title": "softDeleteLineItemAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteLineItemTaxLines",
"title": "softDeleteLineItemTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteLineItems",
"title": "softDeleteLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteOrderChanges",
"title": "softDeleteOrderChanges",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteOrders",
"title": "softDeleteOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteReturnReasons",
"title": "softDeleteReturnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteShippingMethodAdjustments",
"title": "softDeleteShippingMethodAdjustments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteShippingMethodTaxLines",
"title": "softDeleteShippingMethodTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteShippingMethods",
"title": "softDeleteShippingMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/softDeleteTransactions",
"title": "softDeleteTransactions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateAddresses",
"title": "updateAddresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateLineItems",
"title": "updateLineItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateOrderChanges",
"title": "updateOrderChanges",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateOrderItem",
"title": "updateOrderItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateOrders",
"title": "updateOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/updateReturnReasons",
"title": "updateReturnReasons",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Order Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/order_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/Address",
"title": "Address",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ClaimItem",
"title": "ClaimItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ClaimItemImage",
"title": "ClaimItemImage",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ExchangeItem",
"title": "ExchangeItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/LineItem",
"title": "LineItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/LineItemAdjustment",
"title": "LineItemAdjustment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/LineItemTaxLine",
"title": "LineItemTaxLine",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/Order",
"title": "Order",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderChange",
"title": "OrderChange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderChangeAction",
"title": "OrderChangeAction",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderClaim",
"title": "OrderClaim",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderExchange",
"title": "OrderExchange",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderItem",
"title": "OrderItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderShippingMethod",
"title": "OrderShippingMethod",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/OrderSummary",
"title": "OrderSummary",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/Return",
"title": "Return",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ReturnItem",
"title": "ReturnItem",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ReturnReason",
"title": "ReturnReason",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ShippingMethod",
"title": "ShippingMethod",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ShippingMethodAdjustment",
"title": "ShippingMethodAdjustment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/ShippingMethodTaxLine",
"title": "ShippingMethodTaxLine",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/order/models/Transaction",
"title": "Transaction",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment",
"title": "Payment Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/module-options",
"title": "Module Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-collection",
"title": "Payment Collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-session",
"title": "Payment Session",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment",
"title": "Payment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-provider",
"title": "Payment Provider Module",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-provider/stripe",
"title": "Stripe",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/webhook-events",
"title": "Webhook Events",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/relation-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-flow",
"title": "Accept Payment Flow",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/provider",
"title": "Payment Provider Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Payment Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/payment/IPaymentModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/authorizePaymentSession",
"title": "authorizePaymentSession",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/cancelPayment",
"title": "cancelPayment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/capturePayment",
"title": "capturePayment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/completePaymentCollections",
"title": "completePaymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/createPaymentCollections",
"title": "createPaymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/createPaymentSession",
"title": "createPaymentSession",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/deletePaymentCollections",
"title": "deletePaymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/deletePaymentSession",
"title": "deletePaymentSession",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listAndCountPaymentCollections",
"title": "listAndCountPaymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listAndCountPaymentProviders",
"title": "listAndCountPaymentProviders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listCaptures",
"title": "listCaptures",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listPaymentCollections",
"title": "listPaymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listPaymentProviders",
"title": "listPaymentProviders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listPaymentSessions",
"title": "listPaymentSessions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listPayments",
"title": "listPayments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/listRefunds",
"title": "listRefunds",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/processEvent",
"title": "processEvent",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/refundPayment",
"title": "refundPayment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/retrievePaymentCollection",
"title": "retrievePaymentCollection",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/retrievePaymentSession",
"title": "retrievePaymentSession",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/updatePayment",
"title": "updatePayment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/updatePaymentCollections",
"title": "updatePaymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/updatePaymentSession",
"title": "updatePaymentSession",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/upsertPaymentCollections",
"title": "upsertPaymentCollections",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Payment Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/payment_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/Capture",
"title": "Capture",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/Payment",
"title": "Payment",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/PaymentCollection",
"title": "PaymentCollection",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/PaymentMethodToken",
"title": "PaymentMethodToken",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/PaymentProvider",
"title": "PaymentProvider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/PaymentSession",
"title": "PaymentSession",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/payment/models/Refund",
"title": "Refund",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing",
"title": "Pricing Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/concepts",
"title": "Pricing Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/price-rules",
"title": "Price Rules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/price-calculation",
"title": "Prices Calculation",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Pricing Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/pricing/IPricingModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/addPriceListPrices",
"title": "addPriceListPrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/addPrices",
"title": "addPrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/calculatePrices",
"title": "calculatePrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/createPriceLists",
"title": "createPriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/createPricePreferences",
"title": "createPricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/createPriceRules",
"title": "createPriceRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/createPriceSets",
"title": "createPriceSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/deletePriceListRules",
"title": "deletePriceListRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/deletePriceLists",
"title": "deletePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/deletePricePreferences",
"title": "deletePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/deletePriceRules",
"title": "deletePriceRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/deletePriceSets",
"title": "deletePriceSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listAndCountPriceListRules",
"title": "listAndCountPriceListRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listAndCountPriceLists",
"title": "listAndCountPriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listAndCountPriceRules",
"title": "listAndCountPriceRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listAndCountPriceSets",
"title": "listAndCountPriceSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listAndCountPrices",
"title": "listAndCountPrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPriceListRules",
"title": "listPriceListRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPriceLists",
"title": "listPriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPricePreferences",
"title": "listPricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPriceRules",
"title": "listPriceRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPriceSets",
"title": "listPriceSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/listPrices",
"title": "listPrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/removePriceListRules",
"title": "removePriceListRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/removePrices",
"title": "removePrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/restorePriceLists",
"title": "restorePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/restorePricePreferences",
"title": "restorePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/restorePrices",
"title": "restorePrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/retrievePriceList",
"title": "retrievePriceList",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/retrievePriceListRule",
"title": "retrievePriceListRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/retrievePricePreference",
"title": "retrievePricePreference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/retrievePriceRule",
"title": "retrievePriceRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/retrievePriceSet",
"title": "retrievePriceSet",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/setPriceListRules",
"title": "setPriceListRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/softDeletePriceLists",
"title": "softDeletePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/softDeletePricePreferences",
"title": "softDeletePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/softDeletePrices",
"title": "softDeletePrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/updatePriceListPrices",
"title": "updatePriceListPrices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/updatePriceLists",
"title": "updatePriceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/updatePricePreferences",
"title": "updatePricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/updatePriceRules",
"title": "updatePriceRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/updatePriceSets",
"title": "updatePriceSets",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/upsertPricePreferences",
"title": "upsertPricePreferences",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/upsertPriceSets",
"title": "upsertPriceSets",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Pricing Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/pricing_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/Price",
"title": "Price",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/PriceList",
"title": "PriceList",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/PriceListRule",
"title": "PriceListRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/PricePreference",
"title": "PricePreference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/PriceRule",
"title": "PriceRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/pricing/models/PriceSet",
"title": "PriceSet",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/product",
"title": "Product Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/product/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/product/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/product",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Product Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/product/IProductModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProductCategories",
"title": "createProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProductCollections",
"title": "createProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProductOptions",
"title": "createProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProductTags",
"title": "createProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProductTypes",
"title": "createProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProductVariants",
"title": "createProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/createProducts",
"title": "createProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProductCategories",
"title": "deleteProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProductCollections",
"title": "deleteProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProductOptions",
"title": "deleteProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProductTags",
"title": "deleteProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProductTypes",
"title": "deleteProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProductVariants",
"title": "deleteProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/deleteProducts",
"title": "deleteProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProductCategories",
"title": "listAndCountProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProductCollections",
"title": "listAndCountProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProductOptions",
"title": "listAndCountProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProductTags",
"title": "listAndCountProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProductTypes",
"title": "listAndCountProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProductVariants",
"title": "listAndCountProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listAndCountProducts",
"title": "listAndCountProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProductCategories",
"title": "listProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProductCollections",
"title": "listProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProductOptions",
"title": "listProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProductTags",
"title": "listProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProductTypes",
"title": "listProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProductVariants",
"title": "listProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/listProducts",
"title": "listProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProductCategories",
"title": "restoreProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProductCollections",
"title": "restoreProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProductOptions",
"title": "restoreProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProductTags",
"title": "restoreProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProductTypes",
"title": "restoreProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProductVariants",
"title": "restoreProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/restoreProducts",
"title": "restoreProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProduct",
"title": "retrieveProduct",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProductCategory",
"title": "retrieveProductCategory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProductCollection",
"title": "retrieveProductCollection",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProductOption",
"title": "retrieveProductOption",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProductTag",
"title": "retrieveProductTag",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProductType",
"title": "retrieveProductType",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/retrieveProductVariant",
"title": "retrieveProductVariant",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProductCategories",
"title": "softDeleteProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProductCollections",
"title": "softDeleteProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProductOptions",
"title": "softDeleteProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProductTags",
"title": "softDeleteProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProductTypes",
"title": "softDeleteProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProductVariants",
"title": "softDeleteProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/softDeleteProducts",
"title": "softDeleteProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProductCategories",
"title": "updateProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProductCollections",
"title": "updateProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProductOptions",
"title": "updateProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProductTags",
"title": "updateProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProductTypes",
"title": "updateProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProductVariants",
"title": "updateProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/updateProducts",
"title": "updateProducts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProductCategories",
"title": "upsertProductCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProductCollections",
"title": "upsertProductCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProductOptions",
"title": "upsertProductOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProductTags",
"title": "upsertProductTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProductTypes",
"title": "upsertProductTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProductVariants",
"title": "upsertProductVariants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/upsertProducts",
"title": "upsertProducts",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Product Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/product_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/Image",
"title": "Image",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/Product",
"title": "Product",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductCategory",
"title": "ProductCategory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductCollection",
"title": "ProductCollection",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductOption",
"title": "ProductOption",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductOptionValue",
"title": "ProductOptionValue",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductTag",
"title": "ProductTag",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductType",
"title": "ProductType",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/product/models/ProductVariant",
"title": "ProductVariant",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion",
"title": "Promotion Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/concepts",
"title": "Promotion",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/application-method",
"title": "Application Method",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/campaign",
"title": "Campaign",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/actions",
"title": "Promotion Actions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Promotion Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/promotion/IPromotionModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/addPromotionBuyRules",
"title": "addPromotionBuyRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/addPromotionRules",
"title": "addPromotionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/addPromotionTargetRules",
"title": "addPromotionTargetRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/addPromotionsToCampaign",
"title": "addPromotionsToCampaign",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/computeActions",
"title": "computeActions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/createCampaigns",
"title": "createCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/createPromotions",
"title": "createPromotions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/deleteCampaigns",
"title": "deleteCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/deletePromotions",
"title": "deletePromotions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/listAndCountCampaigns",
"title": "listAndCountCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/listAndCountPromotions",
"title": "listAndCountPromotions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/listCampaigns",
"title": "listCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/listPromotionRules",
"title": "listPromotionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/listPromotions",
"title": "listPromotions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/registerUsage",
"title": "registerUsage",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/removePromotionBuyRules",
"title": "removePromotionBuyRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/removePromotionRules",
"title": "removePromotionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/removePromotionTargetRules",
"title": "removePromotionTargetRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/removePromotionsFromCampaign",
"title": "removePromotionsFromCampaign",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/restoreCampaigns",
"title": "restoreCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/restorePromotions",
"title": "restorePromotions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/retrieveCampaign",
"title": "retrieveCampaign",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/retrievePromotion",
"title": "retrievePromotion",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/softDeleteCampaigns",
"title": "softDeleteCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/softDeletePromotions",
"title": "softDeletePromotions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/updateCampaigns",
"title": "updateCampaigns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/updatePromotionRules",
"title": "updatePromotionRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/updatePromotions",
"title": "updatePromotions",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Promotion Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/promotion_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models/ApplicationMethod",
"title": "ApplicationMethod",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models/Campaign",
"title": "Campaign",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models/CampaignBudget",
"title": "CampaignBudget",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models/Promotion",
"title": "Promotion",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models/PromotionRule",
"title": "PromotionRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/promotion/models/PromotionRuleValue",
"title": "PromotionRuleValue",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/region",
"title": "Region Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/region/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/region/relations-to-other-modules",
"title": "Relations to Other Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/region",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Region Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/region/IRegionModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/createRegions",
"title": "createRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/deleteRegions",
"title": "deleteRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/listAndCountCountries",
"title": "listAndCountCountries",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/listAndCountRegions",
"title": "listAndCountRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/listCountries",
"title": "listCountries",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/listRegions",
"title": "listRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/restoreRegions",
"title": "restoreRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/retrieveCountry",
"title": "retrieveCountry",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/retrieveRegion",
"title": "retrieveRegion",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/softDeleteRegions",
"title": "softDeleteRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/updateRegions",
"title": "updateRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/upsertRegions",
"title": "upsertRegions",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Region Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/region_models/variables",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/models/Country",
"title": "Country",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/region/models/Region",
"title": "Region",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/sales-channel",
"title": "Sales Channel Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/sales-channel/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/sales-channel/publishable-api-keys",
"title": "Publishable API Keys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/sales-channel/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Sales Channel Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/sales_channel/ISalesChannelModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/createSalesChannels",
"title": "createSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/deleteSalesChannels",
"title": "deleteSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/listAndCountSalesChannels",
"title": "listAndCountSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/listSalesChannels",
"title": "listSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/restoreSalesChannels",
"title": "restoreSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/retrieveSalesChannel",
"title": "retrieveSalesChannel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/softDeleteSalesChannels",
"title": "softDeleteSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/updateSalesChannels",
"title": "updateSalesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/upsertSalesChannels",
"title": "upsertSalesChannels",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Sales Channel Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/sales_channel_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/sales-channel/models/SalesChannel",
"title": "SalesChannel",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/stock-location",
"title": "Stock Location Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/stock-location/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/stock-location/concepts",
"title": "Stock Location Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/stock-location/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Stock Location Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/stock_location_next/IStockLocationService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/createStockLocations",
"title": "createStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/deleteStockLocations",
"title": "deleteStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/listAndCountStockLocations",
"title": "listAndCountStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/listStockLocations",
"title": "listStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/restoreStockLocations",
"title": "restoreStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/retrieveStockLocation",
"title": "retrieveStockLocation",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/softDeleteStockLocations",
"title": "softDeleteStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/updateStockLocations",
"title": "updateStockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/upsertStockLocations",
"title": "upsertStockLocations",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Stock Location Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/stock_location_next_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/models/StockLocation",
"title": "StockLocation",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/stock-location-next/models/StockLocationAddress",
"title": "StockLocationAddress",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/store",
"title": "Store Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/store/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/store/relations-to-other-modules",
"title": "Relation to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/store",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Store Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/store/IStoreModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/createStores",
"title": "createStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/deleteStores",
"title": "deleteStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/listAndCountStores",
"title": "listAndCountStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/listStores",
"title": "listStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/restoreStores",
"title": "restoreStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/retrieveStore",
"title": "retrieveStore",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/softDeleteStores",
"title": "softDeleteStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/updateStores",
"title": "updateStores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/upsertStores",
"title": "upsertStores",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Store Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/store_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/models/Store",
"title": "Store",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/store/models/StoreCurrency",
"title": "StoreCurrency",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax",
"title": "Tax Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax/module-options",
"title": "Module Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax/tax-region",
"title": "Tax Region",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax/tax-rates-and-rules",
"title": "Tax Rates and Rules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax/tax-calculation-with-provider",
"title": "Tax Calculation and Providers",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/provider",
"title": "Tax Provider Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "Tax Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/tax/ITaxModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/createTaxRateRules",
"title": "createTaxRateRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/createTaxRates",
"title": "createTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/createTaxRegions",
"title": "createTaxRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/deleteTaxRateRules",
"title": "deleteTaxRateRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/deleteTaxRates",
"title": "deleteTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/deleteTaxRegions",
"title": "deleteTaxRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/getTaxLines",
"title": "getTaxLines",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/listAndCountTaxRates",
"title": "listAndCountTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/listTaxRateRules",
"title": "listTaxRateRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/listTaxRates",
"title": "listTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/listTaxRegions",
"title": "listTaxRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/restoreTaxRateRules",
"title": "restoreTaxRateRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/restoreTaxRates",
"title": "restoreTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/restoreTaxRegions",
"title": "restoreTaxRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/retrieveTaxRate",
"title": "retrieveTaxRate",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/softDeleteTaxRateRules",
"title": "softDeleteTaxRateRules",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/softDeleteTaxRates",
"title": "softDeleteTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/softDeleteTaxRegions",
"title": "softDeleteTaxRegions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/updateTaxRates",
"title": "updateTaxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/upsertTaxRates",
"title": "upsertTaxRates",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "Tax Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/tax_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/models/TaxProvider",
"title": "TaxProvider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/models/TaxRate",
"title": "TaxRate",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/models/TaxRateRule",
"title": "TaxRateRule",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/tax/models/TaxRegion",
"title": "TaxRegion",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/user",
"title": "User Module",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/user/module-options",
"title": "Module Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/user/examples",
"title": "Examples",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/user/user-creation-flows",
"title": "User Creation Flows",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/user",
"title": "Main Service Reference",
"isChildSidebar": true,
"childSidebarTitle": "User Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/user/IUserModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/createInvites",
"title": "createInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/createUsers",
"title": "createUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/deleteInvites",
"title": "deleteInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/deleteUsers",
"title": "deleteUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/listAndCountInvites",
"title": "listAndCountInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/listAndCountUsers",
"title": "listAndCountUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/listInvites",
"title": "listInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/listUsers",
"title": "listUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/refreshInviteTokens",
"title": "refreshInviteTokens",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/restoreInvites",
"title": "restoreInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/restoreUsers",
"title": "restoreUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/retrieveInvite",
"title": "retrieveInvite",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/retrieveUser",
"title": "retrieveUser",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/softDeleteInvites",
"title": "softDeleteInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/softDeleteUsers",
"title": "softDeleteUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/updateInvites",
"title": "updateInvites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/updateUsers",
"title": "updateUsers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/validateInviteToken",
"title": "validateInviteToken",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/models",
"title": "Data Models Reference",
"isChildSidebar": true,
"childSidebarTitle": "User Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/user_models/classes",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/models/Invite",
"title": "Invite",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/user/models/User",
"title": "User",
"children": []
}
]
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/integrations",
"title": "Integrations",
"isChildSidebar": true,
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "File",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/file/s3",
"title": "AWS S3 (and Compatible APIs)",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Notification",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Payment",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/payment-provider/stripe",
"title": "Stripe",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Recipes",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/b2b",
"title": "B2B",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/commerce-automation",
"title": "Commerce Automation",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/digital-products",
"title": "Digital Products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/ecommerce",
"title": "Ecommerce",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/integrate-ecommerce-stack",
"title": "Integrate Ecommerce Stack",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/marketplace",
"title": "Marketplace",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/multi-region-store",
"title": "Multi-Region Store",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/omnichannel",
"title": "Omnichannel Store",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/oms",
"title": "OMS",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/personalized-products",
"title": "Personalized Products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/pos",
"title": "POS",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/recipes/subscriptions",
"title": "Subscriptions",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "SDKs and Tools",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/create-medusa-app",
"title": "create-medusa-app",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/medusa-cli",
"title": "Medusa CLI",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/js-client",
"title": "Medusa JS Client",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AddressesResource",
"title": "admin",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminAuthResource",
"title": "auth",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminBatchJobsResource",
"title": "batchJobs",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminCollectionsResource",
"title": "collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminCurrenciesResource",
"title": "currencies",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminCustomResource",
"title": "custom",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminCustomerGroupsResource",
"title": "customerGroups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminCustomersResource",
"title": "customers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminDiscountsResource",
"title": "discounts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminDraftOrdersResource",
"title": "draftOrders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminGiftCardsResource",
"title": "giftCards",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminInventoryItemsResource",
"title": "inventoryItems",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminInvitesResource",
"title": "invites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminNotesResource",
"title": "notes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminNotificationsResource",
"title": "notifications",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminOrderEditsResource",
"title": "orderEdits",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminOrdersResource",
"title": "orders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminPaymentCollectionsResource",
"title": "paymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminPaymentsResource",
"title": "payments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminPriceListResource",
"title": "priceLists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminProductCategoriesResource",
"title": "productCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminProductTagsResource",
"title": "productTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminProductTypesResource",
"title": "productTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminProductsResource",
"title": "products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminPublishableApiKeyResource",
"title": "publishableApiKeys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminRegionsResource",
"title": "regions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminReservationsResource",
"title": "reservations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminReturnReasonsResource",
"title": "returnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminReturnsResource",
"title": "returns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminSalesChannelsResource",
"title": "salesChannels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminShippingOptionsResource",
"title": "shippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminShippingProfilesResource",
"title": "shippingProfiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminStockLocationsResource",
"title": "stockLocations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminStoresResource",
"title": "store",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminSwapsResource",
"title": "swaps",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminTaxRatesResource",
"title": "taxRates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminUploadsResource",
"title": "uploads",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminUsersResource",
"title": "users",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AdminVariantsResource",
"title": "variants",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Store",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AuthResource",
"title": "auth",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "carts",
"path": "/references/js-client/CartsResource",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/LineItemsResource",
"title": "lineItems",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/CollectionsResource",
"title": "collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/CustomersResource",
"title": "customers",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/AddressesResource",
"title": "addresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/PaymentMethodsResource",
"title": "paymentMethods",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/GiftCardsResource",
"title": "giftCards",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/OrderEditsResource",
"title": "orderEdits",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/OrdersResource",
"title": "orders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/PaymentCollectionsResource",
"title": "paymentCollections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/PaymentMethodsResource",
"title": "paymentMethods",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ProductCategoriesResource",
"title": "productCategories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ProductTagsResource",
"title": "productTags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ProductTypesResource",
"title": "productTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ProductTypesResource",
"title": "productTypes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ProductsResource",
"title": "products",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ProductVariantsResource",
"title": "variants",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/RegionsResource",
"title": "regions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ReturnReasonsResource",
"title": "returnReasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ReturnsResource",
"title": "returns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/ShippingOptionsResource",
"title": "shippingOptions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/js-client/SwapsResource",
"title": "swaps",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/medusa-react",
"title": "Medusa React",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks",
"title": "Hooks",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin",
"title": "Admin",
"autogenerate_path": "/references/medusa_react/Hooks/Admin",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/auth",
"title": "Auth",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/batch_jobs",
"title": "Batch Jobs",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/claims",
"title": "Claims",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/currencies",
"title": "Currencies",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/custom",
"title": "Custom",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/customer_groups",
"title": "Customer Groups",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/customers",
"title": "Customers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/discounts",
"title": "Discounts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/draft_orders",
"title": "Draft Orders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/gift_cards",
"title": "Gift Cards",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/inventory_items",
"title": "Inventory Items",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/invites",
"title": "Invites",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/notes",
"title": "Notes",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/notifications",
"title": "Notifications",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/order_edits",
"title": "Order Edits",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/orders",
"title": "Orders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/payment_collections",
"title": "Payment Collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/payments",
"title": "Payments",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/price_lists",
"title": "Price Lists",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/product_categories",
"title": "Product Categories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/product_collections",
"title": "Product Collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/product_tags",
"title": "Product Tags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/product_types",
"title": "Product Types",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/product_variants",
"title": "Product Variants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/products",
"title": "Products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/publishable_api_keys",
"title": "Publishable API Keys",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/regions",
"title": "Regions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/reservations",
"title": "Reservations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/return_reasons",
"title": "Return Reasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/returns",
"title": "Returns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/sales_channels",
"title": "Sales Channels",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/shipping_options",
"title": "Shipping Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/shipping_profiles",
"title": "Shipping Profiles",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/stock_locations",
"title": "Stock Locations",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/stores",
"title": "Stores",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/swaps",
"title": "Swaps",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/tax_rates",
"title": "Tax Rates",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/uploads",
"title": "Uploads",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/admin/users",
"title": "Users",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store",
"title": "Store",
"autogenerate_path": "/references/medusa_react/Hooks/Store",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/carts",
"title": "Carts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/customers",
"title": "Customers",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/gift_cards",
"title": "Gift Cards",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/line_items",
"title": "Line Items",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/order_edits",
"title": "Order Edits",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/orders",
"title": "Orders",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/payment_collections",
"title": "Payment Collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/product_categories",
"title": "Product Categories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/product_collections",
"title": "Product Collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/product_tags",
"title": "Product Tags",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/product_types",
"title": "Product Types",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/products",
"title": "Products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/regions",
"title": "Regions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/return_reasons",
"title": "Return Reasons",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/returns",
"title": "Returns",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/shipping_options",
"title": "Shipping Options",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/hooks/store/swaps",
"title": "Swaps",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/providers",
"title": "Providers",
"hasTitleStyling": true,
"autogenerate_path": "/references/medusa_react/Providers",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/providers/cart",
"title": "Cart",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/providers/medusa",
"title": "Medusa",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/providers/session_cart",
"title": "Session_Cart",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/utilities",
"title": "Utilities",
"hasTitleStyling": true,
"autogenerate_path": "/references/medusa_react/Utilities/functions",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/utilities/computeAmount",
"title": "computeAmount",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/utilities/computeVariantPrice",
"title": "computeVariantPrice",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/utilities/formatAmount",
"title": "formatAmount",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/utilities/formatVariantPrice",
"title": "formatVariantPrice",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-react/utilities/getVariantPrice",
"title": "getVariantPrice",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/nextjs-starter",
"title": "Next.js Starter",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules",
"title": "Architectural Modules",
"isChildSidebar": true,
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/cache",
"title": "Cache Modules",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/cache/in-memory",
"title": "In-Memory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/cache/redis",
"title": "Redis",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/cache/create",
"title": "Create Cache Module",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/event",
"title": "Event Modules",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/event/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/event/redis",
"title": "Redis",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/event/create",
"title": "Create Event Module",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/file",
"title": "File Provider Modules",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/file/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/file/s3",
"title": "AWS S3 (and Compatible APIs)",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/file-provider-module",
"title": "Create File Provider",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/notification",
"title": "Notification Provider Modules",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/notification/local",
"title": "Local",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/notification/send-notification",
"title": "Send Notification",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/notification-provider-module",
"title": "Create Notification Provider",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/workflow-engine",
"title": "Workflow Engine Modules",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/workflow-engine/in-memory",
"title": "In-Memory",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/architectural-modules/workflow-engine/redis",
"title": "Redis",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development",
"title": "Storefront Development",
"hasTitleStyling": true,
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/tips",
"title": "Tips",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/regions",
"title": "Regions",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/regions/list",
"title": "List Regions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/regions/store-retrieve-region",
"title": "Store and Retrieve Regions",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/regions/context",
"title": "Region React Context",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products",
"title": "Products",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/list",
"title": "List Products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/retrieve",
"title": "Retrieve a Product",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/variants",
"title": "Select a Variant",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/price",
"title": "Retrieve Variant Prices",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/categories",
"title": "Categories",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/categories/list",
"title": "List Categories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/categories/retrieve",
"title": "Retrieve a Category",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/categories/products",
"title": "Retrieve a Category's Products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/categories/nested-categories",
"title": "Retrieve Nested Categories",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/collections",
"title": "Collections",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/collections/list",
"title": "List Collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/collections/retrieve",
"title": "Retrieve a Collection",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/products/collections/products",
"title": "Retrieve a Collection's Products",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/cart",
"title": "Carts",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/cart/create",
"title": "Create Cart",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/cart/retrieve",
"title": "Retrieve Cart",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/cart/context",
"title": "Cart React Context",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/cart/update",
"title": "Update Cart",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/cart/manage-items",
"title": "Manage Line Items",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout",
"title": "Checkout",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout/email",
"title": "1. Enter Email",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout/address",
"title": "2. Enter Address",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout/shipping",
"title": "3. Choose Shipping Method",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout/payment",
"title": "4. Choose Payment Provider",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout/payment/stripe",
"title": "Example: Stripe",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/checkout/complete-cart",
"title": "5. Complete Cart",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers",
"title": "Customers",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/register",
"title": "Register Customer",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/login",
"title": "Login Customer",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/retrieve",
"title": "Retrieve Customer",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/context",
"title": "Customer React Context",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/profile",
"title": "Edit Customer Profile",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/addresses",
"title": "Manage Customer Addresses",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/storefront-development/customers/log-out",
"title": "Log-out Customer",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/medusa-config",
"title": "Medusa Configurations",
"hasTitleStyling": true,
"children": []
},
{
"loaded": true,
"isPathHref": true,
"title": "General",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/upgrade-guides",
"title": "Upgrade Guides",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment",
"title": "Deployment Guides",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Medusa Application",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/medusa-application/railway",
"title": "Railway",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/medusa-application/heroku",
"title": "Heroku",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/medusa-application/digitalocean",
"title": "DigitalOcean",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/medusa-application/microtica",
"title": "Microtica",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/medusa-application/general",
"title": "General Guide",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Medusa Admin",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/admin/vercel",
"title": "Vercel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/admin/general",
"title": "General Guide",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Next.js Starter",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/storefront/vercel",
"title": "Vercel",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/deployment/storefront/general",
"title": "General Guide",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting",
"title": "Troubleshooting Guides",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Installation",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/create-medusa-app-errors",
"title": "Create Medusa App Errors",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/errors-installing-cli",
"title": "Errors Installing CLI",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/general-errors",
"title": "General Errors",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Medusa Application",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/eaddrinuse",
"title": "EADDRINUSE Error",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/database-errors",
"title": "Database Errors",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Upgrade",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/errors-after-upgrading",
"title": "Errors After Upgrading",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Frontend",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/troubleshooting/cors-errors",
"title": "CORS Errors",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Lists",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/medusa-container-resources",
"title": "Medusa Container Resources",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/admin-widget-injection-zones",
"title": "Admin Widget Injection Zones",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "API References",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows",
"title": "Workflow API",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Functions",
"hasTitleStyling": true,
"autogenerate_path": "/references/workflows/functions",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows/createStep",
"title": "createStep",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows/createWorkflow",
"title": "createWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows/parallelize",
"title": "parallelize",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows/transform",
"title": "transform",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/workflows/when",
"title": "when",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model",
"title": "Data Model API",
"childSidebarTitle": "Data Model API Reference",
"isChildSidebar": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/define",
"title": "Define Method",
"hasTitleStyling": true,
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types",
"title": "Property Types",
"hasTitleStyling": true,
"autogenerate_path": "/references/dml/Property_Types/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/array",
"title": "array",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/bignumber",
"title": "bigNumber",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/boolean",
"title": "boolean",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/datetime",
"title": "dateTime",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/enum",
"title": "enum",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/id",
"title": "id",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/json",
"title": "json",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/number",
"title": "number",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-types/text",
"title": "text",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/relationship-methods",
"title": "Relationship Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/dml/Relationship_Methods/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/relationship-methods/belongsto",
"title": "belongsTo",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/relationship-methods/hasmany",
"title": "hasMany",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/relationship-methods/hasone",
"title": "hasOne",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/relationship-methods/manytomany",
"title": "manyToMany",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/model-methods",
"title": "Model Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/dml/Model_Methods/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/model-methods/cascades",
"title": "cascades",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/model-methods/indexes",
"title": "indexes",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-configuration",
"title": "Property Configuration Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/dml/Property_Configuration_Methods/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-configuration/default",
"title": "default",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-configuration/index",
"title": "index",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-configuration/nullable",
"title": "nullable",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/data-model/property-configuration/unique",
"title": "unique",
"children": []
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"title": "Other",
"hasTitleStyling": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"title": "Contribution Guidelines",
"children": [
{
"loaded": true,
"isPathHref": true,
"path": "/contribution-guidelines/docs",
"title": "Docs",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/usage",
"title": "Usage",
"children": []
}
]
}
]
Reference in New Issue View Git Blame Copy Permalink