Shipwire API
Promise Based Shipwire API Bindings.
Forked from sanderpick/shipwire-node. README format was adapted from MONEI/Shopify-api-node (very clean and helpful).
Installation:
$ npm install --save shipwire-api
API
This module exports a constructor function which takes an options object.
Shipwire(options)
Creates a new Shipwire
instance.
Arguments
options
- Required - A plain JavaScript object that contains the configuration options.
Options
username
- Required - A string that specifies the login username.password
- Required - A string that specifies the login password.host
- Optional - A string that specifies the host to make requests to. Defaults to"api.beta.shipwire.com"
Return value
A Shipwire
instance.
Exceptions
Throws an Error
exception if the required options are missing.
Example
const Shipwire = ; const shipwire = host: "api.shipwire.com" username: "<USERNAME>" password: "<PASSWORD>";
Resources
Every resource is accessed via your shipwire
instance:
const shipwire = host: "api.shipwire.com" username: "<USERNAME>" password: "<PASSWORD>"; // shipwire.<resouce_name>.<method_name>
Each method returns a Promise
that resolves with the result:
shipwireorders ;
Available resources and methods
- orders
get()
create()
update()
cancel()
getHolds()
getItems()
getReturns()
getTrackings()
- stock
get()
- rate
get()
- receivings
get()
create()
update()
cancel()
cancelLabels()
getHolds()
getInstructionsRecipients()
getItems()
getShipments()
getTrackings()
- returns
get()
create()
cancel()
getHolds()
getItems()
getTrackings()
getLabels()
- products
get()
create()
update()
retire()
- webhooks
get()
create()
update()
delete()
- secret
get()
create()
delete()
where params
is a plain JavaScript object. See https://www.shipwire.com/w/developers/
for parameters details.