# ShipStation API Free Plan

Endpoints included in the ShipStation API Free plan

## Available Endpoints

table
thead
tr
th
Method
th
Endpoint
th
Description
tbody
tr
td
account
tr
td
span
GET
td
a
code
/v2/account/settings
td
List account settings
tr
td
span
GET
td
a
code
/v2/account/settings/images
td
List account images
tr
td
span
POST
td
a
code
/v2/account/settings/images
td
Create an account image
tr
td
span
GET
td
a
code
/v2/account/settings/images/{label_image_id}
td
Get account image by ID
tr
td
span
PUT
td
a
code
/v2/account/settings/images/{label_image_id}
td
Update account image by ID
tr
td
span
DELETE
td
a
code
/v2/account/settings/images/{label_image_id}
td
Delete account image by ID
tr
td
batches
tr
td
span
GET
td
a
code
/v2/batches
td
List batches
tr
td
span
POST
td
a
code
/v2/batches
td
Create a batch
tr
td
span
GET
td
a
code
/v2/batches/external_batch_id/{external_batch_id}
td
Get batch by external id
tr
td
span
DELETE
td
a
code
/v2/batches/{batch_id}
td
Delete batch by id
tr
td
span
GET
td
a
code
/v2/batches/{batch_id}
td
Get batch by id
tr
td
span
PUT
td
a
code
/v2/batches/{batch_id}
td
Update batch status to 'archived' by id
tr
td
span
POST
td
a
code
/v2/batches/{batch_id}/add
td
Add to a batch
tr
td
span
GET
td
a
code
/v2/batches/{batch_id}/errors
td
Get batch errors
tr
td
span
POST
td
a
code
/v2/batches/{batch_id}/process/labels
td
Process batch id labels
tr
td
span
POST
td
a
code
/v2/batches/{batch_id}/remove
td
Remove from batch
tr
td
carriers
tr
td
span
GET
td
a
code
/v2/carriers
td
List carriers
tr
td
span
GET
td
a
code
/v2/carriers/{carrier_id}
td
Get carrier by id
tr
td
span
GET
td
a
code
/v2/carriers/{carrier_id}/options
td
Get carrier options
tr
td
span
GET
td
a
code
/v2/carriers/{carrier_id}/packages
td
List carrier package types
tr
td
span
GET
td
a
code
/v2/carriers/{carrier_id}/services
td
List carrier services
tr
td
span
DELETE
td
a
code
/v2/carriers/{carrier_id}
td
Disconnect carrier by id
tr
td
span
PUT
td
a
code
/v2/carriers/{carrier_id}/add_funds
td
Add funds to carrier
tr
td
downloads
tr
td
span
GET
td
a
code
/v2/downloads/{dir}/{subdir}/{filename}
td
Download file
tr
td
fulfillments
tr
td
span
GET
td
a
code
/v2/fulfillments
td
List fulfillments
tr
td
span
POST
td
a
code
/v2/fulfillments
td
Create fulfillments
tr
td
inventory
tr
td
span
GET
td
a
code
/v2/inventory
td
List SKU inventory levels
tr
td
span
POST
td
a
code
/v2/inventory
td
Update SKU stock levels and related properties
tr
td
span
GET
td
a
code
/v2/inventory_warehouses
td
List all inventory warehouses
tr
td
span
POST
td
a
code
/v2/inventory_warehouses
td
Create a new inventory warehouse
tr
td
span
GET
td
a
code
/v2/inventory_warehouses/{inventory_warehouse_id}
td
Get a specific inventory warehouse and related properties using its warehouse ID
tr
td
span
PUT
td
a
code
/v2/inventory_warehouses/{inventory_warehouse_id}
td
Update an inventory warehouse name
tr
td
span
DELETE
td
a
code
/v2/inventory_warehouses/{inventory_warehouse_id}
td
Delete an inventory warehouse
tr
td
span
GET
td
a
code
/v2/inventory_locations
td
List all inventory locations
tr
td
span
POST
td
a
code
/v2/inventory_locations
td
Create a new inventory location
tr
td
span
GET
td
a
code
/v2/inventory_locations/{inventory_location_id}
td
Get inventory location by ID
tr
td
span
PUT
td
a
code
/v2/inventory_locations/{inventory_location_id}
td
Update an inventory location
tr
td
span
DELETE
td
a
code
/v2/inventory_locations/{inventory_location_id}
td
Delete an inventory location
tr
td
labels
tr
td
span
GET
td
a
code
/v2/labels
td
List labels
tr
td
span
POST
td
a
code
/v2/labels
td
Purchase label
tr
td
span
POST
td
a
code
/v2/labels/rates/{rate_id}
td
Purchase label with rate id
tr
td
span
POST
td
a
code
/v2/labels/shipment/{shipment_id}
td
Purchase label with shipment id
tr
td
span
POST
td
a
code
/v2/labels/rate_shopper_id/{rate_shopper_id}
td
Purchase label with rate shopper
tr
td
span
POST
td
a
code
/v2/labels/shipping_rules/{shipping_rule_id}
td
Purchase label with shipping rule
tr
td
span
GET
td
a
code
/v2/labels/{label_id}
td
Get label by id
tr
td
span
GET
td
a
code
/v2/labels/external_shipment_id/{external_shipment_id}
td
Get label by external shipment ID
tr
td
span
POST
td
a
code
/v2/labels/{label_id}/return
td
Create a return label
tr
td
span
GET
td
a
code
/v2/labels/{label_id}/track
td
Get label tracking information
tr
td
span
PUT
td
a
code
/v2/labels/{label_id}/void
td
Void a label by id
tr
td
span
POST
td
a
code
/v2/labels/{label_id}/cancel_refund
td
Cancel a label refund request
tr
td
span
POST
td
a
code
/v2/documents/combined_labels
td
Created combined label document
tr
td
mailing
tr
td
span
POST
td
a
code
/v2/mailing/netstamps
td
Create netstamps
tr
td
span
POST
td
a
code
/v2/mailing/mail_labels
td
Create mailing labels
tr
td
span
POST
td
a
code
/v2/mailing/envelopes
td
Create envelope
tr
td
manifests
tr
td
span
GET
td
a
code
/v2/manifests
td
List manifests
tr
td
span
POST
td
a
code
/v2/manifests
td
Create manifest
tr
td
span
GET
td
a
code
/v2/manifests/{manifest_id}
td
Get manifest by id
tr
td
span
GET
td
a
code
/v2/manifests/requests/{manifest_request_id}
td
Get manifest request by ID
tr
td
package pickups
tr
td
span
GET
td
a
code
/v2/pickups
td
List scheduled pickups
tr
td
span
POST
td
a
code
/v2/pickups
td
Schedule a pickup
tr
td
span
GET
td
a
code
/v2/pickups/{pickup_id}
td
Get pickup by id
tr
td
span
DELETE
td
a
code
/v2/pickups/{pickup_id}
td
Delete a scheduled pickup
tr
td
package types
tr
td
span
GET
td
a
code
/v2/packages
td
List custom package types
tr
td
span
POST
td
a
code
/v2/packages
td
Create custom package type
tr
td
span
GET
td
a
code
/v2/packages/{package_id}
td
Get custom package type by id
tr
td
span
PUT
td
a
code
/v2/packages/{package_id}
td
Update custom package type by id
tr
td
span
DELETE
td
a
code
/v2/packages/{package_id}
td
Delete a custom package by id
tr
td
products
tr
td
span
GET
td
a
code
/v2/products
td
List products
tr
td
purchase orders
tr
td
span
GET
td
a
code
/v2/purchase_orders
td
List purchase orders
tr
td
span
POST
td
a
code
/v2/purchase_orders
td
Create a new purchase order
tr
td
span
GET
td
a
code
/v2/purchase_orders/{purchase_order_id}
td
Get purchase order details
tr
td
span
PUT
td
a
code
/v2/purchase_orders/{purchase_order_id}
td
Update a purchase order
tr
td
span
POST
td
a
code
/v2/purchase_orders/{purchase_order_id}/shipping_details
td
Update purchase order shipping details
tr
td
span
POST
td
a
code
/v2/purchase_orders/{purchase_order_id}/status
td
Update purchase order status
tr
td
span
POST
td
a
code
/v2/purchase_orders/{purchase_order_id}/receives
td
Receive purchase order products
tr
td
span
GET
td
a
code
/v2/purchase_orders/{purchase_order_id}/documents/order_summary
td
Get purchase order summary PDF
tr
td
span
GET
td
a
code
/v2/purchase_orders/{purchase_order_id}/documents/received_summary
td
Get purchase order received summary PDF
tr
td
rates
tr
td
span
POST
td
a
code
/v2/rates
td
Get shipping rates
tr
td
span
POST
td
a
code
/v2/rates/estimate
td
Estimate rates
tr
td
span
GET
td
a
code
/v2/rates/{rate_id}
td
Get rate by id
tr
td
span
POST
td
a
code
/v2/rates/bulk
td
Get bulk rates
tr
td
shipments
tr
td
span
GET
td
a
code
/v2/shipments
td
List shipments
tr
td
span
POST
td
a
code
/v2/shipments
td
Create shipments
tr
td
span
POST
td
a
code
/v2/shipments/user
td
Assign user to shipments
tr
td
span
GET
td
a
code
/v2/shipments/external_shipment_id/{external_shipment_id}
td
Get shipment by external id
tr
td
span
GET
td
a
code
/v2/shipments/{shipment_id}
td
Get shipment by id
tr
td
span
PUT
td
a
code
/v2/shipments/{shipment_id}
td
Update a shipment
tr
td
span
PUT
td
a
code
/v2/shipments/{shipment_id}/cancel
td
Cancel a shipment
tr
td
span
GET
td
a
code
/v2/shipments/{shipment_id}/rates
td
Get shipment rates
tr
td
span
GET
td
a
code
/v2/shipments/{shipment_id}/tags
td
Get shipment tags
tr
td
span
POST
td
a
code
/v2/shipments/{shipment_id}/tags/{tag_name}
td
Add tag to shipment
tr
td
span
DELETE
td
a
code
/v2/shipments/{shipment_id}/tags/{tag_name}
td
Remove tag from shipment
tr
td
span
POST
td
a
code
/v2/shipments/{shipment_id}/internal_notes
td
Update internal notes for a shipment
tr
td
suppliers
tr
td
span
GET
td
a
code
/v2/suppliers
td
List suppliers
tr
td
span
POST
td
a
code
/v2/suppliers
td
Create a new supplier
tr
td
span
GET
td
a
code
/v2/suppliers/{supplier_id}
td
Get supplier details
tr
td
span
PUT
td
a
code
/v2/suppliers/{supplier_id}
td
Update a supplier
tr
td
tags
tr
td
span
GET
td
a
code
/v2/tags
td
Get tags
tr
td
span
POST
td
a
code
/v2/tags
td
Create a new tag
tr
td
span
POST
td
a
code
/v2/tags/{tag_name}
td
Create a new tag
tr
td
span
DELETE
td
a
code
/v2/tags/{tag_name}
td
Delete tag
tr
td
span
PUT
td
a
code
/v2/tags/{tag_name}/{new_tag_name}
td
Update tag name
tr
td
tokens
tr
td
span
POST
td
a
code
/v2/tokens/ephemeral
td
Get ephemeral token
tr
td
totes
tr
td
span
GET
td
a
code
/v2/totes
td
List totes
tr
td
span
POST
td
a
code
/v2/totes
td
Create totes in batch
tr
td
span
GET
td
a
code
/v2/totes/quantities
td
Get tote quantities
tr
td
span
GET
td
a
code
/v2/totes/{tote_id}
td
Get tote by ID
tr
td
span
PUT
td
a
code
/v2/totes/{tote_id}
td
Update tote
tr
td
span
DELETE
td
a
code
/v2/totes/{tote_id}
td
Delete tote
tr
td
tracking
tr
td
span
POST
td
a
code
/v2/tracking/stop
td
Stop tracking a package
tr
td
users
tr
td
span
GET
td
a
code
/v2/users
td
List users
tr
td
warehouses
tr
td
span
GET
td
a
code
/v2/warehouses
td
List warehouses
tr
td
span
GET
td
a
code
/v2/warehouses/{warehouse_id}
td
Get warehouse by id
tr
td
span
POST
td
a
code
/v2/warehouses
td
Create warehouse
tr
td
span
PUT
td
a
code
/v2/warehouses/{warehouse_id}
td
Update warehouse by ID
tr
td
span
DELETE
td
a
code
/v2/warehouses/{warehouse_id}
td
Delete warehouse by ID
tr
td
span
PUT
td
a
code
/v2/warehouses/{warehouse_id}/settings
td
Update warehouse settings
tr
td
webhooks
tr
td
span
GET
td
a
code
/v2/environment/webhooks
td
List webhooks
tr
td
span
POST
td
a
code
/v2/environment/webhooks
td
Create a webhook
tr
td
span
GET
td
a
code
/v2/environment/webhooks/{webhook_id}
td
Get webhook by id
tr
td
span
PUT
td
a
code
/v2/environment/webhooks/{webhook_id}
td
Update a webhook
tr
td
span
DELETE
td
a
code
/v2/environment/webhooks/{webhook_id}
td
Delete webhook by id
**Need more information?**
Visit the [Products and Plans overview](/products-and-plans) to learn more about endpoint access and plan differences.