Command Palette

Search for a command to run...

Getting Started with ApiShip

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

Requirements

Installation

yarn add @gorgo/medusa-fulfillment-apiship
# or
npm install @gorgo/medusa-fulfillment-apiship

Configuration

Add the provider configuration in your file of the Medusa admin application:

// ...
module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{
resolve: "@gorgo/medusa-fulfillment-apiship/providers/fulfillment-apiship",
id: "apiship",
options: {
token: process.env.APISHIP_TOKEN,
isTest: false,
settings: {
defaultSenderSettings: {
countryCode: "RU",
addressString: "Москва, улица Лестева, 19к1, офис 306",
contactName: "Иванов Иван Иванович",
phone: "+79999999900",
},
connectionsMap: {
cdek: "36253",
},
defaultProductSizes: {
length: 10,
width: 10,
height: 10,
weight: 20,
},
deliveryCostVat: -1,
isCod: false,
},
},
},
],
},
},
],
plugins: [
// ...
{
resolve: "@gorgo/medusa-fulfillment-apiship",
options: {},
},
],
})

Add environment variable with your token from your ApiShip account:

Provider Options

OptionDescriptionRequiredDefault
ApiShip API token.Yes
Enables test mode for ApiShip API requests.No
Provider settings object.Yes
Sender country code.Yes
Sender full address as a single string.Yes
Sender contact full name.Yes
Sender contact phone number.Yes
Mapping of delivery provider keys to ApiShip connection IDs.No
Default product length.No
Default product width.No
Default product height.No
Default product weight.No
Delivery VAT rate:
- — No VAT
- — 0%
- — 5%
- — 7%
- — 10%
- — 20%
- — 22%
Yes
Enables Cash on Delivery (C.O.D.) for created orders.No