ShipTime API

ShipTime REST API

0.1

[ Base URL: restapi.shiptime.com/rest ]

Welcome to the Rest API documentation. Don't have API keys? Login or create an account here to get started.

http

GET/location/country/{countryCode}/zip/{postalCode}
Lookup location for country and zip/postal code

GET/orders
Retrieve a paginated list of orders

POST/orders/
Create an order with preliminary shipment information

DELETE/orders/{id}
Cancel by orderId

POST/rates/
Get rates post method. Submitting a properly formatted request will yield rates with different available couriers.

GET/boxes
List all boxes of the customer. The list includes both custom boxes added by the customer, and standard courier boxes.

GET/accounts/available-services
List available services for the account.

GET/track/{id}
Track by shipId

GET/shipments
Retrieve a paginated list of shipments

POST/shipments/
Create a shipment. This operation will charge the account.

GET/shipments/{id}
Retrieve a shipment by ID

DELETE/shipments/{id}
Cancel a shipment by ID

GET/shipments/{id}/customs
Retrieve the customs invoice for an international shipment

GET/shipments/{id}/label
Retrieve the shipping label for a shipment

GET/pickups
List current pickups

POST/pickups/
Schedule pickup for shipment and PickupDetail

DELETE/pickups/{pickupId}/
Cancel pickup by Id.

GET/pickups/available-for-shipment/{shipId}
Find available pickup(s) for shipment

DELETE/pickups/remove-shipment/{shipId}
Remove shipment from pickup. This method does not cancel the shipment. It only removes it from pickup batch.

GET/test/ping
Ping the Spring MVC stack

GET/webhooks
List webhook subscriptions for the authenticated account

POST/webhooks
Create a webhook subscription for the authenticated account

GET/webhooks/{id}
Get a webhook subscription by ID

PUT/webhooks/{id}
Update a webhook subscription

DELETE/webhooks/{id}
Deactivate a webhook subscription