Connectors Reference

Zenkraft

Connects to Zenkraft API to create/manage/track shipments from 50+ Different carriers

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

cancelshipment ([Optional]cancelshipmentParameterBody body)

Cancel Shipment

pickupshipment ([Optional]pickupshipmentParameterBody body)

Schedule Pickup

print ([Optional]printParameterBody body)

Print Shipping Label

getprinters ()

Get Printers

getrates ([Optional]getratesParameterBody body)

Get Available Rates

createshipment ([Optional]createshipmentParameterBody body)

Create a shipment

trackshipment ([Optional]trackshipmentParameterBody body)

Track Shipment

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

cancelshipmentParameterBody

 

cancelshipmentResponse

 

createshipmentParameterBody

 

createshipmentResponse

 

getprintersResponse

 

getratesParameterBody

 

getratesResponse

 

pickupshipmentParameterBody

 

pickupshipmentResponse

 

printParameterBody

 

printResponse

 

trackshipmentParameterBody

 

trackshipmentResponse

 

 

Actions:

cancelshipment

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

cancelshipmentParameterBody

 

 

False

 

Returns:

          Type:cancelshipmentResponse

 

pickupshipment

Summary: Schedule Pickup

Description: Schedules a shipment for pickup

 

Syntax:

Zenkraft.pickupshipment ([Optional]pickupshipmentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

pickupshipmentParameterBody

 

 

False

 

Returns:

          Type:pickupshipmentResponse

 

print

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

printParameterBody

 

 

False

 

Returns:

          Type:printResponse

 

getprinters

Summary: Get Printers

Description: Request returns credentials, the list of available printers, their trays and some additional data.

 

Syntax:

Zenkraft.getprinters ()

 

Returns:

          Type:getprintersResponse

 

getrates

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

getratesParameterBody

 

 

False

 

Returns:

          Type:getratesResponse

 

createshipment

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

createshipmentParameterBody

 

 

False

 

Returns:

          Type:createshipmentResponse

 

trackshipment

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

trackshipmentParameterBody

 

 

False

 

Returns:

          Type:trackshipmentResponse

 


 

cancelshipmentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

cancel

Cancel

 

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

 


 

cancelshipmentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

success

Success

 

success

 

Success

Summary:

Description: success

 

          Properties:

Name

Type

Summary

message

string

 

message

 


 

createshipmentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

shipment

Shipment

 

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

 

recipient

references

array of (ReferencesItem)

 

references

sender

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

 

PackagesItem

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

 

Carrier_specificItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Recipient

Summary:

Description: recipient

 

          Properties:

Name

Type

Summary

city

string

 

city

company

string

 

company

country

string

 

country

email

string

 

email

name

string

 

name

phone

string

 

phone

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

street2

string

 

street2

 

ReferencesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

type

value

string

 

value

 

Sender

Summary:

Description: sender

 

          Properties:

Name

Type

Summary

city

string

 

city

company

string

 

company

country

string

 

country

email

string

 

email

name

string

 

name

phone

string

 

phone

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

street2

string

 

street2

 


 

createshipmentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

shipment

Shipment

 

shipment

 

Shipment

Summary:

Description: shipment

 

          Properties:

Name

Type

Summary

carrier

string

 

carrier

costs

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

 

recipient

references

array of (ReferencesItem)

 

references

sender

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

 

Costs

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

 

PackagesItem

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

 

Recipient

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

 

ReferencesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

type

value

string

 

value

 

Sender

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

 

Shipping_documentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

getprintersResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

credentials

Credentials

 

credentials

printers

array of (PrintersItem)

 

printers

 

Credentials

Summary:

Description: credentials

 

          Properties:

Name

Type

Summary

email

string

 

email

password

string

 

password

 

PrintersItem

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

 


 

getratesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

shipment

Shipment

 

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

 

recipient

sender

Sender

 

sender

shipping_account

string(float)

 

shipping_account

test

boolean

 

test

type

string

 

type

weight_units

string

 

weight_units

 

PackagesItem

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

 

Recipient

Summary:

Description: recipient

 

          Properties:

Name

Type

Summary

city

string

 

city

country

string

 

country

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

 

Sender

Summary:

Description: sender

 

          Properties:

Name

Type

Summary

city

string

 

city

country

string

 

country

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

 


 

getratesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

rates

array of (RatesItem)

 

rates

 

RatesItem

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

 


 

pickupshipmentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

pickup

Pickup

 

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

 

location

shipments

array of (ShipmentsItem)

 

shipments

shipping_account

string(float)

 

shipping_account

test

boolean

 

test

time

Time

 

time

weight_units

string

 

weight_units

 

Location

Summary:

Description: location

 

          Properties:

Name

Type

Summary

city

string

 

city

company

string

 

company

country

string

 

country

email

string

 

email

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

 

ShipmentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

package_type

string

 

package_type

packages

array of (PackagesItem)

 

packages

recipient

Recipient

 

recipient

service

string

 

service

 

PackagesItem

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

 

Recipient

Summary:

Description: recipient

 

          Properties:

Name

Type

Summary

city

string

 

city

company

string

 

company

country

string

 

country

email

string

 

email

name

string

 

name

phone

string

 

phone

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

 

Time

Summary:

Description: time

 

          Properties:

Name

Type

Summary

close_time

string

 

close_time

date

string

 

date

ready_time

string

 

ready_time

 


 

pickupshipmentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

shipment

Shipment

 

shipment

 

Shipment

Summary:

Description: shipment

 

          Properties:

Name

Type

Summary

carrier

string

 

carrier

checkpoints

array of (CheckpointsItem)

 

checkpoints

costs

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

 

recipient

references

array of (ReferencesItem)

 

references

sender

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

 

CheckpointsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

 

description

location

Location

 

location

signed_by

string

 

signed_by

time

string

 

time

 

Location

Summary:

Description: location

 

          Properties:

Name

Type

Summary

city

string

 

city

country

string

 

country

state

string

 

state

 

Costs

Summary:

Description: costs

 

          Properties:

Name

Type

Summary

currency

string

 

currency

net_charge

string

 

net_charge

 

PackagesItem

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

 

Recipient

Summary:

Description: recipient

 

          Properties:

Name

Type

Summary

city

string

 

city

company

string

 

company

country

string

 

country

email

string

 

email

name

string

 

name

phone

string

 

phone

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

 

ReferencesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

Sender

Summary:

Description: sender

 

          Properties:

Name

Type

Summary

city

string

 

city

company

string

 

company

country

string

 

country

email

string

 

email

name

string

 

name

phone

string

 

phone

postal_code

string

 

postal_code

state

string

 

state

street1

string

 

street1

 

Special_servicesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

printParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

string

 

content

printer_id

integer(int32)

 

printer_id

tray

string

 

tray


 

printResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

success

Success

 

success

 

Success

Summary:

Description: success

 

          Properties:

Name

Type

Summary

message

string

 

message

 


 

trackshipmentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

track

Track

 

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

 


 

trackshipmentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

carrier

string

 

carrier

checkpoints

array of (CheckpointsItem)

 

checkpoints

status

string

 

status

 

CheckpointsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

 

description

location

Location

 

location

time

string

 

time

 

Location

Summary:

Description: location

 

          Properties:

Name

Type

Summary

city

string

 

city

country

string

 

country

postal_code

string

 

postal_code

state

string

 

state