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.

Schemes

http

location Location lookup service

GET/location/country/{countryCode}/zip/{postalCode}

Lookup location for country and zip/postal code

orders The Orders API allows customers to send preliminary shipment information

GET/orders

Retrieve a paginated list of orders

POST/orders/

Create an order with preliminary shipment information

DELETE/orders/{id}

Cancel by orderId

rates Get rates

POST/rates/

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

profile Profile API for internal use.

boxes List all boxes of the customer

GET/boxes

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

signup Signup API for internal use.

accounts Account information API.

GET/accounts/available-services

List available services for the account.

track Track a shipment

GET/track/{id}

Track by shipId

shipments Create, retrieve, and cancel shipments. Retrieve shipping labels and customs invoices.

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

pickups Get pickups

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.

token Token API for internal use.

Test

GET/test/ping

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 `<br>{<br> "handledBy": "spring-mvc",<br> "status": "ok"<br>}<br>`

webhooks

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

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

ShipTime REST API 0.1