Articles in this section

Available ShipHawk APIs

When you configure an export, import, or other type of flow step using the prebuilt ShipHawk connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the ShipHawk API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Orders

Retrieve all orders

X

Single order based on ID

X

Create an order

X

Update an order

X

Cancel an order

X

Retrieve pick ticket for an order

X

Retrieve pick ticket async for an order

X

List all order shipments

X

List all order's proposed shipments

X

List all order's order line items

X

List all orders shipped line item SKUs

X

List all orders not shipped line item SKUs

X

Combine one or more orders async

X

Split order async

X

Hold one or more orders

X

Remove hold on orders

X

Search orders

X

Delete an order

X

Create order line items for an order

X

Update order line items for an order

X

Delete order line items

X

Retrieve proposed shipments from an order

X

Post proposed shipments/book

X

Book async a proposed shipment

X

Generate a proposed shipment

X

Create a proposed shipment

X

Edit a proposed shipment

X

Delete a proposed shipment

X

Product SKUs

Retrieve all SKUs

X

Get details on a particular product SKU

X

Shipments

Retrieve all shipments

X

Single shipment based on ID

X

Track shipment

X

Retrieve the URL of an address label pdf file

X

Retrieve the URL of a bol pdf file

X

Retrieve the URL of a commercial invoice pdf file

X

Create an external shipment

X

Update a shipment

X

Cancel a shipment

X

Track shipment subscription

X

Create a new shipment

X

Retrieve the URL of the label(s) for a parcel shipment

X

Retrieve the packing slip of a shipment

X

Retrieve count of shipments grouped by status

X

Rates

Create a new rate request

X

Addresses

Create an address

X

Retrieve an address

X

Retrieve an address by code

X

Update an address

X

Delete an address

X

Validate an address

X

List all addresses

X

Retrieve address count

X

Address validate

X

Batches

Retrieve batches list

X

Create a batch

X

Retrieve a batch

X

Update a batch

X

Delete a batch

X

Child account users

Child account retrieve users

X

Child account retrieve user count

X

Child account create user

X

Child account destroy users

X

Child account retrieve user

X

Child account update user

X

Child account destroy the user

X

Child accounts

Create child account

X

Retrieve all child accounts

X

Retrieve counts of enabled/disabled child accounts

X

Retrieve child account

X

Update child account

X

Documents

Create a document on the shipment

X

Retrieve a document from the shipment

X

Update document type of document on the shipment

X

Delete document

X

Email shipping documents

X

Retrieve a list of shipment's documents

X

Job trackers

Retrieve a job tracker object

X

Material containers

List all material containers

X

Search for material containers

X

Create a material container

X

Update a material container

X

Update bulk of material containers by public ID

X

Update bulk of material containers by filter

X

Delete a material container

X

Delete bulk of material containers

X

Retrieve a statistic of material containers

X

Retrieve a filtered statistic of material containers

X

Material containers import

X

Material containers export

X

Material container barcodes generate

X

Shipment notes

Create shipment note

X

Retrieve shipment note

X

Retrieve all shipment notes

X

Update shipment note

X

SKU

Create SKU

X

Get SKU

X

Count SKU

X

Search SKU

X

Delete all SKUs

X

Get bulk SKU import status

X

Unpacked items

Retrieve an unpacked item type

X

List all unpacked items

X

Users

User current

X

User retrieves user

X

Create user

X

Destroy user

X

Warehouses

Retrieve warehouses

X

Delete warehouses

X

Update warehouse

X

Webhooks

Get a list of available webhooks

X

Create a webhook

X

Get a list of created webhooks

X

Delete a webhook

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.