Quickstart

Get started with the PostCo API in minutes. This guide walks you through authentication, making your first API request, and understanding the response structure. By the end, you'll have retrieved your return orders and be ready to build your integration.

Generate your API key

The PostCo API uses Bearer token authentication. To get started:

1. Log in to your PostCo retailer dashboard at 360.postco.co
2. Click the Account Settings icon in the bottom left corner of the sidebar, then select Manage API Keys
3. Click Create API Key and give it a descriptive name
4. Copy your API key immediately—you won't be able to see it again

Your API key will look like this: sk_a1b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcd

Making your first API request

Now that you have an API key, you're ready to make your first request. Below is an example that retrieves your return orders.

curl -G https://360.postco.co/api/public/v1/return_orders \
  -H "Authorization: Bearer sk_your_api_key_here" \
  -d limit=10

Understanding the response

The API returns a JSON response with paginated results:

{
  "data": [
    {
      "id": 123,
      "cust_email": "[email protected]",
      "cust_first_name": "John",
      "cust_last_name": "Doe",
      "status": "reviewed",
      "currency": "USD",
      "order_id": "456",
      "order_name": "ORDER-001",
      "submitted_at": "2025-10-05T14:30:00Z",
      // ... more fields
    }
  ],
  "has_more": true,
  "next_cursor": "122"
}

Key response fields:

• data: Array of return order objects
• has_more: Boolean indicating if more results exist
• next_cursor: ID to use for fetching the next page

What's next?

Great! You've made your first request to the PostCo API. Here are some helpful next steps:

• Read the Return Orders endpoint documentation to learn about filtering and detailed responses
• Learn about pagination to efficiently retrieve large datasets
• Understand error handling to build robust integrations
• Review authentication best practices for secure API key management