Difference between revisions of "Using Australia Post Parcel Contact (formerly eParcel)"
From Spiffy Stores Knowledge Base
(17 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | There are a number of steps that you need to go through in order to connect your store to your Australia Post | + | Spiffy Stores provides an easy to use integration with Parcel Contract (formerly eParcel). There are a number of steps that you need to go through in order to connect your store to your Australia Post Parcel Contract account. |
− | == Establish an eParcel account with Australia Post == | + | == 1. Establish an Parcel Contract (formerly eParcel) account with Australia Post == |
− | You will need to contact Australia Post to establish | + | You will need to contact Australia Post to establish a [https://auspost.com.au/business/shipping/parcel-contract Parcel Contract account], if you don't already have one. |
− | + | Parcel Contract is a fulfillment service provided by Australia Post and is available if you're sending large numbers of parcels. Specific rates are established for your shipments at the time the account is opened. | |
− | == Create an Australia Post Developer Centre account == | + | == 2. Create an Australia Post Developer Centre account == |
<gallery widths="200px" heights="200px" class="right"> | <gallery widths="200px" heights="200px" class="right"> | ||
Line 13: | Line 13: | ||
</gallery> | </gallery> | ||
− | Your store will communicate with Australia Post using an API key that you need to create using the Developer Centre. You can [https://developers.auspost.com.au/register register for access here] using your Australia Post account. You can also use this link to signup for an Australia Post account, if you don't have one. This account will need to be associated with your | + | Your store will communicate with Australia Post using an API key that you need to create using the Developer Centre. You can [https://developers.auspost.com.au/register register for access here] using your Australia Post account. You can also use this link to signup for an Australia Post account, if you don't have one. This account will need to be associated with your Parcel Contract account. |
Once you've signed in, look for the ''Shipping and Tracking'' section, and click on the ''Register your interest today'' link. | Once you've signed in, look for the ''Shipping and Tracking'' section, and click on the ''Register your interest today'' link. | ||
− | == Submit a request for API access == | + | == 3. Submit a request for API access == |
<gallery widths="200px" heights="200px" class="right"> | <gallery widths="200px" heights="200px" class="right"> | ||
Line 23: | Line 23: | ||
</gallery> | </gallery> | ||
− | Please fill in the form with your contact details, including your Australia Post | + | 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. |
Also, please ensure that you request access to all three services, ''Tracking'', ''Product Pricing'' and ''Lodgement and Label Printing''. | Also, please ensure that you request access to all three services, ''Tracking'', ''Product Pricing'' and ''Lodgement and Label Printing''. | ||
Line 35: | Line 35: | ||
Once you're finished, submit the form for approval. Generally, you should expect to receive a reply within one business day. | Once you're finished, submit the form for approval. Generally, you should expect to receive a reply within one business day. | ||
− | == Activate your API access == | + | == 4. Activate your API access == |
<gallery widths="200px" heights="200px" class="right"> | <gallery widths="200px" heights="200px" class="right"> | ||
Line 45: | Line 45: | ||
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. | 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 | + | 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. |
− | == Create your first project == | + | == 5. Create your first project == |
<gallery widths="200px" heights="200px" class="right"> | <gallery widths="200px" heights="200px" class="right"> | ||
Line 65: | Line 65: | ||
Click ''Create project'' to create the project. | Click ''Create project'' to create the project. | ||
− | == Create an API key == | + | == 6. Create an API key == |
<gallery widths="200px" heights="200px" class="right"> | <gallery widths="200px" heights="200px" class="right"> | ||
Line 71: | Line 71: | ||
</gallery> | </gallery> | ||
− | You don't have any API keys yet, so click on the link to | + | <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"> | ||
+ | Image:Eparcel setup9.jpg|Choose a name and password | ||
+ | </gallery> | ||
+ | |||
+ | You need to choose a name and a password for the API key. The name can be something simple, like ''API Key 1''. | ||
+ | |||
+ | 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. | ||
+ | |||
+ | <gallery widths="200px" heights="200px" class="right"> | ||
+ | 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 == | ||
+ | |||
+ | * [[Using a fulfilment service]] | ||
+ | * [[Shipping Products using a fulfilment service]] | ||
+ | * [[Activating Australia Post Parcel Contract (formerly eParcel) Fulfilment]] | ||
+ | * [[Shipping Orders with batch fulfilment]] |
Latest revision as of 10:29, 22 August 2022
Spiffy Stores provides an easy to use integration with Parcel Contract (formerly eParcel). There are a number of steps that you need to go through in order to connect your store to your Australia Post Parcel Contract account.
Contents
- 1 1. Establish an Parcel Contract (formerly eParcel) account with Australia Post
- 2 2. Create an Australia Post Developer Centre account
- 3 3. Submit a request for API access
- 4 4. Activate your API access
- 5 5. Create your first project
- 6 6. Create an API key
- 7 7. Choose a name and a password for the API key
- 8 8. Enable the API Services
- 9 Further Reference
1. Establish an Parcel Contract (formerly eParcel) account with Australia Post
You will need to contact Australia Post to establish a Parcel Contract account, if you don't already have one.
Parcel Contract is a fulfillment service provided by Australia Post and is available if you're sending large numbers of parcels. Specific rates are established for your shipments at the time the account is opened.
2. Create an Australia Post Developer Centre account
Your store will communicate with Australia Post using an API key that you need to create using the Developer Centre. You can register for access here using your Australia Post account. You can also use this link to signup for an Australia Post account, if you don't have one. This account will need to be associated with your Parcel Contract account.
Once you've signed in, look for the Shipping and Tracking section, and click on the Register your interest today link.
3. Submit a request for API access
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.
Also, please ensure that you request access to all three services, Tracking, Product Pricing and Lodgement and Label Printing.
On the following page of the form, please specify Spiffy Stores as the Platform Partner.
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
You'll receive an activation email from Australia Post once your request has been approved.
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 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
You need to follow the following steps in order to create a project.
Click on Create new project to begin.
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
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
You need to choose a name and a password for the API key. The name can be something simple, like API Key 1.
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.
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
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 activate the eParcel fulfilment service in your store using your eParcel Account number, API Key and password.