About 3 min
ratesqueryv1/createandprint [DEPRECATED]
Description
This endpoint is deprecated, please use POST api/shipments instead.
This method is used to create new shipments.
There are 2 pre-conditions that need to be considered before calling this method.
- Does your workflow require you to display/calculate the freight costs and options prior to creating the shipment?
- Does your workflow already know which carrier is to be used for creating the shipment?
1. Display/Calculate rates first
In this scenario, you need to call the POST api/rates endpoint first to resolve the different price options you may have. Every option is accompanied by a QuoteId which needs to be retain to be used with the create shipment method.
2. Create by Carrier Name and service
In this scenario, you won't know the cost of the freight for the shipment till after the shipment is created. You will request the shipment to be used by specifying the carrier name, and service.
Printing - if the access_key has an associated printer setup, the print job is activated by default. This can be turned off by specifying PrintToPrinter="false"
Request
- Method:
POST - Content Type:
application/json - URL:
https://api.gosweetspot.com/ratesqueryv1/createandprint
Headers
- access_key : your unqiue api key provided by GSS.
- site_id : which site you are requesting action for.
Parameters
You need to extend the POST api/rates post body to include other fields specified below.
When QuoteId is supplied, the carrier and service fields are ignored. They should be used in exclusive pattern.
| Parameter | Type | Description |
|---|---|---|
| QuoteId | string | Unique quote identifier returned on the POST api/rates endpoint query. |
| 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 | 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. "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. |
| CustomField1Value | string | Value of "Custom field 1" in Site Settings, only able to take the value when "Custom Field 1 Enabled" under "Internal References" is checked. Will response error when "Custom Field 1 Mandatory" is checked and the field is missing. |
| CustomField2Value | string | Value of "Custom field 2" in Site Settings, only able to take the value when "Custom Field 2 Enabled" under "Internal References" is checked. Will response error when "Custom Field 2 Mandatory" is checked and the field is missing. |
| outputs | string list | optional - JSON string list. Returns output of label as a PNG or PDF. Acceptable value are Print Output Formats. |
| hasdg | boolean | True of false - does your shipment contain any dangerous goods. |
| dangerousgoods | object | JSON object of dangerous goods. |
| RecipientTaxId | string | Optional, Goods shipped into or transiting through certain countries will need to have this value. |
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 'http://api.gosweetspot.com/ratesqueryv1/createandprint' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json' \
--data-raw '{
"QuoteId": "f2878ff8-107f-4ca3-9d2e-3ca943b6d808",
"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,
"Commodities": [
{
"Description": "Apparel",
"UnitKg": 0.33,
"UnitValue": 1,
"Units": 1,
"Country": "NZ",
"Currency": "NZD"
}
],
"Outputs": [
"LABEL_PDF"
]
}'
Response example
Binary blocks below have been trimmed for presentation.
{
"CarrierId": 102,
"CarrierName": "Post Haste",
"IsFreightForward": false,
"IsOvernight": true,
"IsSaturdayDelivery": false,
"IsRural": false,
"HasTrackPaks": true,
"Message": "Connote created and print queued.",
"Errors": [
],
"SiteId": 4180,
"Consignments": [
{
"Connote": "SSPOT012864",
"TrackingUrl": "http://gosweetspot.com/track/4180-SSPOT012864",
"Cost": 9.22,
"CarrierType": 13,
"IsSaturdayDelivery": false,
"IsRural": false,
"IsOvernight": true,
"HasTrackPaks": true,
"ConsignmentId": 1830322,
"OutputFiles": {
"LABEL_PDF": [
"JVBERi0xLjQKJdP0..."
]
}
}
],
"Downloads": [ ],
"CarrierType": 13,
"AlertPath": null
}