ratesquery/printcheapestcourier

Description

This interface allows you to create a shipment with the cheapest courier option available.

Upon creating the shipment, the print command can also be automatically initiated. This print command requires the Print Agent to be installed and available.

Request

• Method: POST
• Content Type: application/json
• URL: https://api.gosweetspot.com/ratesquery/printcheapestcourier

Headers

• access_key : your unqiue api key provided by GSS.
• site_id : which site you are requesting action for.

Parameters

Parameter	Type	Description
Carrier	string	Name of the carrier to use for the shipment. You can query the POST api/availableservices endpoint to find the valid carrier names. You can also pass '*' to choose the cheapest of any carrier.
Service	string	Carrier service name, for which the shipment should be created for. If not supplied, the cheapest price option is selected
origin	object	Leave blank when using site address, or provide one for freight forwards (Contact Model).
destination	object	Recepient address details (Contact Model).
packages	object list	Array of package sizes (Rate Package Model).
issaturdaydelivery	boolean	Is saturday delivery required?
issignaturerequired	boolean	Is signature on delivery required?
dutiesandtaxesbyreceiver	boolean	Where duties are due, is the receiver paying for these?
deliveryreference	string	Order reference, max length is 50.
commodities	object list	Customs declared commoditiy information. Only required for international shipments.
printtoprinter	string	Use "true" to send a print request to your default printer. Use "false" indicates no printing is required. You can also put a printer name here and the print request would be sent directly to that printer
outputs	string list	optional - JSON string list. Returns output of label as a PNG or PDF. Acceptable value are Print Output Formats

Return format

A JSON object with the created shipment details.

Response

Attribute	Type	Description
carrier	string	Internal system carrier identifier.
carriername	string	Courier provider name.
isfreightforward	boolean	Is shipment a freight forward shipment.
message	string	Action outcome message.
errors	string list	List of error messages.
siteid	integer	Account site id.
consignments	object list	JSON object arrary or consignments created. Generally only 1 is created, however were a split is required, more could be created (Consignment Model)

Request example

curl --location --request POST 'https://api.gosweetspot.com/api/rates' \
--header 'Content-Type: application/json' \
--header 'access_key: nikhi-74-4EFF2E1BE49E807E89DF1790C4407921CD813B2C1' \
--header 'site_id: 108633' \
--data-raw '{
  "DeliveryReference": "ORDER123",
  "Destination": {
    "Id": 0,
    "Name": "DestinationName",
    "Address": {
      "BuildingName": "",
      "StreetAddress": "DestinationStreetAddress",
      "Suburb": "Avonside",
      "City": "Christchurch",
      "PostCode": "8061",
      "CountryCode": "NZ"
    },
    "ContactPerson": "DestinationContact",
    "PhoneNumber": "123456789",
    "Email": "[email protected]",
    "DeliveryInstructions": "Desinationdeliveryinstructions"
  },
  "IsSaturdayDelivery": false,
  "IsSignatureRequired": true,
  "Packages": [
    {
      "Height": 1,
      "Length": 1,
      "Id": 0,
      "Width": 10,
      "Kg": 0.1,
      "Name": "GSS-DLE SATCHEL",
      "PackageCode": "DLE",
      "Type": "Box"
    }
  ],
  "PrintToPrinter": true
}'

Response example

{
  "CarrierId": 102,
  "CarrierName": "Post Haste",
  "IsFreightForward": false,
  "IsOvernight": true,
  "IsSaturdayDelivery": false,
  "IsRural": false,
  "HasTrackPaks": true,
  "Message": "Printer invalid. Job created but not queued.",
  "Errors": [],
  "SiteId": 4180,
  "Consignments": [
    {
      "Connote": "SSPOT012863",
      "TrackingUrl": "http://gosweetspot.com/track/4180-SSPOT012863",
      "Cost": 7.52,
      "CarrierType": 13,
      "IsSaturdayDelivery": false,
      "IsRural": false,
      "IsOvernight": true,
      "HasTrackPaks": true,
      "ConsignmentId": 1830321,
      "OutputFiles": null
    }
  ],
  "Downloads": [],
  "CarrierType": 13,
  "AlertPath": null
}