Shipping accounts
A shipping account is where you configure return shipping in nShift Returns and connect it to your shipping platform. You can create one or more shipping accounts and assign each one to one or more markets. nShift Returns uses nShift Checkout to decide which delivery options customers see when they make a return.
On this page
- Key concepts
- Before you begin
- Create an API client in nShift Portal
- Add your Portal credentials in nShift Returns
- Create a shipping account
- Assign a shipping account to a market
Key concepts
Shipping account — connection between nShift Returns, an nShift Checkout configuration, and a shipping platform, used to book return shipments
Sender — the address return shipments are sent back to. You can create several senders and connect them to different delivery options or nShift Checkout configurations when you use more than one return address.
nShift Checkout — the nShift product that decides which delivery options customers see when they make a return. It's separate from the checkout in your online store.
nShift Checkout configuration — set of delivery options and rules that decides which services customers see when making a return. Each shipping account links to one configuration.
Shipping platform — the platform that books return shipments and creates labels: nShift Delivery, nShift Ship, or nShift Transsmart
Market — a market in nShift Returns. Each market uses one shipping account, and one shipping account can be used by several markets.
Before you begin
Make sure that:
- You have the credentials for your shipping platform:
- nShift Delivery — API key and secret. See API keys.
- nShift Ship — actor ID and key. See Find your Actor ID.
- nShift Transsmart — account number, username, and password. See [LINK TBD].
- nShift Checkout is enabled for the markets you'll assign the shipping account to.
Create an API client in nShift Portal
Create an API client in nShift Portal to get a client ID and client secret. nShift Returns uses them to connect to nShift Checkout and to track return shipments.
Steps
- Log in to nShift Portal
- Select Settings
- Go to API Configuration > Clients
- Select Add
- Enter a display name and description
- Select Enable to activate the API client right away
- Select Public checkout API and Portal Shipment Data API in Allowed Scopes
- Select Save
- Copy the client ID and client secret
Important
The client secret is only shown once. Copy it before you close the dialog.
- Select Close
Add your Portal credentials in nShift Returns
Add the client ID and client secret to nShift Returns before you create a shipping account.
Steps
- Log in to nShift Returns
- Go to Settings > Portal integration
- Enter your client ID in Portal Client ID
- Enter your client secret in Portal Client Secret
- Select Save
Create a shipping account
Create a shipping account to create/connect an nShift Checkout configuration and your shipping platform to nShift Returns. The setup has 6 steps, and the shipping account is activated in the last step.
Steps
- Go to Settings > Shipping accounts
- Select Create shipping account
- In Account Overview, enter a name for the shipping account and select Continue
- In Add a sender, add a sender or check that one already exists, and select Continue
Tip For help adding a sender, see Add a new sender.
- In Enable carrier services, create an nShift Checkout configuration with the nShift Returns template and select Continue
Important Add the same currencies and languages to the configuration as the markets you'll assign the shipping account to. The configuration also needs at least one enabled delivery option — without one, the shipping account can't be activated.
Tip For help creating an nShift Checkout configuration, see Create an nShift Checkout configuration.
- In Link Checkout, select the nShift Checkout configuration to link to the shipping account
Note You can create several nShift Checkout configurations, but each shipping account links to only one.
- Select Show carriers to check the carriers and services in the configuration
- Select Continue
- In Shipping Solution, select your shipping platform: nShift Delivery, nShift Ship, or nShift Transsmart
- Enter the credentials for your shipping platform and select Continue
- In Carrier Setup, review your configuration
- Select Save and activate
Result
The shipping account is created and activated. It appears in the Shipping accounts list and can be assigned to markets.
Next step
Assign the shipping account to a market, then create a test return to check that the delivery options are shown and a label is created. See Assign a shipping account to a market.
Assign a shipping account to a market
Assign a shipping account to a market so return shipments for that market are booked through it. You can assign the same shipping account to several markets.
Steps
- Go to Markets and select a market
- Open the Shipping tab
- Select the shipping account in Shipping account
- Select Save
Result
Return shipments for the market are booked through the shipping account, using its nShift Checkout configuration and shipping platform.
Next step
Create a test return for the market to check that the delivery options are shown and a label is created.