docs: integrate shipstation guide (#10623)

* first draft

* finalized first draft + added link to sidebar

* fix lint errors

* type changes

* updates to createFulfillment

* updates

* more updates

* add package weight

* added note about package

* fix up order items fulfillment

* add meta image

* address comment
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-23 10:20:19 +02:00
1 parent 592ca1539c
commit a399781b9b
9 files changed
+1486 -17

No files matched your search

File diff suppressed because it is too large. Load diff
+24 -2
View File
@@ -28,7 +28,7 @@ An Auth Module Provider authenticates users with their account on a third-party
className="mb-1" className="mb-1"
/> />
Learn how to create a custom third-party authentication provider in [this guide](/references/auth/provider). Learn how to integrate a custom third-party authentication provider in [this guide](/references/auth/provider).
--- ---
@@ -66,7 +66,29 @@ A File Module Provider uploads and manages assets, such as product images, on a
className="mb-1" className="mb-1"
/> />
Learn how to create a custom third-party file or storage provider in [this guide](/references/file-provider-module). Learn how to integrate a custom third-party file or storage provider in [this guide](/references/file-provider-module).
---
## Fulfillment
A Fulfillment Module Provider provides fulfillment options during checkout, calculates shipping rates, and processes an order's fulfillments.
<CardList
items={[
{
href: "/integrations/guides/shipstation",
title: "ShipStation",
badge: {
variant: "blue",
children: "Guide"
}
}
]}
className="mb-1"
/>
Learn how to create a Fulfillment Provider Module [this guide](/references/fulfillment/provider).
--- ---
+2 -2
View File
@@ -315,8 +315,8 @@ For example, to send a request to a custom route at `http://localhost:9000/custo
sdk.client.fetch(`/custom`, { sdk.client.fetch(`/custom`, {
method: "post", method: "post",
body: { body: {
id: "123" id: "123",
} },
}).then((data) => { }).then((data) => {
console.log(data) console.log(data)
}) })
@@ -172,7 +172,7 @@ const DigitalProductOrder = model.define("digital_product_order", {
status: model.enum(OrderStatus), status: model.enum(OrderStatus),
products: model.manyToMany(() => DigitalProduct, { products: model.manyToMany(() => DigitalProduct, {
mappedBy: "orders", mappedBy: "orders",
pivotTable: "digitalproduct_digitalproductorders" pivotTable: "digitalproduct_digitalproductorders",
}), }),
}) })
+2 -1
View File
@@ -119,7 +119,7 @@ export const generatedEditDates = {
"app/deployment/medusa-application/railway/page.mdx": "2024-11-11T11:50:10.517Z", "app/deployment/medusa-application/railway/page.mdx": "2024-11-11T11:50:10.517Z",
"app/deployment/storefront/vercel/page.mdx": "2024-07-26T07:21:31+00:00", "app/deployment/storefront/vercel/page.mdx": "2024-07-26T07:21:31+00:00",
"app/deployment/page.mdx": "2024-11-25T14:31:45.277Z", "app/deployment/page.mdx": "2024-11-25T14:31:45.277Z",
"app/integrations/page.mdx": "2024-12-10T08:20:41.203Z", "app/integrations/page.mdx": "2024-12-16T16:46:12.395Z",
"app/medusa-cli/page.mdx": "2024-08-28T11:25:32.382Z", "app/medusa-cli/page.mdx": "2024-08-28T11:25:32.382Z",
"app/medusa-container-resources/page.mdx": "2024-12-09T16:18:38.852Z", "app/medusa-container-resources/page.mdx": "2024-12-09T16:18:38.852Z",
"app/medusa-workflows-reference/page.mdx": "2024-12-09T16:22:32.129Z", "app/medusa-workflows-reference/page.mdx": "2024-12-09T16:22:32.129Z",
@@ -5660,6 +5660,7 @@ export const generatedEditDates = {
"references/types/DmlTypes/types/types.DmlTypes.RelationshipTypes/page.mdx": "2024-12-10T14:54:55.435Z", "references/types/DmlTypes/types/types.DmlTypes.RelationshipTypes/page.mdx": "2024-12-10T14:54:55.435Z",
"app/recipes/commerce-automation/restock-notification/page.mdx": "2024-12-11T08:47:27.471Z", "app/recipes/commerce-automation/restock-notification/page.mdx": "2024-12-11T08:47:27.471Z",
"app/troubleshooting/workflow-errors/page.mdx": "2024-12-11T08:44:36.598Z", "app/troubleshooting/workflow-errors/page.mdx": "2024-12-11T08:44:36.598Z",
"app/integrations/guides/shipstation/page.mdx": "2024-12-23T07:48:47.719Z",
"app/nextjs-starter/guides/customize-stripe/page.mdx": "2024-12-12T12:46:33.999Z", "app/nextjs-starter/guides/customize-stripe/page.mdx": "2024-12-12T12:46:33.999Z",
"references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx": "2024-12-17T16:57:22.046Z", "references/core_flows/Cart/Workflows_Cart/functions/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflow/page.mdx": "2024-12-17T16:57:22.046Z",
"references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflowId/page.mdx": "2024-12-17T16:57:22.044Z", "references/core_flows/Cart/Workflows_Cart/variables/core_flows.Cart.Workflows_Cart.listShippingOptionsForCartWithPricingWorkflowId/page.mdx": "2024-12-17T16:57:22.044Z",
@@ -595,6 +595,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/integrations/guides/sanity/page.mdx", "filePath": "/www/apps/resources/app/integrations/guides/sanity/page.mdx",
"pathname": "/integrations/guides/sanity" "pathname": "/integrations/guides/sanity"
}, },
{
"filePath": "/www/apps/resources/app/integrations/guides/shipstation/page.mdx",
"pathname": "/integrations/guides/shipstation"
},
{ {
"filePath": "/www/apps/resources/app/integrations/page.mdx", "filePath": "/www/apps/resources/app/integrations/page.mdx",
"pathname": "/integrations" "pathname": "/integrations"
+24
View File
@@ -1779,6 +1779,14 @@ export const generatedSidebar = [
"path": "/references/fulfillment/provider", "path": "/references/fulfillment/provider",
"title": "Create Fulfillment Provider Module", "title": "Create Fulfillment Provider Module",
"children": [] "children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/integrations/guides/shipstation",
"title": "Integrate ShipStation",
"children": []
} }
] ]
}, },
@@ -8088,6 +8096,22 @@ export const generatedSidebar = [
} }
] ]
}, },
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Fulfillment",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/integrations/guides/shipstation",
"title": "ShipStation",
"children": []
}
]
},
{ {
"loaded": true, "loaded": true,
"isPathHref": true, "isPathHref": true,
+16
View File
@@ -575,6 +575,11 @@ export const sidebar = sidebarAttachHrefCommonOptions([
path: "/references/fulfillment/provider", path: "/references/fulfillment/provider",
title: "Create Fulfillment Provider Module", title: "Create Fulfillment Provider Module",
}, },
{
type: "link",
path: "/integrations/guides/shipstation",
title: "Integrate ShipStation",
},
], ],
}, },
{ {
@@ -1794,6 +1799,17 @@ export const sidebar = sidebarAttachHrefCommonOptions([
}, },
], ],
}, },
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{ {
type: "category", type: "category",
title: "Notification", title: "Notification",
+11 -11
View File
@@ -1,18 +1,18 @@
export * from "./product.js"
export * from "./tax.js" export * from "./tax.js"
export * from "./pricing.js" export * from "./product.js"
export * from "./payment.js"
export * from "./cart.js"
export * from "./order.js" export * from "./order.js"
export * from "./storefront.js"
export * from "./payment.js"
export * from "./stripe.js"
export * from "./cart.js"
export * from "./customer.js" export * from "./customer.js"
export * from "./auth.js"
export * from "./fulfillment.js" export * from "./fulfillment.js"
export * from "./product-category.js" export * from "./product-category.js"
export * from "./storefront.js"
export * from "./query.js"
export * from "./stripe.js"
export * from "./region.js"
export * from "./api-key.js"
export * from "./product-collection.js"
export * from "./inventory.js" export * from "./inventory.js"
export * from "./publishable-api-key.js" export * from "./publishable-api-key.js"
export * from "./auth.js" export * from "./pricing.js"
export * from "./region.js"
export * from "./product-collection.js"
export * from "./api-key.js"
export * from "./query.js"