GoSweetSpot: Shipment Status

Included in this document:


Description

Get the available services associated with the access_key token.


Requests

Method: GET
Content Type: application/json
URL: https://api.gosweetspot.com/v2/shipmentstatus


Headers

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


Parameters

The body of the message should be sent as an JSON array. A JSON list of consignment numbers.


Return format

A JSON object array with consignment number and associated events.


Root Object

Carriers - Array of Carrier.


Response

Attribute Type Description
consignmentno string The queried shipment.
status string Current status of shipment.
picked datetime (nullable) Date and time picked from the sender. Local time at the pickup address. Blank when not picked yet.
delivered datetime (nullable) Date and time delivered to the receiver. Local time at delivery address. Blank when not delivered yet.
tracking string Tracking url.
events object list An array of line-level events for all pieces in the shipment.
totalcost integer Total cost of shipment.
createdutc datetime When the shipment has been created

Request example


curl --location --request POST 'https://api.gosweetspot.com/v2/shipmentstatus' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json' \
--data '[
  "WRR1406658",
  "WRR1406659"
]'


Response example

[
  {
    "ConsignmentNo": "WRR1406658",
    "Status": "Delivered to SANDRA",
    "Picked": "2014-11-04T19:07:00.36",
    "Delivered": "2014-11-17T08:55:53",
    "Tracking": "http://track.gosweetspot.com/1218110-WRR1406658",
    "Events": [
      {
        "EventDT": "2014-11-03T13:20:00",
        "Code": "CR",
        "Description": "Tracking number allocated & order ready",
        "Location": "NSW",
        "Part": "WRR1406658001"
      },
      {
        "EventDT": "2014-11-04T17:06:00",
        "Code": "INTL",
        "Description": "International transit to destination country ",
        "Location": "AU, SYD",
        "Part": "WRR1406658001"
      },
      {
        "EventDT": "2014-11-14T09:47:00",
        "Code": "CUST",
        "Description": "Customs cleared",
        "Location": "NZ",
        "Part": "WRR1406658001"
      },
      {
        "EventDT": "2014-11-14T13:20:00",
        "Code": "COURU",
        "Description": "Scan activity. Imported on runsheet AVWRR14315",
        "Location": "Auckland",
        "Part": "WRR1406658001"
      },
      {
        "EventDT": "2014-11-15T07:42:00",
        "Code": "COURU",
        "Description": "Scan activity. Scanned into Palmerston North",
        "Location": "Palmerston Nth",
        "Part": "WRR1406658001"
      },
      {
        "EventDT": "2014-11-17T06:11:00",
        "Code": "COURU",
        "Description": "On courier vehicle for delivery",
        "Location": "Palmerston Nth",
        "Part": "WRR1406658001"
      },
      {
        "EventDT": "2014-11-17T08:55:00",
        "Code": "DEL",
        "Description": "Delivered to SANDRA",
        "Location": "Palmerston Nth",
        "Part": "WRR1406658001"
      }
    ],
    "TotalCost": 10.0,
    "CreatedUtc": "2014-11-03T23:56:57.27Z"
  },
  {
    "ConsignmentNo": "WRR1406659",
    "Status": "Delivered to ANNA",
    "Picked": "2014-11-04T19:07:00.36",
    "Delivered": "2014-11-14T15:02:31",
    "Tracking": "http://track.gosweetspot.com/1218110-WRR1406659",
    "Events": [
      {
        "EventDT": "2014-11-03T13:20:00",
        "Code": "CR",
        "Description": "Tracking number allocated & order ready",
        "Location": "NSW",
        "Part": "WRR1406659001"
      },
      {
        "EventDT": "2014-11-04T17:06:00",
        "Code": "INTL",
        "Description": "International transit to destination country ",
        "Location": "AU, SYD",
        "Part": "WRR1406659001"
      },
      {
        "EventDT": "2014-11-14T09:47:00",
        "Code": "CUST",
        "Description": "Customs cleared",
        "Location": "NZ",
        "Part": "WRR1406659001"
      },
      {
        "EventDT": "2014-11-14T12:11:00",
        "Code": "COURU",
        "Description": "Scan activity. Scanned into Auckland",
        "Location": "Auckland",
        "Part": "WRR1406659001"
      },
      {
        "EventDT": "2014-11-14T13:20:00",
        "Code": "COURU",
        "Description": "Scan activity. Imported on runsheet AVWRR14315",
        "Location": "Auckland",
        "Part": "WRR1406659001"
      },
      {
        "EventDT": "2014-11-14T13:34:00",
        "Code": "COURU",
        "Description": "On courier vehicle for delivery",
        "Location": "Auckland",
        "Part": "WRR1406659001"
      },
      {
        "EventDT": "2014-11-14T15:02:00",
        "Code": "DEL",
        "Description": "Delivered to ANNA",
        "Location": "Auckland",
        "Part": "WRR1406659001"
      }
    ],
    "TotalCost": 10.0,
    "CreatedUtc": "2014-11-03T23:56:57.27Z"
  }
]

 

 

 

 

 

Did this article answer your question?

Can't find the answer to your question?

Suggest an article