Connectors Reference
Connects to Zenkraft API to create/manage/track shipments from 50+ Different carriers
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Cancel Shipment |
|
|
Schedule Pickup |
|
|
Print Shipping Label |
|
|
Get Printers |
|
|
Get Available Rates |
|
|
Create a shipment |
|
|
Track Shipment |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Cancel Shipment
Description: Cancels a shipment with a given shipment ID or tracking number
Syntax:
Zenkraft.cancelshipment ([Optional]cancelshipmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary: Schedule Pickup
Description: Schedules a shipment for pickup
Syntax:
Zenkraft.pickupshipment ([Optional]pickupshipmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary: Print Shipping Label
Description: Sends a command to print the shipping label based on the base64 string
Syntax:
Zenkraft.print ([Optional]printParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Type:printResponse
Summary: Get Printers
Description: Request returns credentials, the list of available printers, their trays and some additional data.
Syntax:
Zenkraft.getprinters ()
Returns:
Type:getprintersResponse
Summary: Get Available Rates
Description: Obtains available shipping rates based on shipping accounts provided.
Syntax:
Zenkraft.getrates ([Optional]getratesParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Type:getratesResponse
Summary: Create a shipment
Description: Books a shipment with a carrier and returns a shipping label.
Syntax:
Zenkraft.createshipment ([Optional]createshipmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary: Track Shipment
Description: Tracks a shipment with a carrier and returns the checkpoints.
Syntax:
Zenkraft.trackshipment ([Optional]trackshipmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
cancel |
|
cancel |
Summary:
Description: cancel
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
shipping_account |
string(int32)
|
shipping_account |
|
test |
boolean
|
test |
|
tracking_number |
string
|
tracking_number |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
|
success |
Summary:
Description: success
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shipment |
|
shipment |
Summary:
Description: shipment
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
currency |
string
|
currency |
|
debug |
boolean
|
debug |
|
dim_units |
string
|
dim_units |
|
include_base64_label |
boolean
|
include_base64_label |
|
label_type |
string
|
label_type |
|
packages |
array of (PackagesItem)
|
packages |
|
packaging |
string
|
packaging |
|
recipient |
|
recipient |
|
references |
array of (ReferencesItem)
|
references |
|
sender |
|
sender |
|
service |
string
|
service |
|
ship_date |
string
|
ship_date |
|
shipping_account |
string(float)
|
shipping_account |
|
test |
boolean
|
test |
|
type |
string
|
type |
|
weight_units |
string
|
weight_units |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
carrier_specific |
array of (Carrier_specificItem)
|
carrier_specific |
|
height |
integer(int32)
|
height |
|
length |
integer(int32)
|
length |
|
value |
integer(int32)
|
value |
|
weight |
integer(int32)
|
weight |
|
width |
integer(int32)
|
width |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: recipient
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
company |
string
|
company |
|
country |
string
|
country |
|
|
string
|
|
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
|
street2 |
string
|
street2 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
value |
string
|
value |
Summary:
Description: sender
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
company |
string
|
company |
|
country |
string
|
country |
|
|
string
|
|
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
|
street2 |
string
|
street2 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shipment |
|
shipment |
Summary:
Description: shipment
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
costs |
|
costs |
|
currency |
string
|
currency |
|
dim_units |
string
|
dim_units |
|
id |
string
|
id |
|
label_type |
string
|
label_type |
|
packages |
array of (PackagesItem)
|
packages |
|
packaging |
string
|
packaging |
|
recipient |
|
recipient |
|
references |
array of (ReferencesItem)
|
references |
|
sender |
|
sender |
|
service |
string
|
service |
|
ship_date |
string
|
ship_date |
|
shipping_account |
integer(int64)
|
shipping_account |
|
shipping_documents |
array of (Shipping_documentsItem)
|
shipping_documents |
|
test |
boolean
|
test |
|
tracking_number |
string
|
tracking_number |
|
type |
string
|
type |
|
weight_units |
string
|
weight_units |
Summary:
Description: costs
Properties:
|
Name |
Type |
Summary |
|
base_charge |
string
|
base_charge |
|
currency |
string
|
currency |
|
discounts |
string
|
discounts |
|
net_charge |
string
|
net_charge |
|
surcharges |
string
|
surcharges |
|
taxes |
string
|
taxes |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
height |
integer(int32)
|
height |
|
label |
string
|
label |
|
label_type |
string
|
label_type |
|
length |
integer(int32)
|
length |
|
tracking_number |
string
|
tracking_number |
|
value |
integer(int32)
|
value |
|
weight |
string
|
weight |
|
width |
integer(int32)
|
width |
Summary:
Description: recipient
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
country |
string
|
country |
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
value |
string
|
value |
Summary:
Description: sender
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
country |
string
|
country |
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
credentials |
|
credentials |
|
printers |
array of (PrintersItem)
|
printers |
Summary:
Description: credentials
Properties:
|
Name |
Type |
Summary |
|
|
string
|
|
|
password |
string
|
password |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
active_tray |
string
|
active_tray |
|
computer_id |
integer(int32)
|
computer_id |
|
computer_name |
string
|
computer_name |
|
id |
integer(int32)
|
id |
|
printer_name |
string
|
printer_name |
|
status |
string
|
status |
|
tray |
array of (string)
|
tray |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shipment |
|
shipment |
Summary:
Description: shipment
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
currency |
string
|
currency |
|
dim_units |
string
|
dim_units |
|
packages |
array of (PackagesItem)
|
packages |
|
recipient |
|
recipient |
|
sender |
|
sender |
|
shipping_account |
string(float)
|
shipping_account |
|
test |
boolean
|
test |
|
type |
string
|
type |
|
weight_units |
string
|
weight_units |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
height |
integer(int32)
|
height |
|
length |
integer(int32)
|
length |
|
value |
integer(int32)
|
value |
|
weight |
integer(int32)
|
weight |
|
width |
integer(int32)
|
width |
Summary:
Description: recipient
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
country |
string
|
country |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description: sender
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
country |
string
|
country |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
rates |
array of (RatesItem)
|
rates |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
currency |
string
|
currency |
|
delivery_day |
string
|
delivery_day |
|
service_name |
string
|
service_name |
|
service_type |
string
|
service_type |
|
total_cost |
string
|
total_cost |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pickup |
|
pickup |
Summary:
Description: pickup
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
debug |
boolean
|
debug |
|
description |
string
|
description |
|
dim_units |
string
|
dim_units |
|
location |
|
location |
|
shipments |
array of (ShipmentsItem)
|
shipments |
|
shipping_account |
string(float)
|
shipping_account |
|
test |
boolean
|
test |
|
time |
|
time |
|
weight_units |
string
|
weight_units |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
company |
string
|
company |
|
country |
string
|
country |
|
|
string
|
|
|
location_type |
string
|
location_type |
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
residential |
boolean
|
residential |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
package_type |
string
|
package_type |
|
packages |
array of (PackagesItem)
|
packages |
|
recipient |
|
recipient |
|
service |
string
|
service |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
height |
integer(int32)
|
height |
|
length |
integer(int32)
|
length |
|
value |
integer(int32)
|
value |
|
weight |
integer(int32)
|
weight |
|
width |
integer(int32)
|
width |
Summary:
Description: recipient
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
company |
string
|
company |
|
country |
string
|
country |
|
|
string
|
|
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description: time
Properties:
|
Name |
Type |
Summary |
|
close_time |
string
|
close_time |
|
date |
string
|
date |
|
ready_time |
string
|
ready_time |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
shipment |
|
shipment |
Summary:
Description: shipment
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
checkpoints |
array of (CheckpointsItem)
|
checkpoints |
|
costs |
|
costs |
|
currency |
string
|
currency |
|
debug |
boolean
|
debug |
|
delivered |
boolean
|
delivered |
|
dim_units |
string
|
dim_units |
|
id |
string
|
id |
|
include_base64_label |
boolean
|
include_base64_label |
|
label_type |
string
|
label_type |
|
packages |
array of (PackagesItem)
|
packages |
|
packaging |
string
|
packaging |
|
recipient |
|
recipient |
|
references |
array of (ReferencesItem)
|
references |
|
sender |
|
sender |
|
service |
string
|
service |
|
ship_date |
string
|
ship_date |
|
shipping_account |
string(float)
|
shipping_account |
|
special_services |
array of (Special_servicesItem)
|
special_services |
|
status |
string
|
status |
|
test |
boolean
|
test |
|
tracking_number |
string
|
tracking_number |
|
type |
string
|
type |
|
weight_units |
string
|
weight_units |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
location |
|
location |
|
signed_by |
string
|
signed_by |
|
time |
string
|
time |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
country |
string
|
country |
|
state |
string
|
state |
Summary:
Description: costs
Properties:
|
Name |
Type |
Summary |
|
currency |
string
|
currency |
|
net_charge |
string
|
net_charge |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
height |
string
|
height |
|
label |
string
|
label |
|
label_type |
string
|
label_type |
|
length |
string
|
length |
|
tracking_number |
string
|
tracking_number |
|
value |
string
|
value |
|
weight |
string
|
weight |
|
width |
string
|
width |
Summary:
Description: recipient
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
company |
string
|
company |
|
country |
string
|
country |
|
|
string
|
|
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: sender
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
company |
string
|
company |
|
country |
string
|
country |
|
|
string
|
|
|
name |
string
|
name |
|
phone |
string
|
phone |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |
|
street1 |
string
|
street1 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
content |
string
|
content |
|
printer_id |
integer(int32)
|
printer_id |
|
tray |
string
|
tray |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
success |
|
success |
Summary:
Description: success
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
track |
|
track |
Summary:
Description: track
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
shipping_account |
string(float)
|
shipping_account |
|
test |
boolean
|
test |
|
tracking_number |
string
|
tracking_number |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
carrier |
string
|
carrier |
|
checkpoints |
array of (CheckpointsItem)
|
checkpoints |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
description |
string
|
description |
|
location |
|
location |
|
time |
string
|
time |
Summary:
Description: location
Properties:
|
Name |
Type |
Summary |
|
city |
string
|
city |
|
country |
string
|
country |
|
postal_code |
string
|
postal_code |
|
state |
string
|
state |