Overview

Ship Jay API 1.0.0

Buy shipping labels, track packages and manage returns from your own systems. Authenticate with Authorization: Bearer <key>. Amounts are integer cents. Every response carries an X-Request-Id header; quote it when you contact support.

Information

• OpenAPI version: 3.1.0

Operations

GET

/account

GET

/ship-from

POST

/addresses/verify

POST

/shipments/quote

POST

/shipments/{id}/buy

GET

/shipments

GET

/shipments/{id}

GET

/shipments/{id}/label

GET

/shipments/{id}/tracking

POST

/shipments/{id}/refund

GET

/wallet

GET

/wallet/entries

GET

/returns

GET

/returns/{id}

POST

/returns/{id}/approve

POST

/returns/{id}/reject

POST

/returns/{id}/receive

POST

/returns/{id}/close

GET

/rules

POST

/rules

PUT

/rules/{id}

DELETE

/rules/{id}

GET

/events

GET

/webhooks

POST

/webhooks

DELETE

/webhooks/{id}

Authentication

bearerAuth

API key. Permissions: shipments:read, shipments:write, shipments:buy, refunds:write, wallet:read, returns:read, returns:write, rules:read, rules:write, events:read, webhooks:manage.

Security scheme type: http