NAME
WWW::ShipStation - ShipStation API
SYNOPSIS
use WWW::ShipStation;
DESCRIPTION
WWW::ShipStation is for
refer examples for running code
METHODS
new
my $ws = WWW::ShipStation->new(
user => 'blabla',
pass => 'blabla'
);
* user
required
* pass
required
* ua
optional, LWP::UserAgent based.
* json
optional, JSON based
getCarriers
my $carriers = $ws->getCarriers();
getCustomsItems
my $customitems = $ws->getCustomsItems(
filter => "Order/OrderNumber eq '1111113'",
); # https://data.shipstation.com/1.1/CustomsItems()?$filter=Order/OrderNumber eq '1111113'
getCustomers
my $customers = $ws->getCustomers();
my $customers = $ws->getCustomers(
orderby => 'Name',
top => 100
); # https://data.shipstation.com/1.1/Customers()?$orderby=Name&$top=100
my $customers = $ws->getCustomers(
orderby => 'Name',
skip => 100,
top => 100
); # https://data.shipstation.com/1.1/Customers()?$orderby=Name&$skip=100&$top=100
my $customers = $ws->getCustomers(
customerID => 29229
); # https://data.shipstation.com/1.1/Customers(29229)
my $customers = $ws->getCustomers(
filter => "Email eq 'support@shipstation.com'"
); # http://data.shipstation.com/1.1/Customers()?$filter=Email eq 'support@shipstation.com'
getMarketplaces
my $marketplaces = $ws->getMarketplaces();
getOrderItems
my $orderitems = $ws->getOrderItems();
my $orderitems = $ws->getOrderItems(
filter => "Order/OrderNumber eq '1018'"
); # https://data.shipstation.com/1.1/OrderItems()?$filter=Order/OrderNumber eq '1018'
getOrders
my $orders = $ws->getOrders();
my $orders = $ws->getOrders(
filter => "(OrderDate ge datetime'2012-06-30T00:00:00') and (OrderDate le datetime'2012-07-01T00:00:00')",
expand => 'OrderItems',
); # https://data.shipstation.com/1.1/Orders()?$filter=(OrderDate ge datetime'2012-06-30T00:00:00') and (OrderDate le datetime'2012-07-01T00:00:00')&$expand=OrderItems
getPackageTypes
my $packagetypes = $ws->getPackageTypes(
filter => 'Domestic eq true'
); # https://data.shipstation.com/1.1/PackageTypes()?$filter=Domestic eq true
getProducts
my $products = $ws->getProducts(
filter => "SKU eq '12345'"
); # https://data.shipstation.com/1.1/Products()?$filter=SKU eq '12345'
getShipments
my $shipments = $ws->getShipments(
filter => "Order/OrderNumber eq '100000001'",
expand => 'ShipmentItems',
); # https://data.shipstation.com/1.1/Shipments()?$filter=Order/OrderNumber%20eq%20'100000001'&$expand=ShipmentItems
my $shipments = $ws->getShipments(
filter => "(ShipDate ge datetime'2012-06-01T00:00:00') and (ShipDate lt datetime'2012-06-09T00:00:00')",
); # https://data.shipstation.com/1.1/Shipments()?$filter=(ShipDate ge datetime'2012-06-01T00:00:00') and (ShipDate lt datetime'2012-06-09T00:00:00')
getShippingProviders
my $shippingproviders = $ws->getShippingProviders();
getShippingServices
my $shippingservice = $ws->getShippingServices(
filter => "(International eq false) and (ProviderId eq 4)"
); # https://data.shipstation.com/1.1/ShippingServices()?$filter=(International eq false) and (ProviderId eq 4)
getStores
my $stores = $ws->getStores(
filter => "Active eq true"
); # https://data.shipstation.com/1.3/Stores()?$filter=Active eq true
getWarehouses
my $warehouses = $ws->getWarehouses(
filter => 'Default eq true'
); # https://data.shipstation.com/1.1/Warehouses()?$filter=Default eq true
request
my $data = $ws->request('Customers()');
my $data = $ws->request('Warehouses()',
filter => 'Default eq true'
);
internal use
AUTHOR
Fayland Lam
COPYRIGHT
Copyright 2014- Fayland Lam
LICENSE
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
SEE ALSO