ShiplyTech API

Keys and access

An organization admin creates keys inside the app in Settings. Keys start with stk_, are shown once, and can be rotated or revoked. Keep keys private. Each key reaches only its own organization. Admins can disable API access; it is enabled by default for new organizations.

Anyone holding a key can place orders and see your organization’s order history.

Create a return

Base URL: https://app.shiplytech.com/functions. Authentication uses the X-API-Key header. API orders charge the organization’s saved card. Place a first dashboard order to save a card; no saved card means the call fails. Prices are calculated on the server.

curl -X POST https://app.shiplytech.com/functions/apiCreateOrder \
  -H 'X-API-Key: stk_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"employee":{"name":"Jane Doe","email":"jane@example.com","street":"123 Example Street","city":"Austin","state":"TX","postal_code":"78701","country":"US"},"company":{"name":"Example Company","street":"456 Example Road","city":"Austin","state":"TX","postal_code":"78701","country":"US"},"device_type":"laptop","intent":"return"}' 

{"order_id":"example-order-id","order_number":"SHP-EXAMPLE","status":"paid","payment_status":"paid","total_amount":95,"invoice_id":"example-invoice","hosted_invoice_url":"https://example.com/invoice"}

Scope and limits

There are no published rate limits and no SDKs. Each create call sets one device_type; set add_peripherals to true to add a peripherals box to the same order. Outside the US only laptops are accepted. Orders can return the device to your company, send it to the ShiplyTech warehouse or send it for disposal.

There is one webhook event, order.status_changed, with one delivery attempt and no retry.