GoSweetSpot: Models

Available Rate Model

Attribute	Type	Description
quoteId	Guid	Unique rates calculation identifier.
carrierId	integer	Id of carrier.
carriername	string	Display name of courier provider.
deliverytype	string	Courier delivery/service type.
cost	decimal	Freight cost.
servicestandard	string	Courier service wording.
comments	string	Any extra comments supplied with this rate.
route	string	Courier provider specific freight routing.
isruraldelivery	boolean	If delivery has been identified as a rural aread delivery.
issaturdaydelivery	boolean	If delivery has been flagged for saturday delivery.
isresidential	boolean	If delivery has been flagged for a residential delivery.
carrierservicetype	string	Carrier provider service type.

Commodity Model

Attribute	Type	Description
harmonizedCode	string	Optional, a 6-digit HS tariff code/s (harmonized code) for all international shipments.
description	string	Description of the commodity.
unitvalue	decimal	Value per unit.
units	int	Number of commodities.
unitKg	decimal	Weight kg per unit.
currency	string	Declared value currency designation, eg NZD, AUD, USD, max length is 3.
country	string	ISO Alpha 2 country code for the Country of Manufacture of goods, eg, NZ, AU, US, GB, CN, CA, etc, max length is 2.

Consignment Model

Attribute	Type	Description
connote	string	Courier provider connote number.
trackingurl	string	Direct url to track and trace this shipment.
connote	string	Courier provider connote number.
cost	decimal	Total cost of shipment, excluding taxes.
carriertype	string	Internal carrier classification.
issaturdaydelivery	boolean	Whether saturday delivery service was applied.
isrural	boolean	Whether delivery identified as rural.
isovernight	boolean	Whether service is overnight where delivery is inter island.
hastrackpaks	boolean	Whether this shipment has any trackpaks on it.
outputs	string list	List with requested output file as Base64 encoded string.

Contact Address Model

Attribute	Type	Description
buildingname	string	Property identifier, such as Unit 1, Level 10, Panasonic House, etc, max length is 50.
streetaddress	string	Street number and name, max length is 50.
suburb	string	Suburb name, max length is 50.
city	string	City or state name. In countries where there are official states, use use use state abbreviations, such as California = CA, New South Wales = NSW, etc., max length is 50.
postcode	string	Postal code, max length is 50.
countrycode	string	ISO Alpha 2 country code, eg, NZ, AU, US, GB, CN, CA, etc, max length is 2.

Contact Model

Attribute	Type	Description
name	string	Company name or persons name, max length is 50.
contactperson	string	Contact person at address, optional, max length is 50.
phonenumber	string	Phone number, optional, max length is 50.
isrural	boolean	Optional, indicate is the address rural.
deliveryinstructions	string	Special instructions to print on the label. For origin this field is ignored, max length is 120.
sendtrackingemail	boolean	Optional, is sending tracking email to it?
costcentreid	integer	Optional, which cost centre to use.
explicitnotrural	boolean	When true not rural surcharges are added.
address	object	JSON Object for contact's address.

Customer Order Model

Attribute	Type	Description
packingslipno	string	Unique order number or packing slip number from your system.
consignee	string	Receipient name.
address1	string	Address line 1, street number.
address2	string	Address line 2, street name.
suburb	string	Suburb name.
city	string	City name or state name. Depending on destination country, if state information is available, this should be the abbreviated state code
postcode	string	Post code, for NZ addresses, this can be left blank if unknown.
country	string	ISO Alpha 2 country code, eg NZ, AU, US, UK, CN.
delvref	string	Order number, or customer reference for this order.
delvinstructions	string	Any specific instructions to be printed on the label.
contactname	string	Name of person, optional.
contactphone	string	Phone number of person, optional.
email	string	Email address.
isrural	string	Is the address a rural delivery address.
notrural	string	Override and declared as not rural.
costcentre	string	Cost centre to use.
status	object	Current status of the order
products	object	Array of line products on order

Customer Order Package Model

Attribute	Type	Description
packageStockName	string	Specify the name of the package here, e.g. GSS-A5 Satchel. The package needs to be previously configured here.
quantity	int	Required.
weightKg	float	Optional, if this is not present, will use the default weight of the package.
lengthCm	float	Optional, this parameter will be ignored if the package is a SATCHEL type.
widthCm	float	Optional, this parameter will be ignored if the package is a SATCHEL type.
heightCm	float	Optional, this parameter can be edited even if the package is a SATCHEL type.

Dangerous Goods Model

Attribute	Type	Description
additionalhandinginfo	string	Additional handing information, max length is 100.
hazchemcode	string	Hazchem code.
isradioactive	boolean	Is goods radio active.
isRoadTransport	boolean	Is goods RoadTransport default true.
cargoaircraftonly	boolean	Is Cargo Aircraft Only.
isDGLQ	boolean	Is dangerous goods limited quantities.
totalQuantity	string	Total quantity of dangerous goods, required, max length is 200.
totalKg	decimal	Total weight KG of dangerous goods, required.
signoffName	string	Max length is 50, optional.
signoffRole	string	Max length is 50, optional.
lineitems	object list	A list of dangerous goods item.

Dangerous Goods Item Model

Attribute	Type	Description
description	string	max length is 100
classordivision	string	max length is 50
unoridno	string	max length is 50
packinggroup	string	max length is 50
subsidaryrisk	string	max length is 50
packing	string	max length is 50
packinginstr	string	max length is 50
authorization	string	max length is 50

Product Model

Attribute	Type	Description
productcode	string	SKU of Product.
description	string	Name of Product.
units	integer	Units ordered.
unitvalue	decimal	Value per unit.
countryofManufacture	string	ISO Alpha 2 country code, eg NZ, AU, US, UK, CN.
imageurl	string	An image of the product.
currency	string	3 letters code for currency.
alreadySent	integer	Amount of product fulfilled prior to this order.
fulfilledQty	integer	Mount of product fulfilled on this order.
linetotal	decimal	Total value of this order.
bin	string	Picking location in warehouse, printed on packlingslip.

Print Output Model

Type	Description
LABEL_PNG_100X175	label is presented as a PNG image with dimension 100mm x 175mm
LABEL_PNG_100X150	label is presented as a PNG image with dimension 100mm x 150mm
LABEL_PDF_100X175	label is presented as a PDF with dimension 100mm x 175mm
LABEL_PDF_100X150	label is presented as a PDF with dimension 100mm x 150mm
LABEL_ZPL_100X150	label is presented as a 200DPI ZPL with dimension 100mm x 150mm
LABEL_ZPL_100X150_300DPI	label is presented as a 300DPI ZPL with dimension 100mm x 150mm
LABEL_PDF_LABELOPE	label is presented as a PDF Labelope. Rotation is not supported
USER_CONFIGURED	Depends on user's selection. Label is presented as a PDF when User's Printing Settingopen in new window is PDF file, or a PRN file is presented if User's Printing Settingopen in new window is GoPrint - PRN Download. If Print Agent is selected, no file is returned and a print is triggered to the agent.
GOPRINT_PRN	A PRN file is presented in base64 format. This needs to be decoded to a normal string and saved as a prn file to the folder that GoPrint is monitoring.

Rate Package Model

Attribute	Type	Description
name	string	Package custom name, which are configured in Ship for your account in Ship under Administration > Stock Sizes. If none available, use "custom", max length is 50.
length	integer	Package length in centimetres.
width	integer	Package width in centimetres.
height	integer	Package height in centimetres.
kg	decimal	Package weight in kilograms.
type	string	Package type, eg, Box, Carton, Satchel, Bag, Pallet, etc, max length is 10.
packagecode	string	Trackpack codes, such as DLE, A5, A4 (please consult support before providing a value in this field) This feature is not available on all accounts, max length is 5.

Rate Validation Error Model

Attribute	Type	Description
key	string	Field name.
value	string	Reason of validation failure.

Reject Rate Model

Attribute	Type	Description
carriername	string	Courier provider name.
deliverytype	string	Courier delivery/service type.
reason	string	Reason why this rates line was ignored.

Shipment Model

Attribute	Type	Description
ConsignmentNo	string	Shipment consignment number.
Consignee	string	Shipment consignee name.
ManualTicket	boolean	False when the shipment originated from an external orders source, such as an integrated system or shopfiy. True when the ticket was create using the GSS UI.
PackingSlipNo	string	Order/packing slip number for integrated orders or Delivery Reference when created using the GSS UI.
Picked	datetime (nullable)	Date/time goods picked by courier. Time local to pickup origi.
Delivered	datetime (nullable)	Date/time goods delivered to receiver. Time local to delivery address.
Status	string	Latest courier tracking status of the shipment.
TotalCost	decimal	Total cost of the shipment excluding taxes where applicable.
Tracking	string	Track and trace url for live tracking of the order.
OriginZone	string	Short code for the origin zone of the consignment.
DestinationZone	string	Short code for the destination zone of the consignment.
CostCentre	string	Name of the associated cost centre.
Carrier	string	Carrier name.
DeliveryInstructions	string	Instructions for delivery driver.
IsSaturdayDelivery	bool	If delivery will be attempted on Saturday, when applicable.
IsRuralDelivery	bool	If the destination has been determined to be rural.
IsResidentialDelivery	bool(Nullable)	If the destination has been determined to be residential.
IsPOBox	bool	If the destination has been determined to be a PO Box, ParcelPod, etc.
CustomerRef	string	Reference number.
TotalCubic	decimal	Sum of cubic volume of all items in this consignment. Denoted in m3.
CreatedUtc	datetime	When the shipment has been created
CreatedBy	string	Who created the shipment
TotalKg	decimal	Sum of weight of all items in this consignment. Denoted in kg.
Parts	int	Number of items in this consignment.
IsSignatureRequired	bool	True if the delivery driver needs to collect a signature.
IsFreightForward	bool	True if this is a freight-forward consignment.
ManifestedAt	datetime (nullable)	Date and time manifestedAt. null when not manifest yet.
ManifestNumber	string	ManifestNumber of shipment.
Parts	int	Number of items in this consignment.
Origin	object	Sender details. (Contact Model)
Destination	object	Destination details. (Contact Model)
Items	object list	Shipment packages. (Shipment Package Model)

Shipment Event Model

Attribute	Type	Description
Part	string	Shipment part number.
Code	string	Event milestone code CR - Created PUP - Picked up from sender UPD - Courier status update provided EXP - delivery exception, or service update DEL - Delivery completed
Description	string	Event description.
eventDt	DateTime	date/time of event/activity local to location of event.
Location	string	Area/locality of where the event occurred.

Shipment Package Model

Attribute	Type	Description
PartNo	integer	The part number of the consignment - e.g. 1, 2, 3 etc.
LengthCm	decimal	Length of the package in centimeters.
WidthCm	decimal	Width of the package in centimeters.
HeightCm	decimal	Height of the package in centimeters.
WeightKg	decimal	Weigth of the package in kg.
PackageName	string	Name of the package - e.g. GSS A4 Satchel.
Charge_LineTotal	decimal	Total charge determined for this item at the time of consignment creation.
Charge_MarkedUpLineTotal	decimal	Total charge with mark up (if defined) determined for this item at the time of consignment creation.
PickedAt	DateTime (Nullable)	Date and time this item was picked up - will be null if not yet picked up.
DeliveredAt	DateTime (Nullable)	Date and time this item was delivered - will be null if not yet delivered.
RatingCode	string	The rating code of this item.
Events	object list	The shipment events of this item. Shipment Event Model

Shipment Options Model

Attribute	Type	Description
Contact	string	Contact name.
street	string	Street number and name.
suburb	string	Suburb name.
city	string	City or state name. In countries where there are official states, use state abbreviations, such as California = CA, New South Wales = NSW, etc.
postcode	string	Postal code.
countrycode	string	ISO Alpha 2 country code, eg, NZ, AU, US, GB, CN, CA, etc

Status Model

Attribute	Type	Description
status	string	Current status.
ticketnumber	string	If printed already, the current ticket number.
trackingurl	string	Url to track the order.
picked	datetime	Local date time of when shipment was picked up.
delivered	datetime	Local date time of when shipment was delivered.
manualticket	boolean	Whether the ticket was created manually or via an integrated channel feed.

Stock size Model

Attribute	Type	Description
PackageStockId	integer	GoSweetSpot generated an unique identifier for each Stock Size
Name	string	Name of the stock size.
Height	decimal	Height of the stock size.
Length	decimal	Length of the stock size.
Width	decimal	Width of the stock size.
Cubic	decimal	Cubic(M3) of the stock size.
Weight	decimal	Weight of the stock size.
Type	string	Type of the stock size - Box, Carton, etc.
Sort	integer	Sequence of all stock sizes on Ship UI.
IsTrackPak	boolean	Represents if if the stock size is trackable.
HeightAdjustable	boolean	Represents if user can adjust the height of the stock size.
Availability	string	Represents access scope of the stock size: Me_Only - only current user can use the stock size. This_Site_Only - users on the site. Entire_Group - users on the bussiness account.

V2 Address Validation Service Model

Attribute	Type	Description
carrier	string	Name of carrier.
isresidential	boolean	Indicates if this is a residential service.
isrural	boolean	Indicates if this is a rural service.
hassaturdayservice	boolean	Indicates if saturday delivery is a possible service.
branchcode	string	The branch code of the branch serving this address.
runnumber	string	Run number.

V2 Address Validation Response Model

Attribute	Type	Description
buildingname	string	Property identifier, such as Unit 1, Level 10, Panasonic House, etc. Max length is 50.
streetaddress	string	Street number and name, max length is 50.
suburb	string	Suburb name, max length is 50.
city	string	City or state name. In countries where there are official states, use use use state abbreviations, such as California = CA, New South Wales = NSW, etc. Max Length is 50
postcode	string	Postal code. Max Length is 50.
countrycode	string	ISO Alpha 2 country code, eg, NZ, AU, US, GB, CN, CA, etc. Max length is 2.
AvailableServices	object list	Available service for this address.

V2 Shipment Status Event Model

Attribute	Type	Description
eventdate	datetime	Date and time of event. Local to region where it occurred.
code	string	Event status code: CR - Created INTL - International Transit CUST - Customs Cleared COUR - Courier picked up COURU - courier update DEL - Delivered
description	string	Event description.
location	string	Locality of where event took place.
part	string	Shipment item identifier.

V2 Validation Adress Model

Attribute	Type	Description
buildingname	string	Property identifier, such as Unit 1, Level 10, Panasonic House, etc. Max length is 50.
streetaddress	string	Street number and name, max length is 50.
suburb	string	Suburb name, max length is 50.
city	string	City or state name. In countries where there are official states, use state abbreviations, such as California = CA, New South Wales = NSW, etc. Max Length is 50.
postcode	string	Postal code. Max Length is 50.
countrycode	string	ISO Alpha 2 country code, eg, NZ, AU, US, GB, CN, CA, etc. Max length is 2.

Related Articles
GoSweetSpot: Labels
Labels in Queue Description Queue a provided image file for printing via the print application. Requests Method: POST Content Type: application/json URL: https://api-docs.gosweetspot.com/docs/labels/post.html Headers access_key : your unique API key ...
GoSweetSpot: Webhooks
Description GSS can provide feedback to your site using webhooks for certain action triggers. Actions that can be subscribed to include: Shipment created Shipment pickup registered by courier Shipment delivery registered by courier Shipment tracking ...
GoSweetSpot: Shipments
Get Shipment Updates Description Get status updates for shipments. Requests Method: GET Content Type: application/json URL: https://help.nzcouriers.co.nz/gosweetspot-api-integration/gosweetspot-shipments Headers access_key : your unique API key ...
GoSweetSpot: Rates
Description Query to get available courier services and rates for the destination. Requests Method: POST Content Type: application/json URL: https://api-docs.gosweetspot.com/docs/rates/post.html Headers access_key : your unique API key provided by ...
GoSweetSpot eCommerce Integrations
For an up to date list of out-of-the-box integrations & self-service setup instructions, see; gosweetspot.com/integration-platforms-erp

GoSweetSpot: Models

GoSweetSpot: Models

Available Rate Model

Commodity Model

Consignment Model

Contact Address Model

Contact Model

Customer Order Model

Customer Order Package Model

Dangerous Goods Model

Dangerous Goods Item Model

Product Model

Print Output Model

Rate Package Model

Rate Validation Error Model

Reject Rate Model

Shipment Model

Shipment Event Model

Shipment Package Model

Shipment Options Model

Status Model

Stock size Model

V2 Address Validation Service Model

V2 Address Validation Response Model

V2 Shipment Status Event Model

V2 Validation Adress Model

Related Articles

GoSweetSpot: Labels

GoSweetSpot: Webhooks

GoSweetSpot: Shipments

GoSweetSpot: Rates

GoSweetSpot eCommerce Integrations