## 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](https://app.shiptime.com/) to get started. ## Schemes http #### [location](https://restapi.shiptime.com/doc/index.html#/location) Location lookup service GET[​/location​/country​/{countryCode}​/zip​/{postalCode}](https://restapi.shiptime.com/doc/index.html#/location/getLocationUsingGET) Lookup location for country and zip/postal code #### [orders](https://restapi.shiptime.com/doc/index.html#/orders) The Orders API allows customers to send preliminary shipment information GET[​/orders](https://restapi.shiptime.com/doc/index.html#/orders/orders-get-all) Retrieve a paginated list of orders POST[​/orders​/](https://restapi.shiptime.com/doc/index.html#/orders/orders-post) Create an order with preliminary shipment information DELETE[​/orders​/{id}](https://restapi.shiptime.com/doc/index.html#/orders/orders-cancel) Cancel by orderId #### [rates](https://restapi.shiptime.com/doc/index.html#/rates) Get rates POST[​/rates​/](https://restapi.shiptime.com/doc/index.html#/rates/rate-post) Get rates post method. Submitting a properly formatted request will yield rates with different available couriers. #### [profile](https://restapi.shiptime.com/doc/index.html#/profile) Profile API for internal use. #### [boxes](https://restapi.shiptime.com/doc/index.html#/boxes) List all boxes of the customer GET[​/boxes](https://restapi.shiptime.com/doc/index.html#/boxes/getBoxesUsingGET) List all boxes of the customer. The list includes both custom boxes added by the customer, and standard courier boxes. #### [signup](https://restapi.shiptime.com/doc/index.html#/signup) Signup API for internal use. #### [accounts](https://restapi.shiptime.com/doc/index.html#/accounts) Account information API. GET[​/accounts​/available-services](https://restapi.shiptime.com/doc/index.html#/accounts/getAvailableServicesUsingGET) List available services for the account. #### [track](https://restapi.shiptime.com/doc/index.html#/track) Track a shipment GET[​/track​/{id}](https://restapi.shiptime.com/doc/index.html#/track/track-get) Track by shipId #### [shipments](https://restapi.shiptime.com/doc/index.html#/shipments) Create, retrieve, and cancel shipments. Retrieve shipping labels and customs invoices. GET[​/shipments](https://restapi.shiptime.com/doc/index.html#/shipments/shipments-get-all) Retrieve a paginated list of shipments POST[​/shipments​/](https://restapi.shiptime.com/doc/index.html#/shipments/shipments-post) Create a shipment. This operation will charge the account. GET[​/shipments​/{id}](https://restapi.shiptime.com/doc/index.html#/shipments/shipments-get) Retrieve a shipment by ID DELETE[​/shipments​/{id}](https://restapi.shiptime.com/doc/index.html#/shipments/shipments-cancel) Cancel a shipment by ID GET[​/shipments​/{id}​/customs](https://restapi.shiptime.com/doc/index.html#/shipments/shipments-customs-get) Retrieve the customs invoice for an international shipment GET[​/shipments​/{id}​/label](https://restapi.shiptime.com/doc/index.html#/shipments/shipments-label-get) Retrieve the shipping label for a shipment #### [pickups](https://restapi.shiptime.com/doc/index.html#/pickups) Get pickups GET[​/pickups](https://restapi.shiptime.com/doc/index.html#/pickups/pickup-get-all) List current pickups POST[​/pickups​/](https://restapi.shiptime.com/doc/index.html#/pickups/pickup-schedule) Schedule pickup for shipment and PickupDetail DELETE[​/pickups​/{pickupId}​/](https://restapi.shiptime.com/doc/index.html#/pickups/pickup-cancel) Cancel pickup by Id. GET[​/pickups​/available-for-shipment​/{shipId}](https://restapi.shiptime.com/doc/index.html#/pickups/pickup-find-available-for-shipment) Find available pickup(s) for shipment DELETE[​/pickups​/remove-shipment​/{shipId}](https://restapi.shiptime.com/doc/index.html#/pickups/pickup-remove-shipment) Remove shipment from pickup. This method does not cancel the shipment. It only removes it from pickup batch. #### [token](https://restapi.shiptime.com/doc/index.html#/token) Token API for internal use. #### [Test](https://restapi.shiptime.com/doc/index.html#/Test) GET[​/test​/ping](https://restapi.shiptime.com/doc/index.html#/Test/pingUsingGET) Ping the Spring MVC stack Returns a static payload identifying the Spring MVC stack as the handler. Used to verify the Camel-to-Spring-MVC migration plumbing end to end. #### Parameters Try it out No parameters #### Responses Response content type application/json | Code | Description | | --- | --- | | 200 | Service is up
- Example Value
- Model
```
{
"handledBy": "spring-mvc",
"status": "ok"
}
``` | #### [webhooks](https://restapi.shiptime.com/doc/index.html#/webhooks) GET[​/webhooks](https://restapi.shiptime.com/doc/index.html#/webhooks/listSubscriptionsUsingGET) List webhook subscriptions for the authenticated account POST[​/webhooks](https://restapi.shiptime.com/doc/index.html#/webhooks/createSubscriptionUsingPOST) Create a webhook subscription for the authenticated account GET[​/webhooks​/{id}](https://restapi.shiptime.com/doc/index.html#/webhooks/getSubscriptionUsingGET) Get a webhook subscription by ID PUT[​/webhooks​/{id}](https://restapi.shiptime.com/doc/index.html#/webhooks/updateSubscriptionUsingPUT) Update a webhook subscription DELETE[​/webhooks​/{id}](https://restapi.shiptime.com/doc/index.html#/webhooks/deleteSubscriptionUsingDELETE) Deactivate a webhook subscription #### Models PagedResponse Item OrderRequest Metadata Dimensions ShipTo Package Notes OrderResponse CancelResponse LineItemModel MoneyAmountModel CustomsInvoiceModel DutiesAndTaxesModel AddressModel RateRequest InvoiceContactModel InvoiceItemModel RateResponse SurchargeModel TaxModel QuoteModel PickupChargeModel TrackDetailModel ProofOfDeliveryModel TrackEventModel TrackResponse DocumentByteContent PickupDetailModel ShipRequest ShipResponse ShipmentChargesModel ShipmentDetailResponse PickupRequest PickupModel PickupAddressModel PickupResponse AvailablePickupsResponse BoxResponse CarrierServiceOptionModel CarrierServicesResponse LocationModel TestPingResponse WebhookCreateResponse WebhookRequest WebhookResponse WebhookUpdateRequest