Scoping your integration
This first step is about gathering information and aligning teams to ensure the project starts smoothly. It involves two key parts: completing a questionnaire and holding a technical kick-off call.
The questionnaire
Before the technical work begins, Shippit need to understand your services and capabilities. This section details each of the questions on the questionnaire, and helps you find the appropriate information to complete the section. Your Shippit account manager can send you a link to provide your answers.
The information you provide helps Shippit configure your services correctly on the platform. A complete and accurate questionnaire is crucial for avoiding delays later in the project.
The questions
| Question | Description | Example answer |
|---|---|---|
| Which TMS do you use? | Identifies the Transport Management System (TMS) your business operates. | CargoWise |
| Are the validation criteria we provided enough for you to prevent failed bookings? If not, what else do you require? | Checks if the provided validation rules are sufficient or if there is additional criteria needed to avoid booking errors. | We also require phone number validation |
| Do you make account-specific exceptions for weights and dimensions? If so, can you give an example? | Determines if there are exceptions to dimension rules for specific accounts. | Yes, Account X is allowed parcels up to 1.20m instead of the standard 1.05m |
| Are there any reasons that would prevent you accurately representing your pricing structure using the standard Shippit rate card format? If so, what’s missing? | Determines if the standard rate card format can capture your pricing | We have surcharges for remote areas not covered in the standard format |
| Please confirm that the serviceability format we provided works for you, or detail any challenges. | Shippit uses a serviceability file to define valid collection and delivery regions, this question determines if the file format is compatible. | The format works, but we need to add a field for delivery time windows |
| Do you use the same suburb and postcode combinations as Australia Post? | The serviceability file format assumes that you are using the Australia Post suburb and postcode mapping | Yes |
| Does your zoning logic assume that every suburb is always in the same zone, regardless of the distance between the pickup and drop off | This question determines if your zoning logic matches that used by the Shippit serviceability file. | Yes |
| Does your ETA structure align with Shippit’s ETA structure? | Determines if your Estimated Time of Arrival (ETA) calculations are compatible | Yes |
| Do you make account-specific exceptions for surcharges? If so, can you give an example? | Determines if there are exceptions to surcharges rules for specific accounts. | Account Y is exempt from fuel surcharges |
| Are your flat surcharges based on weights (dead and volumetric), volume, dimensions, or location? If not, what are they based on? | Determines the basis for your surcharges. | Surcharges are based on delivery location and parcel weight |
| Do you have a GS1 account? If not, are you open to applying for one? | Determines if you have a GS1 account for barcoding, or are willing to get one. | No, but we are open to applying for a GS1 account |
| Are there any blockers that would prevent you adopting this format? | Determines if there are any obstacles to using the serviceability file format. | No blockers |
| Are there any blockers that would prevent you adhering to the standard Shippit label format? | Determines if there are any obstacles to using Shippit’s label format. | No blockers |
| Are there any additional fields not included in the standard Shippit label format that are critical for your carrier? | Determines if there are additional fields required for the label. | We need a field for 'Authority to Leave' instructions |
| Are there any blockers that would prevent you adhering to Shippit’s cancellation process? | Determines if there are any obstacles to maintaining Shippit’s cancellation process. | No blockers |
| Does your system accept batch manifesting for at least 25 orders? | Determines if batch manifesting is feasible within your system. | Yes, we support batch manifesting |
| Please provide details of the maximum number of orders you accept in a single batch. | Determines the upper limit for batch processing. | Our system can handle up to 500 orders per batch |
| Do you require a paper manifest? | Determines if manifests must be paper or digital. | No, we accept digital manifests |
| Are there any blockers that would prevent you adhering to Shippit’s tracking process? | Determines if there are any obstacles to maintaining Shippit’s tracking process. | No blockers |
When you send in your completed questionnaire, our team review it, and schedule the technical kick-off call.
Serviceability file
The serviceability file uses these column headers:
| Header | Required | Description | Example |
|---|---|---|---|
courier | Yes | Shippit’s representation of the carrier (provided by Shippit) | carriername |
suburb | Yes | The name of the suburb to map to the zone | Sydney |
postcode | Yes | The postcode to map to the zone | 2000 |
state | No | The state code to map to the zone | NSW |
country | Yes | The country code to map to the zone | AU |
courier_zone | Yes | The code that represents the zone that the suburb belongs to | SYD1 |
pickup | Yes | Can pickups occur in the mapped suburb | Y |
dropoff | Yes | Can dropoffs occur in the mapped suburb | Y |
onforwarding | Yes | Does the mapped suburb support onforwarding | N |
is_country_zone | Yes | Does the zone contain an entire country | N |
sort_code | No | The sort code associated with the suburb and postcode of the delivery, used during labelling | SYD2010 |
Rate card
There are two pricing methods supported by the rate card:
- Fixed pricing
- Weight-based pricing
Fixed pricing is calculated as a fixed price multiplied by the number of articles, with a fuel surcharge added if required.
cost = (fixed_price + price_extra_article × number of articles) × (1 + fuel_surcharge)
Weight-based pricing is calculated based on the chargeable weight of the item. To calculate the chargeable weight, use this formula:
total chargeable weight = CEIL(MAX(total dead weight, total volume / cubic_ratio) / weight_rounding) × weight_rounding
When you have established the chargeable weight, you can use it to determine the cost based on this formula:
cost = MAX((price_order + price_kg × (total chargeable weight - kilos_included) + price_extra_article* number of articles), minimum) × (1 + fuel_surcharge)
The rate card contains this information:
| Category | Header | Required | Description | Example |
|---|---|---|---|---|
| Identifier | courier | Yes | Shippit’s representation of the carrier (provided by Shippit) | carriername |
| Identifier | account_number | Yes | The account number configured by the merchant to identify the customer of the carrier | 123456 |
| Pricing - fixed | fixed_price | Yes | The fixed cost for this rate | 10.00 |
| Pricing - weight | price_order | Yes | The base price for the rate | 5.00 |
| Pricing - weight | price_kg | Yes | The price per kg added onto the base price | 2.50 |
| Pricing - weight | weight_rounding | Yes | The number of decimals to round up by (1 = 0.1, 2 = 0.01, etc) | 1 |
| Pricing - weight | kilos_included | No | The number of kg already included in price_order (subtracts this from total weight in calculation) | 3 |
| Pricing - weight | cubic_ratio | Yes | The cubic ratio used to calculate volumetric (cubic) weight | 250 |
| Pricing - weight | minimum | Yes | The minimum price charged irrespective of weight or number of articles | 8.00 |
| Pricing | price_extra_article | Yes | The cost for every additional article past the first | 1.00 |
| Pricing | fuel_surcharge | Yes | The fuel surcharge percentage to add to the cost | 0.12 |
| Pricing | small_margin | Yes | The small margin to apply (set to 0) | 0 |
| Pricing | medium_margin | Yes | The medium margin to apply (set to 0) | 0 |
| Pricing | large_margin | Yes | The large margin to apply (set to 0) | 0 |
| Quote | product_code | Yes | The product code associated with the quote | EXPRESS |
| Quote | delivery_timeframe | Yes | The ETA (in days) associated with the quote | 2 |
| Validation - lane | pickup_zone | Yes | The pickup zone of the lane this rate is for (from serviceability file) | SYD1 |
| Validation - lane | delivery_zone | Yes | The drop off zone of the lane this rate is for (from serviceability file) | MEL1 |
| Validation - weight | minimum_weight | Yes | The minimum total chargeable weight; if not exceeded, the rate is invalid | 0.5 |
| Validation - weight | fixed_price_weight_limit | Yes | The maximum total dead weight; if exceeded, the rate is invalid | 20 |
| Validation - weight | fixed_price_volumetric_limit | Yes | The maximum total volumetric weight. If exceeded, the rate is invalid (use cubic_ratio to calculate volumetric weight) | 40 |
| Validation - weight | article_weight_limit | Yes | The maximum article dead weight; if exceeded, the rate is invalid | 10 |
| Validation - weight | article_volumetric_limit | Yes | The maximum article volumetric weight. If exceeded, the rate is invalid (use cubic_ratio to calculate volumetric weight) | 15 |
| Validation - dimensions | max_dimension_cm | Yes | If the maximum dimension from any article exceeds this value, the rate is invalid | 120 |
| Validation - dimensions | min_dimension_upper_bound_cm | Yes | If the minimum dimension from any article exceeds this value, the rate is invalid | 10 |
| Validation - dimensions | med_dimension_upper_bound_cm | Yes | If the median dimension from any article exceeds this value, the rate is invalid | 60 |
| Validation - dimensions | max_parcel_combined_length_cm | Yes | If the maximum combined dimension (length + depth + width) from any article exceeds this value, the rate is invalid | 200 |
| Validation - other | max_article_count | Yes | The maximum number of articles; if exceeded, the rate is invalid | 5 |
| Validation - other | requires_atl | Yes | If Y and the order doesn’t have authority to leave, the rate is invalid | N |
The technical kick-off call
This meeting formally begins the integration project and ensures both teams agree on the scope and timeline. The goal of the call is to review the technical requirements, confirm the project plan, and answer any initial questions you may have.
It’s important that your designated technical contact and any project managers responsible for the integration attend this call.
The agenda for the call includes:
- Introductions of the key contacts from both Shippit and your team
- A final review of the information you provided in the questionnaire
- Confirmation of your chosen tracking method and its technical requirements
- A walk through the project timeline, milestones, and the next steps
- An open question and answer session to cover any other concerns
After this call, both teams should have a clear understanding of the project and are ready to move on to technical configuration.