api/shipments

Description

Get status updates for shipments.

Request

• Method: GET
• Content Type: application/json
• URL: https://api.gosweetspot.com/api/shipments

Headers

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

Parameters

Parameter	Type	Description
shipments	string	Comma separated list of consignment numbers to apply filter on.
ordernumbers	string	Comma separated list of order numbers to apply filter on.
lastupdateminutc	string	UTC formatted date and time to filter the shipments on. This field is for earliest date.
lastupdatemaxutc	string	UTC formatted date and time to filter the shipments on. This field is for latest date.
includeDangerousGoodsFlag	boolean	Optional, true/false flag for request to populate IsDangerousGoods in response. Return null if flag set to false or missing.
page	integer	Optional, page number, defaults to 1.
pagesize	integer	Optional, number of shipments to return per page, max 250, defaults to 250.

when the shipments or ordernumbers values is provided, the lastupdateminutc & lastupdatemaxutc values are ignored.

Return format

A JSON object with the created shipment details.

Response

Attribute	Type	Description
page	integer	Current page number.
pages	integer	Total number of pages.
pagesize	integer	How many records returned per result set.
results	object list	A list of up to 250 shipments.

Request example

curl --location 'https://api.gosweetspot.com/api/shipments?lastupdateminutc=2015-08-13%252008%3A15%3A13&page=1&shipments=ABC0001%2CABC0002%2CABC20303' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json'

Response example

{
  "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,
      "IsDangerousGoods": null,
      "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,
      "IsDangerousGoods": null,
      "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"
    }
  ]
}