POST/v1/checkouts/{id}/tracking

Add or update tracking information for a checkout

Add or update tracking information for a checkout after fulfillment. The carrier can be auto-detected from the tracking number format.

Parameters

Request parameters for this endpoint

Name	Location	Type	Required	Description
id	path	string	Required	Checkout public ID

Request Body

Fields in the request body

Required

Name	Type	Description
trackingNumber	string	Tracking number from the carrier

Optional

Name	Type	Description
carrier		-

Response Data

Fields returned in the response

Always Present

Name	Type	Description
events		List of tracking events

Optional

Name	Type	Description
carrier		-
currentLocation		-
deliveredAt	string	When the package was delivered
estimatedDelivery	string	Estimated delivery date
shippedAt	string	When the package was shipped
signedBy	string	Who signed for the package
status		-
statusDescription	string	Human-readable status description
trackingNumber	string	Tracking number

POST/v1/checkouts/{id}/tracking

Request

curl https://api.thesweetspot.com/v1/checkouts/id_123/tracking \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "carrier": null,
  "trackingNumber": "string"
}'

Response

{
  "carrier": null,
  "currentLocation": null,
  "deliveredAt": null,
  "estimatedDelivery": null,
  "events": [
    {
      "description": null,
      "status": null,
      "timestamp": null
    }
  ],
  "shippedAt": null,
  "signedBy": null,
  "status": null,
  "statusDescription": null,
  "trackingNumber": null
}