4.0 Available Rates API

4.1 Available Rates API

Requires Authentication

A valid access Key must be provided in access_key request header.

Note: If you do require available rates without validation please contact your account manager with a valid reason why you would like to call available rates API without address validation.

4.2 Parameters Required

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
IsSignatureRequired	Optional	Boolean	If “true” Signature on Delivery required. If “false” no signature on delivery
IsSaturdayDelivery	Optional	Boolean	If delivery has been flagged for Saturday delivery
DeliveryReference	Y	String (60 characters)	Shipment reference number
DutiesAndTaxesByReceiver	Optional	Boolean
Ruraloverride	Optional	Boolean
IsRural	Optional	Boolean	If delivery has been identified as a rural area delivery
DeliveryInstructions	Optional	String	Special instructions to print on the label. For origin this field is ignored.
CostCentreId	Optional	Integer
ExplicitNotRural	Optional	Boolean	when true not rural surcharges are added

4.3 Example request

Endpoints

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

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

Request

Header

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

Body

{  
   "DeliveryReference":"ORDER123",
   "Destination":{  
      "Id":0,
      "Name":"DestinationName",
      "Address":{  
         "BuildingName":"",
         "StreetAddress":"DestinationStreetAddress",
         "Suburb":"Avonside",
         "City":"Christchurch",
         "PostCode":"8061",
         "CountryCode":"NZ"
      },
      "ContactPerson":"DestinationContact",
      "PhoneNumber":"123456789",
      "Email":"destinationemail@email.com",
      "DeliveryInstructions":"Desinationdeliveryinstructions"
   },
   "IsSaturdayDelivery":false,
   "IsSignatureRequired":true,
   "Packages":[  
      {  
         "Height":1,
         "Length":1,
         "Id":0,
         "Width":10,
         "Kg":0.1,
         "Name":"SATCHEL",
         "PackageCode":"DLE",
         "Type":"Box"
      }
   ]
}

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 grouped into Available, Hidden, Rejected. “Hidden” rates are available rates, but have been filtered out due to user preference, based on cost centre, or destination courier preference.

4.4 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

4.5 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.

ValidationErrors (Error Response Parameters)

If there are any validation errors these are reported via the ValidationErrors JSON object.

Parameter	Description
Key	Field name
Value	Reason for validation failure

Return to the top

SEKO Omni Retailer Support Centre