Account
ReadFetch account records matching the supplied arguments.
Permissions and limits
Account permissions
- A ShipHero access token with the needed scopes
Run ShipHero warehouse operations: orders, shipments, products, inventory, purchase and wholesale orders, returns, locations, totes, work orders and webhooks.
Explore 176 workflow actions for ShipHero, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Fetch account records matching the supplied arguments.
Run the assembly_add_components mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the assembly_clear_components mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the assembly_remove_components mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the assembly_update_components mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch carrier box records matching the supplied arguments.
Run the carrier_box_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch carrier boxes matching the supplied arguments.
Run the clear_tote mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch custom box records matching the supplied arguments.
Run the custom_box_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the custom_box_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the custom_box_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch custom boxes matching the supplied arguments.
Fetch cycle count records matching the supplied arguments.
Run the cycle_count_items_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the cycle_count_locations_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the cycle_count_recount_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch cycle counts matching the supplied arguments.
Fetch expiration lots matching the supplied arguments.
Fetch inbound shipment records matching the supplied arguments.
Run the inbound_shipment_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch inbound shipment images matching the supplied arguments.
Fetch inbound shipment location summary records matching the supplied arguments.
Fetch inbound shipment summary records matching the supplied arguments.
Run the inbound_shipment_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch inbound shipments matching the supplied arguments.
Run the inventory_abort_snapshot mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the inventory_add mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch inventory changes matching the supplied arguments.
Run the inventory_generate_snapshot mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the inventory_remove mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the inventory_replace mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch inventory snapshot records matching the supplied arguments.
Fetch inventory snapshots matching the supplied arguments.
Run the inventory_subtract mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the inventory_sync mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the inventory_sync_abort mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch inventory sync items status matching the supplied arguments.
Fetch inventory sync status matching the supplied arguments.
Fetch inventory sync statuses matching the supplied arguments.
Run the inventory_transfer mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the item_location_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch item locations matching the supplied arguments.
Run the kit_build mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the kit_clear mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the kit_remove_components mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns a paginated list of top-level active jobs in a warehouse.
Fetch labor units matching the supplied arguments.
Returns a paginated list of workers in a warehouse.
Fetch paginated license plate numbers using exact filters.
Run the license_plate_numbers_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the license_plate_numbers_move mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch location records matching the supplied arguments.
Run the location_bulk_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the location_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the location_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the location_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch locations matching the supplied arguments.
Run the lot_assign_to_location mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the lot_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the lot_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the lot_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the lots_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch the authenticated public API user and account context.
Fetch mergeable orders matching the supplied arguments.
Fetch order records matching the supplied arguments.
Run the order_add_attachment mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_add_history_entry mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_add_line_items mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_add_tags mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_bulk_add_tags mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_bulk_remove_tags mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_cancel mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_change_warehouse mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_clear_tags mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_fulfill mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_fulfillment_status_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch order history records matching the supplied arguments.
Run the order_merge mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_remove_line_items mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_set_line_item_sku mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_unmerge mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_update_fulfillment_status mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_update_holds mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_update_line_items mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the order_update_tags mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch orders matching the supplied arguments.
Returns a paginated list of packer performance stats for a warehouse.
Gets the details of each shipment's package between the specified dates.
Returns a paginated list of picker performance stats for a warehouse.
Gets the details of each line item picked between the specified dates.
Fetch product records matching the supplied arguments.
Run the product_add_to_warehouse mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the product_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the product_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the product_delete_image mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the product_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch products matching the supplied arguments.
Fetch purchase order records matching the supplied arguments.
Run the purchase_order_add_attachment mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the purchase_order_cancel mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the purchase_order_close mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the purchase_order_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the purchase_order_set_fulfillment_status mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the purchase_order_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch purchase orders matching the supplied arguments.
Fetch return records matching the supplied arguments.
Run the return_add_attachment mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the return_create_exchange mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch return exchange records matching the supplied arguments.
Run the return_receive_line_item mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the return_update_status mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch returns matching the supplied arguments.
Fetch shipment records matching the supplied arguments.
Run the shipment_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the shipment_create_shipping_label mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch shipments matching the supplied arguments.
Fetch shipping container records matching the supplied arguments.
Run the shipping_container_add_shipping_label mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the shipping_container_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the shipping_container_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the shipping_container_remove_shipping_label mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch shipping containers matching the supplied arguments.
Fetch shipping plan records matching the supplied arguments.
Run the shipping_plan_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Returns information about a tote.
Run the tote_clear mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the tote_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the tote_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch tote history records matching the supplied arguments.
Run the tote_transfer_to_location mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the tote_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch totes matching the supplied arguments.
Fetch user records matching the supplied arguments.
User quota for this user quota orders.
Run the user_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch users matching the supplied arguments.
When using the old webhooks, you might receive resource IDs as numeric IDs.
Run the vendor_add_product mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the vendor_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the vendor_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the vendor_remove_product mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch vendors matching the supplied arguments.
Run the warehouse_product_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the warehouse_product_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch warehouse products matching the supplied arguments.
Run the warehouse_profile_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the webhook_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the webhook_delete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the webhook_disable mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the webhook_enable mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the webhook_update_url mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch webhooks matching the supplied arguments.
Returns customer webhook call logs.
Fetch wholesale order records matching the supplied arguments.
Run the wholesale_order_auto_allocate_for_picking mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_edit_outbound_schedule mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_fulfill mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_import_packing_layout mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_mark_as_packed mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_transfer_picks_to_staging mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_update mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_update_picking_flow mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the wholesale_order_update_staging_location mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch wholesale orders matching the supplied arguments.
Run the wholesale_set_as_ready_to_pick mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch wholesale staging location candidates matching the supplied arguments.
Fetch work order records matching the supplied arguments.
Run the work_order_auto_assign_pick_locations mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the work_order_complete mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run the work_order_create mutation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch work orders matching the supplied arguments.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in ShipHero. A saved workflow is not a completed provider action.