| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Ballast.Client
- paramsToByteString :: (Monoid m, IsString m) => [(m, m)] -> m
- createRateRequest :: GetRate -> ShipwireRequest RateRequest TupleBS8 ByteString
- getStockInfo :: ShipwireRequest StockRequest TupleBS8 ByteString
- getReceivings :: ShipwireRequest GetReceivingsRequest TupleBS8 ByteString
- createReceiving :: CreateReceiving -> ShipwireRequest CreateReceivingRequest TupleBS8 ByteString
- getReceiving :: ReceivingId -> ShipwireRequest GetReceivingRequest TupleBS8 ByteString
- modifyReceiving :: ReceivingId -> ModifyReceiving -> ShipwireRequest ModifyReceivingRequest TupleBS8 ByteString
- cancelReceiving :: ReceivingId -> ShipwireRequest CancelReceivingRequest TupleBS8 ByteString
- cancelReceivingLabels :: ReceivingId -> ShipwireRequest CancelReceivingLabelsRequest TupleBS8 ByteString
- getReceivingHolds :: ReceivingId -> ShipwireRequest GetReceivingHoldsRequest TupleBS8 ByteString
- getReceivingInstructionsRecipients :: ReceivingId -> ShipwireRequest GetReceivingInstructionsRecipientsRequest TupleBS8 ByteString
- getReceivingItems :: ReceivingId -> ShipwireRequest GetReceivingItemsRequest TupleBS8 ByteString
- getReceivingShipments :: ReceivingId -> ShipwireRequest GetReceivingShipmentsRequest TupleBS8 ByteString
- getReceivingTrackings :: ReceivingId -> ShipwireRequest GetReceivingTrackingsRequest TupleBS8 ByteString
- getReceivingLabels :: ReceivingId -> ShipwireRequest GetReceivingLabelsRequest TupleBS8 ByteString
- getProducts :: ShipwireRequest GetProductsRequest TupleBS8 ByteString
- createProduct :: [CreateProductsWrapper] -> ShipwireRequest CreateProductsRequest TupleBS8 ByteString
- modifyProducts :: [CreateProductsWrapper] -> ShipwireRequest ModifyProductsRequest TupleBS8 ByteString
- modifyProduct :: CreateProductsWrapper -> Id -> ShipwireRequest ModifyProductRequest TupleBS8 ByteString
- getProduct :: Id -> ShipwireRequest GetProductRequest TupleBS8 ByteString
- retireProducts :: ProductsToRetire -> ShipwireRequest RetireProductsRequest TupleBS8 ByteString
- getOrders :: ShipwireRequest GetOrdersRequest TupleBS8 ByteString
- getOrder :: IdWrapper -> ShipwireRequest GetOrderRequest TupleBS8 ByteString
- createOrder :: CreateOrder -> ShipwireRequest CreateOrderRequest TupleBS8 ByteString
- cancelOrder :: IdWrapper -> ShipwireRequest CancelOrderRequest TupleBS8 ByteString
- getOrderTrackings :: IdWrapper -> ShipwireRequest GetOrderTrackingsRequest TupleBS8 ByteString
- validateAddress :: AddressToValidate -> ShipwireRequest ValidateAddressRequest TupleBS8 ByteString
- shipwire' :: FromJSON (ShipwireReturn a) => ShipwireConfig -> ShipwireRequest a TupleBS8 ByteString -> IO (Response ByteString)
- data ShipwireError = ShipwireError {}
- shipwire :: FromJSON (ShipwireReturn a) => ShipwireConfig -> ShipwireRequest a TupleBS8 ByteString -> IO (Either ShipwireError (ShipwireReturn a))
- shipwireTest :: FromJSON (ShipwireReturn a) => ShipwireConfig -> Manager -> ShipwireRequest a TupleBS8 ByteString -> IO (Either ShipwireError (ShipwireReturn a))
- shipwireTest' :: FromJSON (ShipwireReturn a) => ShipwireConfig -> ShipwireRequest a TupleBS8 ByteString -> Manager -> IO (Response ByteString)
Documentation
paramsToByteString :: (Monoid m, IsString m) => [(m, m)] -> m Source #
Conversion of a key value pair to a query parameterized string
createRateRequest :: GetRate -> ShipwireRequest RateRequest TupleBS8 ByteString Source #
Generate a real-time shipping quote https://www.shipwire.com/w/developers/rate/
getStockInfo :: ShipwireRequest StockRequest TupleBS8 ByteString Source #
Get stock information for your products. https://www.shipwire.com/w/developers/stock/
getReceivings :: ShipwireRequest GetReceivingsRequest TupleBS8 ByteString Source #
Get an itemized list of receivings. https://www.shipwire.com/w/developers/receiving/#panel-shipwire0
createReceiving :: CreateReceiving -> ShipwireRequest CreateReceivingRequest TupleBS8 ByteString Source #
Create a new receiving https://www.shipwire.com/w/developers/receiving/#panel-shipwire1
getReceiving :: ReceivingId -> ShipwireRequest GetReceivingRequest TupleBS8 ByteString Source #
Get information about this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire2
modifyReceiving :: ReceivingId -> ModifyReceiving -> ShipwireRequest ModifyReceivingRequest TupleBS8 ByteString Source #
Modify information about this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire3
cancelReceiving :: ReceivingId -> ShipwireRequest CancelReceivingRequest TupleBS8 ByteString Source #
Cancel this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire4
cancelReceivingLabels :: ReceivingId -> ShipwireRequest CancelReceivingLabelsRequest TupleBS8 ByteString Source #
Cancel shipping labels on this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire5
getReceivingHolds :: ReceivingId -> ShipwireRequest GetReceivingHoldsRequest TupleBS8 ByteString Source #
Get the list of holds, if any, on this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire6
getReceivingInstructionsRecipients :: ReceivingId -> ShipwireRequest GetReceivingInstructionsRecipientsRequest TupleBS8 ByteString Source #
Get email recipients and instructions for this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire7
getReceivingItems :: ReceivingId -> ShipwireRequest GetReceivingItemsRequest TupleBS8 ByteString Source #
Get the contents of this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire8
getReceivingShipments :: ReceivingId -> ShipwireRequest GetReceivingShipmentsRequest TupleBS8 ByteString Source #
Get shipping dimension and container information. https://www.shipwire.com/w/developers/receiving/#panel-shipwire9
getReceivingTrackings :: ReceivingId -> ShipwireRequest GetReceivingTrackingsRequest TupleBS8 ByteString Source #
Get tracking information for this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire10
getReceivingLabels :: ReceivingId -> ShipwireRequest GetReceivingLabelsRequest TupleBS8 ByteString Source #
Get labels information for this receiving. https://www.shipwire.com/w/developers/receiving/#panel-shipwire11
getProducts :: ShipwireRequest GetProductsRequest TupleBS8 ByteString Source #
Get an itemized list of products. https://www.shipwire.com/w/developers/product/#panel-shipwire0
createProduct :: [CreateProductsWrapper] -> ShipwireRequest CreateProductsRequest TupleBS8 ByteString Source #
Create new products of any classification. https://www.shipwire.com/w/developers/product/#panel-shipwire1
modifyProducts :: [CreateProductsWrapper] -> ShipwireRequest ModifyProductsRequest TupleBS8 ByteString Source #
Modify products of any classification. https://www.shipwire.com/w/developers/product/#panel-shipwire2
modifyProduct :: CreateProductsWrapper -> Id -> ShipwireRequest ModifyProductRequest TupleBS8 ByteString Source #
Modify a product. https://www.shipwire.com/w/developers/product/#panel-shipwire3
getProduct :: Id -> ShipwireRequest GetProductRequest TupleBS8 ByteString Source #
Get information about a product. https://www.shipwire.com/w/developers/product/#panel-shipwire4
retireProducts :: ProductsToRetire -> ShipwireRequest RetireProductsRequest TupleBS8 ByteString Source #
Indicates that the listed products will not longer be used. https://www.shipwire.com/w/developers/product/#panel-shipwire5
getOrders :: ShipwireRequest GetOrdersRequest TupleBS8 ByteString Source #
Get an itemized list of orders. https://www.shipwire.com/w/developers/order/#panel-shipwire0
getOrder :: IdWrapper -> ShipwireRequest GetOrderRequest TupleBS8 ByteString Source #
Get information about this order. https://www.shipwire.com/w/developers/order/#panel-shipwire1
createOrder :: CreateOrder -> ShipwireRequest CreateOrderRequest TupleBS8 ByteString Source #
Create a new order. https://www.shipwire.com/w/developers/order/#panel-shipwire2
cancelOrder :: IdWrapper -> ShipwireRequest CancelOrderRequest TupleBS8 ByteString Source #
Cancel this order. https://www.shipwire.com/w/developers/order/#panel-shipwire4
getOrderTrackings :: IdWrapper -> ShipwireRequest GetOrderTrackingsRequest TupleBS8 ByteString Source #
Get tracking information for this order. https://www.shipwire.com/w/developers/order/#panel-shipwire7
validateAddress :: AddressToValidate -> ShipwireRequest ValidateAddressRequest TupleBS8 ByteString Source #
Validate Address https://www.shipwire.com/w/developers/address-validation
shipwire' :: FromJSON (ShipwireReturn a) => ShipwireConfig -> ShipwireRequest a TupleBS8 ByteString -> IO (Response ByteString) Source #
shipwire :: FromJSON (ShipwireReturn a) => ShipwireConfig -> ShipwireRequest a TupleBS8 ByteString -> IO (Either ShipwireError (ShipwireReturn a)) Source #
Create a request to Shipwire's API
shipwireTest :: FromJSON (ShipwireReturn a) => ShipwireConfig -> Manager -> ShipwireRequest a TupleBS8 ByteString -> IO (Either ShipwireError (ShipwireReturn a)) Source #
This function is only used internally to speed up the test suite. Instead of creating a new Manager we reuse the same one.
shipwireTest' :: FromJSON (ShipwireReturn a) => ShipwireConfig -> ShipwireRequest a TupleBS8 ByteString -> Manager -> IO (Response ByteString) Source #