Mark sale as shipped

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/antiwork/gumroad/llms.txt

Use this file to discover all available pages before exploring further.

​

Endpoint

PUT https://api.gumroad.com/v2/sales/:id/mark_as_shipped

​

Authentication

​

Path Parameters

​

Body Parameters

​

Response

​

Example Request

curl -X PUT "https://api.gumroad.com/v2/sales/ABC123XYZ/mark_as_shipped" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​

Example Response

{
  "success": true,
  "sale": {
    "id": "ABC123XYZ",
    "email": "buyer@example.com",
    "seller_id": "seller456",
    "created_at": "2024-01-15T10:30:45.000Z",
    "product_id": "prod_abc123",
    "product_name": "Physical Product",
    "price": 4999,
    "gumroad_fee": 519,
    "shipped": true,
    "tracking_url": "https://www.fedex.com/fedextrack/?tracknumbers=123456789",
    "is_product_physical": true,
    "full_name": "John Doe",
    "street_address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zip_code": "94102",
    "country": "United States",
    "order_id": 123456789
  }
}

​

Error Response

{
  "success": false,
  "message": "The sale was not found."
}

​

Error Codes

​

Notes

• This endpoint can be called multiple times to update the tracking URL
• The buyer receives an email notification when a sale is marked as shipped
• If a tracking URL is provided, it will be included in the notification email
• The tracking URL should be a complete URL including the protocol (https://)
• Marking a sale as shipped does not affect refund eligibility
• The shipment record is created automatically if it doesn’t exist
• Only sales for physical products can be marked as shipped

​

Best Practices

​

Tracking URLs

• Always include the full tracking URL with the carrier’s domain
• Common carrier tracking URL formats:
  • USPS: https://tools.usps.com/go/TrackConfirmAction?tLabels=TRACKING_NUMBER
  • FedEx: https://www.fedex.com/fedextrack/?tracknumbers=TRACKING_NUMBER
  • UPS: https://www.ups.com/track?tracknum=TRACKING_NUMBER
  • DHL: https://www.dhl.com/en/express/tracking.html?AWB=TRACKING_NUMBER

​

Automation

• Integrate this endpoint with your fulfillment system
• Automatically mark sales as shipped when your shipping provider creates labels
• Use webhooks to trigger shipping workflows when new sales occur

​

Customer Communication

• Provide tracking information as soon as it’s available
• Update the tracking URL if the carrier changes or issues a new tracking number
• Consider sending additional updates through your own notification system