Available Rates API

Usage

This API is used prior to making the label creation API call, this API will return the available carriers and rates for the client based on the origin and destination addresses.

Authentication

A valid access Key must be provided in access_key request header

Parameters

Parameter	Mandatory	Type	Description

Parameter	Mandatory	Type	Description
Origin	Optional		Specify the unique order number from your source system, that was used as the packing slip no when the order was published
Destination	Y		JSON object of destination address
Packages	Y		JSON object array of package objects
Commodities	Y		Refer to Commodity Information
Shiptype	Y	String	the value must always be INBOUND

Commodities Parameters

Parameter	Mandatory	Type	Description	Example

Parameter	Mandatory	Type	Description	Example
Description	Y	String	Product name or description of the item	Leave With Me Dress In Navy Fl
Units	N	Numerical	Count of specific item	1
UnitValue	Y	Decimal	Value of the item per unit	25
UnitKg	Y	Decimal	Weight of the item per unit	0.25
Country	N	String	Country of items origin	New Zealand
Currency	Y	String	Currency of UnitValue	NZD
ItemNo	N	String	Item Number	12312
SKU	Y	String	SKU Number	ST1306B-white

Example Request

Live: https://api.omniparcel.com/ratesqueryv1/availablerates

Staging: https://staging.omniparcel.com/ratesqueryv1/availablerates

Headers

access_key: [access_key_for_site_account]
Content-Type: application/json; charset=utf-8

Body

{
    "DeliveryReference": "orderNumber",
    "Reference2": "RMA",
    "Reference3": "",
    "Origin": {
        "Id": 0,
        "Name": "OriginName",
        "Address": {
            "BuildingName": "",
            "StreetAddress": "285 Main Street",
            "Suburb": "Torrance",
            "City": "CALIFORNIA",
            "PostCode": "90501",
            "CountryCode": "US"
        },
        "ContactPerson": "Origin person name",
        "PhoneNumber": "02 9111 01101",
        "Email": "originemail@test.com"
    },
    "Destination": {
        "Id": 0,
        "Name": "DestinationName",
        "Address": {
            "BuildingName": "VIC",
            "StreetAddress": "285 Coward Street",
            "Suburb": "CARSON",
            "City": "CALIFORNIA",
            "PostCode": "90810",
            "CountryCode": "US"
        },
        "ContactPerson": "JOHN SMITH",
        "PhoneNumber": "02 9111 1111",
        "Email": "destinationemail@test.com",
        "DeliveryInstructions": "",
        "SendTrackingEmail": "false"
    },
    "Commodities": [
        {
            "Description": "Food Bar",
            "Units": "1",
            "UnitValue": 50,
            "UnitKg": 0.6,
            "Currency": "USD",
            "Country": "AU"
        },
        {
            "Description": "Food Bar",
            "Units": "1",
            "UnitValue": 50,
            "UnitKg": 0.6,
            "Currency": "USD",
            "Country": "AU"
        }
    ],
    "Packages": [
        {
            "Height": 1,
            "Length": 1,
            "Width": 1,
            "Kg": 2,
            "Name": "PARCEL",
            "Type": "Box",
            "OverLabelBarcode": ""
        }
    ],
    "issignaturerequired":false,
    "PrintToPrinter":false,
    "IncludeLineDetails":true,
    "ShipType":"INBOUND",
    "SendTrackingEmail":false
    }
    ],
}
}

Response

{  
   "Available":[  
      {  
         "QuoteId":"e7fdf36c-8f6a-4d3f-8d96-c8b5893a0e7f",
         "CarrierId":604,
         "CarrierName":"Omni Parcel",
         "DeliveryType":"AIR TRACKED",
         "Cost":5.82,
         "ServiceStandard":"",
         "Comments":"",
         "Route":"OFFSHORE->AKL- SI",
         "IsRuralDelivery":false,
         "IsSaturdayDelivery":false,
         "IsFreightForward":false,
         "CarrierServiceType":"InternationalCourier"
      }
   ],
   "Rejected":[  

   ],
   "ValidationErrors":{  

   }
}

Response Data Definition

A JSON object array of available rates. These are group into Available, Hidden, Rejected. The Hidden rates, are available rates, but have been filtered out due to user preference, based on cost centre, or destination courier preference.

Available/ Hidden Response Parameters

Parameter	Description

Parameter	Description
QuoteId	Unique rates calculation identifier
CarrierName	Display name of courier provider
DeliveryType	Courier delivery/service type
Cost	Courier Service wording
Comments	Any Extra comments supplied with this rate
Route	Courier provider specific freight routing
IsRuralDelivery	If delivery has been identified as a rural area delivery
IssaturdayDelivery	If delivery has been flagged for Saturday delivery
Isfreightforward	If pickup is originating from an address other than the site address
Carrierservicetype	Carrier provider service type

Rejected Response Parameters

Parameter	Description

Parameter	Description
CarrierName	Display name of courier provider
DeliveryType	Courier delivery/service type
Reason	Reason why this rates line was ignored.