v2/order

Description

Get the current status of an order.

Request

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

Headers

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

Parameters

Parameter	Type	Description
packingslipno	string	Specify the unique order number from your source system, that was used as the packing slip no when the order was published.

Return format

A JSON object with order status.

Response

Parameter	Type	Description
packingslipno	string	Unique order number or packing slip number from your system.
consignee	string	Recipient name.
status	string	Current status of order, options PENDING/PICKED/DELIVERED.
ticketnumber	string	Unique consignment number.
trackingurl	string	Track and trace website url.
picked	date	Localised to pickup timezone, pickup time stamp. null if not picked yet.
delivered	date	Localised to destintation timezone, delivery time stamp. null if not delivered yet.
ticketprinteddate	date	Localised to origin timezone, when the shipment ticket was created. null if not created yet.
ticketprintedby	string	Username of the user, creating the ticket.
ticketdeleteddate	date	Localised to NZ timezone, date and time when the ticket was deeted, if deleted. null if not deleted.
ticketdeletedby	string	Username of the user, deleting the ticket.

Request example

curl --location --request PUT 'https://api.gosweetspot.com/v2/order/SSORDER5840' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json' \
--data ''

Response example

{
  "packingslipno": "SSORDER5840",
  "consignee": "PHOTO DREAMS LIMITED",
  "status": "DELIVERED",
  "ticketnumber": "SSPOT012671",
  "trackingurl": "http://gosweetspot.com/track/1234-SSPOT012671",
  "picked": "2014-06-03T08:40:00",
  "delivered": "2014-06-03T14:46:45",
  "ticketprinteddate": "2014-06-03T08:30:00",
  "ticketprintedby": "abc@accompany.co.nz",
  "ticketdeleteddate": null,
  "ticketdeletedby": null
}