Difference between revisions of "Using Australia Post MyPost Business"

From Spiffy Stores Knowledge Base

(Created page with "Spiffy Stores provides an easy to use integration with MyPost Business. There are a number of steps that you need to go through in order to connect your store to your Austral...")
 
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Spiffy Stores provides an easy to use integration with MyPost Business.  There are a number of steps that you need to go through in order to connect your store to your Australia Post MyPost Business account.
 
Spiffy Stores provides an easy to use integration with MyPost Business.  There are a number of steps that you need to go through in order to connect your store to your Australia Post MyPost Business account.
  
−
You can read more about how the integration between Spiffy Stores and MyPost Business works here [https://auspost.com.au/business/shipping/mypost-business/print-shipping-labels].
+
You can read more about how the integration between Spiffy Stores and MyPost Business works here -
  
−
Australia Post have also provided a getting started guide on how to connect your store to your MyPost Business account and you can view it here - [https://auspost.com.au/content/dam/auspost_corp/media/documents/mypost-business-platform-partner-integration-guide.pdf]
+
[https://auspost.com.au/business/shipping/mypost-business/print-shipping-labels https://auspost.com.au/business/shipping/mypost-business/print-shipping-labels].
 +
 
 +
Australia Post have also provided a getting started guide on how to connect your store to your MyPost Business account and you can view it here -
 +
 
 +
[https://auspost.com.au/content/dam/auspost_corp/media/documents/mypost-business-platform-partner-integration-guide.pdf https://auspost.com.au/content/dam/auspost_corp/media/documents/mypost-business-platform-partner-integration-guide.pdf].
  
 
== 1. Establish a MyPost Business account with Australia Post ==
 
== 1. Establish a MyPost Business account with Australia Post ==
−
You can sign up for a new account at [https://auspost.com.au/business/shipping/mypost-business]
+
You can sign up for a new account at [https://auspost.com.au/business/shipping/mypost-business https://auspost.com.au/business/shipping/mypost-business]
  
 
You can pay for your shipments using a credit card or by using an existing Australia Post charge account. You will need to provide credit card details in order to proceed.
 
You can pay for your shipments using a credit card or by using an existing Australia Post charge account. You will need to provide credit card details in order to proceed.
−
 
+
== 2. Connect MyPost Business to Spiffy Stores ==
−
 
 
−
 
 
−
== 3. Submit a request for API access ==
 
−
 
 
 
<gallery widths="200px" heights="200px" class="right">
 
<gallery widths="200px" heights="200px" class="right">
−
Image:Eparcel setup2.jpg|Provide your account details
+
Image:Mpb setup1.jpg|Access your Business Details
 
</gallery>
 
</gallery>
−
 
+
Login to your MyPost Business account, and find the '''Business details''' link in the drop-down menu at the top right-hand corner of the page under your account name.
−
Please fill in the form with your contact details, including your Australia Post Parcel Contract Account number. This is the account that is used to charge for the shipments submitted via the API.
+
=== Select Platform Partners ===
−
 
 
−
Also, please ensure that you request access to all three services, ''Tracking'', ''Product Pricing'' and ''Lodgement and Label Printing''.
 
−
 
 
 
<gallery widths="200px" heights="200px" class="right">
 
<gallery widths="200px" heights="200px" class="right">
−
Image:Eparcel setup3.jpg|Connect to Spiffy Stores
+
Image:Mpb setup2.jpg|Select Platform Partners
 
</gallery>
 
</gallery>
−
 
+
From the '''Business details''' page, select the '''Platform Partners''' page.
−
On the following page of the form, please specify ''Spiffy Stores'' as the Platform Partner.
+
=== Connect to Spiffy Stores ===
−
 
 
−
Once you're finished, submit the form for approval. Generally, you should expect to receive a reply within one business day.
 
−
 
 
−
== 4. Activate your API access ==
 
−
 
 
 
<gallery widths="200px" heights="200px" class="right">
 
<gallery widths="200px" heights="200px" class="right">
−
Image:Eparcel setup4.jpg|New Projects Menu Item
+
Image:Mpb setup3.jpg|Connect to Spiffy Stores
 
</gallery>
 
</gallery>
−
 
+
Scroll down until you find the '''Spiffy Stores''' entry in the list. Click on the '''Connect''' button. This will generate a unique Partners Token for you.
−
You'll receive an activation email from Australia Post once your request has been approved.
+
=== Copy Partners Token ===
−
 
 
−
Just click on the ''Log in'' link in the email and you'll be taken to the Developer Center page, where you'll find that there's an additional ''Projects'' link in the toolbar.
 
−
 
 
−
If you don't receive a response from Australia Post, then you can send a follow-up email to [mailto:Customer_Connectivity@auspost.com.au Customer_Connectivity@auspost.com.au] quoting your Parcel Contract account number and the email address you used to create your Developer Center Account.
 
−
 
 
−
== 5. Create your first project ==
 
−
 
 
 
<gallery widths="200px" heights="200px" class="right">
 
<gallery widths="200px" heights="200px" class="right">
−
Image:Eparcel setup5.jpg|Create a project
+
Image:Mpb setup4.jpg|Copy Partners Token
 
</gallery>
 
</gallery>
−
 
+
Once the token has been generated, click on the '''Copy Token''' button to copy it to your computer's clipboard.
−
You need to follow the following steps in order to create a project.
+
=== Activate Fulfilment Service ===
−
 
 
−
Click on ''Create new project'' to begin.
 
−
 
 
 
<gallery widths="200px" heights="200px" class="right">
 
<gallery widths="200px" heights="200px" class="right">
−
Image:Eparcel setup6.jpg|Name the project
+
Image:Mpb activate1.jpg|Activate Fulfilment Service
 
</gallery>
 
</gallery>
−
 
−
Give the project a name, such as ''Spiffy Stores'', so that you'll know what the API key relates to.
 
−
 
−
Click ''Create project'' to create the project.
 
−
 
−
== 6. Create an API key ==
 
−
 
−
<gallery widths="200px" heights="200px" class="right">
 
−
Image:Eparcel setup7.jpg|Create an API key
 
−
</gallery>
 
−
 
−
<gallery widths="200px" heights="200px" class="right">
 
−
Image:Eparcel setup8.jpg|Create an API key
 
−
</gallery>
 
−
 
−
You don't have any API keys yet, so click on the links to create one.
 
−
 
−
== 7. Choose a name and a password for the API key ==
 
−
 
 
<gallery widths="200px" heights="200px" class="right">
 
<gallery widths="200px" heights="200px" class="right">
−
Image:Eparcel setup9.jpg|Choose a name and password
+
Image:Mpb activate2.jpg|Provide API Credentials
 
</gallery>
 
</gallery>
 +
From the Fulfilment Services page in your Spiffy Stores admin, click ''Activate'' for the '''MyPost Business''' service, and paste the partner token into the form.
  
−
You need to choose a name and a password for the API key. The name can be something simple, like ''API Key 1''.
+
Use the context menu to paste the token from the clipboard, or use the keyboard shortcut for Paste.  
  
−
Choose a password that is at least 8 characters long and contains at least one capital letter and one digit. Write the password down, as you'll need it later to activate your Parcel Contract fulfilment service in your store.
+
You can tick the option to make this fulfilment service the default service for your store, if necessary. You should do this if you are using MyPost Business to ship the majority, if not all, of your store's items.
  
−
<gallery widths="200px" heights="200px" class="right">
+
Update the settings, and your MyPost Business account should now be connected to your Spiffy Store.
−
Image:Eparcel setup10.jpg|A generated API key
 
−
</gallery>
 
−
 
 
−
When the API key has been generated, you'll see it in the list of existing keys.
 
−
 
 
−
You'll also need the ''API Key'' value when you activate the eParcel fulfilment service in your store.
 
−
 
 
−
== 8. Enable the API Services ==
 
−
 
 
−
<gallery widths="200px" heights="200px" class="right">
 
−
Image:Eparcel setup11.jpg|Enable Services
 
−
</gallery>
 
−
 
 
−
Next, you need to enable the services associated with the API key.
 
−
 
 
−
First, click on the ''Services'' link to go to the Services page.
 
−
 
 
−
Then, for each of the services listed, click on the ''On/Off'' switch to enable each one. Once they are all enabled, click on ''Update'' to save your changes.
 
−
 
 
−
It's recommended that you logoff from your account, and then login again to verify that everything is correct. Please check that all of the services have been enabled as requested.
 
−
 
 
−
Once this step is complete, you're ready to [[Activating Australia Post eParcel Fulfilment|activate the eParcel fulfilment service in your store]] using your eParcel Account number, API Key and password.
 
  
 
== Further Reference ==
 
== Further Reference ==
−
 
 
* [[Using a fulfilment service]]
 
* [[Using a fulfilment service]]
 
* [[Shipping Products using a fulfilment service]]
 
* [[Shipping Products using a fulfilment service]]
−
* [[Activating Australia Post Parcel Contract (formerly eParcel) Fulfilment]]
+
* [[Using Australia Post MyPost Business]]
 
* [[Shipping Orders with batch fulfilment]]
 
* [[Shipping Orders with batch fulfilment]]

Latest revision as of 11:45, 1 September 2022

Spiffy Stores provides an easy to use integration with MyPost Business. There are a number of steps that you need to go through in order to connect your store to your Australia Post MyPost Business account.

You can read more about how the integration between Spiffy Stores and MyPost Business works here -

https://auspost.com.au/business/shipping/mypost-business/print-shipping-labels.

Australia Post have also provided a getting started guide on how to connect your store to your MyPost Business account and you can view it here -

https://auspost.com.au/content/dam/auspost_corp/media/documents/mypost-business-platform-partner-integration-guide.pdf.

1. Establish a MyPost Business account with Australia Post

You can sign up for a new account at https://auspost.com.au/business/shipping/mypost-business

You can pay for your shipments using a credit card or by using an existing Australia Post charge account. You will need to provide credit card details in order to proceed.

2. Connect MyPost Business to Spiffy Stores

  • Access your Business Details

Login to your MyPost Business account, and find the Business details link in the drop-down menu at the top right-hand corner of the page under your account name.

Select Platform Partners

  • Select Platform Partners

From the Business details page, select the Platform Partners page.

Connect to Spiffy Stores

  • Connect to Spiffy Stores

Scroll down until you find the Spiffy Stores entry in the list. Click on the Connect button. This will generate a unique Partners Token for you.

Copy Partners Token

  • Copy Partners Token

Once the token has been generated, click on the Copy Token button to copy it to your computer's clipboard.

Activate Fulfilment Service

  • Activate Fulfilment Service

  • Provide API Credentials

From the Fulfilment Services page in your Spiffy Stores admin, click Activate for the MyPost Business service, and paste the partner token into the form.

Use the context menu to paste the token from the clipboard, or use the keyboard shortcut for Paste.

You can tick the option to make this fulfilment service the default service for your store, if necessary. You should do this if you are using MyPost Business to ship the majority, if not all, of your store's items.

Update the settings, and your MyPost Business account should now be connected to your Spiffy Store.

Further Reference

Retrieved from "http://www.spiffystores.com.au/kb/index.php?title=Using_Australia_Post_MyPost_Business&oldid=9640"