Tracking API

Send the tracking number of a shipped order back to the marketplace. All requests need the API key of the integration, see authentication. Errors follow the common format.

POST /tracking

Submit a tracking number for an order. This will fulfill the order on the marketplace and notify the customer.

Request body:

Field	Type	Required	Description
orderId	integer	yes	Numeric Shopify order ID (received in the order webhook)
trackingNumber	string	yes	Tracking number
trackingCompany	string	no	Carrier name (e.g. "UPS")
trackingUrl	string	no	Tracking URL

Example request:

curl -X POST https://api.garnetmarketplace.com/tracking \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": 5538456789012,
    "trackingNumber": "1Z999AA10123456784",
    "trackingCompany": "UPS",
    "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA10123456784"
  }'

Response:

{ "fulfilled": true }