Getting Started with ApiShip for Medusa (v2.0.0-beta)

In this document, you’ll learn how to install and configure the ApiShip plugin for Medusa.

• Medusa v2.17.2 or later
• Node.js v20 or later
• An ApiShip account - sign in or create one
• Integration Module v0.1.0 or later

yarn add @gorgo/medusa-integration @gorgo/medusa-fulfillment-apiship@beta

Add the provider configuration in your medusa-config.ts file of the Medusa admin application:

medusa-config.ts
1// ...
2const APISHIP_INTEGRATION_ID = "apiship-1"
3
4module.exports = defineConfig({
5  // ...
6  plugins: [
7    // ...
8    {
9      resolve: "@gorgo/medusa-integration",
10      options: {
11        encryptionKey: process.env.INTEGRATION_ENCRYPTION_KEY,
12        providers: [
13          {
14            resolve: "@gorgo/medusa-fulfillment-apiship/providers/integration-apiship",
15            id: APISHIP_INTEGRATION_ID,
16            options: {},
17          },
18        ],
19      },
20    },
21    {
22      resolve: "@gorgo/medusa-fulfillment-apiship",
23      options: {},
24    },
25  ],
26  modules: [
27    // ...
28    {
29      resolve: "@medusajs/medusa/fulfillment",
30      options: {
31        providers: [
32          {
33            resolve: "@gorgo/medusa-fulfillment-apiship/providers/fulfillment-apiship",
34            id: "apiship",
35            options: {
36              id: APISHIP_INTEGRATION_ID
37            },
38          },
39        ],
40      },
41    },
42  ],
43})

Add environment variables with your secret Encryption Key:

.env
INTEGRATION_ENCRYPTION_KEY=supersecret