Skip to content

Latest commit

 

History

History
579 lines (562 loc) · 24.5 KB

get.md

File metadata and controls

579 lines (562 loc) · 24.5 KB
Raw

Shipments

GET https://api.gosweetspot.com/api/shipments

Description

Get status updates for shipments

Requires authentication

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

Parameters

Parameters
shipments comma separated list of consignment numbers to apply filter on
ordernumbers comma separated list of order numbers to apply filter on
lastupdateminutc UTC formatted date and time to filter the shipments on. This field is for earliest date
lastupdatemaxutc UTC formatted date and time to filter the shipments on. This field is for latest date
* when the *shipments* or *ordernumbers* values is provided, the *lastupdateminutc* & *lastupdatemaxutc* values are ignored.

Return format

return
struct		 paged result set
page current page number
pages total number of pages
pagesize how many records returned per result set
results[] a list of up to 250 shipments
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 date time date/time goods picked by courier. Time local to pickup origin
Delivered date time 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.
IsPOBox bool If the destination has been determined to be a PO Box, ParcelPod, etc.
CustomerReference string Reference number.
TotalCubic decimal Sum of cubic volume of all items in this consignment. Denoted in m3.
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.
Parts int Number of items in this consignment.
Origin Struct
Building string
Address string
Name string
Suburb string
Town string
PostalCode string
Country string
ContactName string
ContactPhone string
Email string
Destination Struct
Building string
Address string
Name string
Suburb string
Town string
PostalCode string
Country string
ContactName string
ContactPhone string
Email string
Items Struct
PartNo int The part number of the consignment - e.g. 1, 2 , 3 etc.
LengthCm decimal
WidthCm decimal
HeightCm decimal
WeightKg decimal
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.
PickedAt Nullable DateTime Date and time this item was picked up - will be null if not yet picked up.
DeliveredAt Nullable DateTime Date and time this item was delivered - will be null if not yet delivered.
RatingCode string The rating code of this item.
Events return[]
struct		 a list of track and trace events per part of the shipment
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
Description string Event description
eventDt date time date/time of event/activity local to location of event
Location string Area/locality of where the event occurred
***

Example

Request

GET http://api.gosweetspot.com/api/shipments?lastupdateminutc=2015-08-13%2008:15:13&page=1&shipments=ABC0001,ABC0002,ABC20303

Headers

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

Return shortened for example purpose

{
  "Page": 1,
  "PageSize": 2,
  "Pages": 1,
  "Results": [
    {
      "OriginZone": "AKLW",
      "DestinationZone": "AKL",
      "Origin": {
        "Building": "**** TEST ********* TEST *****",
        "Address": "**** TEST ********* TEST *****",
        "Name": "TEST ACCOUNT",
        "Suburb": "MT ROSKILL",
        "Town": "AUCKLAND",
        "PostalCode": "0600",
        "Country": "NZ",
        "ContactName": "TEST",
        "ContactPhone": "123456",
        "Email": ""
      },
      "Destination": {
        "Building": "GOSWEETSPOT",
        "Address": "102 STATION ROAD EAST",
        "Name": "DON ZHANG",
        "Suburb": "PENROSE",
        "Town": "AUCKLAND",
        "PostalCode": "1061",
        "Country": "NZ",
        "ContactName": "RECEIVER NAME",
        "ContactPhone": "212563080",
        "Email": ""
      },
      "CostCentre": "TEST COST CENTRE ONE",
      "Carrier": "Post Haste - AKL - 2011",
      "DeliveryInstructions": "",
      "IsSaturdayDelivery": false,
      "IsRuralDelivery": false,
      "IsPOBox": false,
      "CustomerRef": "#1029",
      "TotalCubic": 0.022,
      "TotalKg": 5.5,
      "Parts": 1,
      "IsSignatureRequired": true,
      "IsFreightForward": false,
      "ManifestedAt": null,
      "Items": [
        {
          "PartNo": 1,
          "LengthCm": 47,
          "WidthCm": 47,
          "HeightCm": 10,
          "WeightKg": 5.5,
          "PackageName": "SMALL BOX",
          "Charge_LineTotal": 9.98,
          "PickedAt": null,
          "DeliveredAt": null,
          "RatingCode": "MS"
        }
      ],
      "ConsignmentNo": "APD00020626",
      "Status": null,
      "Picked": null,
      "Delivered": null,
      "Tracking": "https:\/\/gosweetspot.com\/track\/108633-APD00020626",
      "Events": [
      	{
      		"EventDT": "2019-10-10T22:57:57.047",
      		"Code": "CR",
      		"Description": "Tracking number allocated & order ready",
      		"Location": "AUCKLAND",
      		"Part": "APD0002062601"
      	},
      	{
      		"EventDT": "2019-10-10T22:57:57.047",
      		"Code": "COUR",
      		"Description": "Picked up",
      		"Location": "PENROSE (AKL)",
      		"Part": "APD0002062601"
      	},
      	{
      		"EventDT": "2019-10-10T22:57:57.047",
      		"Code": "COURU",
      		"Description": "On courier vehicle for delivery",
      		"Location": "Glenfield Industrial Wairau Valley (AKL)",
      		"Part": "APD0002062601"
      	},
      	{
      		"EventDT": "2019-10-10T22:57:57.047",
      		"Code": "DEL",
      		"Description": "Delivered to ANDREW",
      		"Location": "Glenfield Industrial Wairau Valley (AKL)",
      		"Part": "APD0002062601"
      	}
      ],
      "ManifestNumber": "ABCD",
      "TotalCost": 9.98,
      "CreatedUtc": "2019-10-10T22:57:57.047",
      "PackingSlipNo": "#1029",
      "ManualTicket": false,
      "Consignee": "RECEIVER NAME"
    },
    {
      "OriginZone": "AKLW",
      "DestinationZone": "AKL",
      "Origin": {
        "Building": "**** TEST ********* TEST *****",
        "Address": "**** TEST ********* TEST *****",
        "Name": "TEST ACCOUNT",
        "Suburb": "MT ROSKILL",
        "Town": "AUCKLAND",
        "PostalCode": "0600",
        "Country": "NZ",
        "ContactName": "TEST",
        "ContactPhone": "123456",
        "Email": ""
      },
      "Destination": {
        "Building": "GOSWEETSPOT",
        "Address": "101 STATION ROAD EAST",
        "Name": "RECEIVER NAME",
        "Suburb": "PENROSE",
        "Town": "AUCKLAND",
        "PostalCode": "1061",
        "Country": "NZ",
        "ContactName": "RECEIVER NAME",
        "ContactPhone": "212563080",
        "Email": ""
      },
      "CostCentre": "TEST COST CENTRE ONE",
      "Carrier": "Post Haste - AKL - 2011",
      "DeliveryInstructions": "",
      "IsSaturdayDelivery": false,
      "IsRuralDelivery": false,
      "IsPOBox": false,
      "CustomerRef": "#1031",
      "TotalCubic": 0.022,
      "TotalKg": 5.5,
      "Parts": 1,
      "IsSignatureRequired": true,
      "IsFreightForward": false,
      "ManifestedAt": null,
      "Items": [
        {
          "PartNo": 1,
          "LengthCm": 47,
          "WidthCm": 47,
          "HeightCm": 10,
          "WeightKg": 5.5,
          "PackageName": "SMALL BOX",
          "Charge_LineTotal": 9.98,
          "PickedAt": null,
          "DeliveredAt": null,
          "RatingCode": "MS"
        }
      ],
      "ConsignmentNo": "APD00020627",
      "Status": null,
      "Picked": null,
      "Delivered": null,
      "Tracking": "https:\/\/gosweetspot.com\/track\/108633-APD00020627",
      "Events": [
        
      ],
      "ManifestNumber": "ABCD",
      "TotalCost": 9.98,
      "CreatedUtc": "2019-10-10T23:30:53.88",
      "PackingSlipNo": "#1031",
      "ManualTicket": false,
      "Consignee": "RECEIVER NAME"
    }
  ]
}