Getting Started

Base URL

All API requests should be made to:

https://api.cybership.io/v1

First Steps

1. Create an API Key - You'll need this to authenticate all requests

2. Understand Rate Limits - Know your limits before you start building

3. Fulfill Your First Order - Walk through the complete fulfillment workflow

Making Your First Request

Once you have your API key, test it with a simple request:

curl -X GET https://api.cybership.io/v1/shipos/orders \
  -H "x-access-token: cyb_your_api_key_here"

A successful response returns your orders in JSON format.

To create your first order, you can create a draft order (see draft orders for more info) using the API endpoint /api/orders/draft-orders/create-draft-order and then convert it to a live order when ready.

Next Steps

• Explore the API Resources to understand available endpoints
• Review specific resource documentation for detailed field descriptions
• Set up webhooks to receive real-time updates

Error Handling & Support

Trace IDs in Error Responses

All API error responses include a unique trace ID for troubleshooting:

{
  "type": "urn:cybership:error:not-found",
  "title": "Not Found", 
  "status": 404,
  "detail": "Order not found (Reference this ID for support: a1b2c3d4e5f67890)"
}

When contacting support, always include the trace ID from error responses. This allows our team to quickly locate and diagnose the specific issue in our system logs.

OpenAPI Specification

Need to integrate with AI tools or generate client code? Download our OpenAPI spec:

Need Help?

Contact support on slack if you encounter any issues or need higher rate limits for your integration.