ShipWise API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefix in their names.

Inventory

Inventory
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
available_quantity	integer	Available Quantity
sku	string	SKU
name	string	Customer name
location	string	Location

Example

SQL

CREATE VIEW shipwise_examples.example_Inventory
AS 
SELECT * FROM shipwise.Inventory (
	preview => TRUE
)

Orders

Orders
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	integer	Order Id
carrier_id	integer	Carrier Id
carrier_name	string	Carrier Name
service_id	integer	Service Id
service_name	string	Service name
orderReference	string	Order Reference
customerReference	string	Customer Reference
requestedShipDate	timestamp	Requested Ship Date
shipFrom_id	integer	Ship From Id
shipFrom_name	string	Ship From Name
shipFrom_company	string	Ship From Company
shipFrom_email	string	Ship From Email
shipFrom_address1	string	Ship From Address1
shipFrom_address2	string	Ship From Address2
shipFrom_city	string	Ship From City
shipFrom_state_id	integer	Ship From State Id
shipFrom_state_name	string	Ship From State Name
shipFrom_state_abbreviation	string	Ship From State Abbreviation
shipFrom_state_country	string	Ship From State Country
shipFrom_zip	string	Ship From Zip
shipFrom_phone	string	Ship From Phone
shipFrom_notes	string	Ship From Notes
shipTo_id	integer	Ship To Id
shipTo_name	string	Ship To Name
shipTo_company	string	Ship To Company
shipTo_email	string	Ship To Email
shipTo_address1	string	Ship To Address1
shipTo_address2	string	Ship To Address2
shipTo_city	string	Ship To City
shipTo_state_id	integer	Ship To State Id
shipTo_state_name	string	Ship To State Name
shipTo_state_abbreviation	string	Ship To State Abbreviation
shipTo_state_country	string	Ship To State Country
shipTo_zip	string	Ship To Zip
shipTo_phone	string	Ship To Phone
shipTo_notes	string	Ship To Notes
tracking_id	integer	Tracking Id
tracking_service_id	integer	Tracking Service Id
tracking_service_name	string	Tracking Service Name
tracking_service_carrier_id	integer	Tracking Service Carrier Id
tracking_service_carrier_name	string	Tracking Service Carrier Name
tracking_trackingNumber	string	Tracking Number
tracking_createdDate	timestamp	Tracking Created Date
createdDate	timestamp	Created Date
updatedDate	timestamp	Updated Date
status	string	Status
history_id	integer	History Id
history_status	string	History Status
history_createdDate	timestamp	History Created Date
history_comment	string	History Comment
customer_id	integer	Customer Id
customer_name	string	Customer Name
customer_createdDate	timestamp	Customer Created Date
poNumber	string	Purchase Order Number
uuid	string	UUID
notes	string	Notes
origin	string	Origin

Example

SQL

CREATE VIEW shipwise_examples.example_Orders
AS 
SELECT * FROM shipwise.Orders (
	preview => TRUE
)

SKUs

SKUs
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	integer	SKU Id
name	string	SKU name
substitute_1	string	Substitution for SKU
substitute_2	string	Substitution for SKU
substitute_3	string	Substitution for SKU

Example

SQL

CREATE VIEW shipwise_examples.example_SKUs
AS 
SELECT * FROM shipwise.SKUs (
	preview => TRUE
)