KosmoKrator

data

ShipEngine Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the ShipEngine KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.shipengine.*. Use lua_read_doc("integrations.shipengine") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic ShipEngine workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.shipengine.list_account_settings({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("shipengine"))' --json
kosmo integrations:lua --eval 'print(docs.read("shipengine.list_account_settings"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local shipengine = app.integrations.shipengine
local result = shipengine.list_account_settings({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.shipengine, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.shipengine.default.* or app.integrations.shipengine.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need ShipEngine, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

ShipEngine

Namespace: shipengine

ShipEngine tools map one-to-one to the official ShipEngine OpenAPI 3.0 operation set. ShipEngine’s public docs note that the service is being rebranded as ShipStation API, while existing ShipEngine endpoints continue to function unchanged.

Authentication uses an API key. The integration sends the configured key as the API-Key header.

Request Shape

  • Path and query parameters use snake_case tool keys while preserving ShipEngine’s official HTTP parameter names internally.
  • JSON payload endpoints accept a body object matching the documented ShipEngine request schema for that operation.
  • Array query parameters use ShipEngine’s OpenAPI serialization hints. Most arrays are repeated query keys; parameters marked explode: false, such as refund_status, are sent as comma-separated values.
  • Returned data is the decoded ShipEngine JSON response. Empty successful responses return { success, status }.

Common Tools

  • shipengine_list_account_settings: List Account Settings (GET /v1/account/settings)
  • shipengine_list_account_images: List Account Images (GET /v1/account/settings/images)
  • shipengine_create_account_image: Create an Account Image (POST /v1/account/settings/images)
  • shipengine_get_account_settings_images_by_id: Get Account Image By ID (GET /v1/account/settings/images/{label_image_id})
  • shipengine_update_account_settings_images_by_id: Update Account Image By ID (PUT /v1/account/settings/images/{label_image_id})
  • shipengine_delete_account_image_by_id: Delete Account Image By Id (DELETE /v1/account/settings/images/{label_image_id})
  • shipengine_parse_address: Parse an address (PUT /v1/addresses/recognize)
  • shipengine_validate_address: Validate An Address (POST /v1/addresses/validate)
  • shipengine_list_batches: List Batches (GET /v1/batches)
  • shipengine_create_batch: Create A Batch (POST /v1/batches)
  • shipengine_get_batch_by_external_id: Get Batch By External ID (GET /v1/batches/external_batch_id/{external_batch_id})
  • shipengine_delete_batch: Delete Batch By Id (DELETE /v1/batches/{batch_id})
  • shipengine_get_batch_by_id: Get Batch By ID (GET /v1/batches/{batch_id})
  • shipengine_update_batch: Update Batch By Id (PUT /v1/batches/{batch_id})

Examples

local carriers = shipengine.shipengine_list_carriers({})

local shipments = shipengine.shipengine_list_shipments({
  shipment_status = "pending",
  page = 1,
  page_size = 25
})

local rates = shipengine.shipengine_calculate_rates({
  body = {
    rate_options = { carrier_ids = { "se-123456" } },
    shipment = {
      validate_address = "no_validation",
      ship_to = { name = "Receiver", address_line1 = "123 Example St", city_locality = "Austin", state_province = "TX", postal_code = "78701", country_code = "US" },
      ship_from = { name = "Sender", address_line1 = "456 Example Ave", city_locality = "Austin", state_province = "TX", postal_code = "78702", country_code = "US" },
      packages = { { weight = { value = 1, unit = "pound" } } }
    }
  }
})

Use sandbox or test credentials when validating label-purchase workflows. Some write operations can create billable shipments, labels, carrier connections, or insurance changes in live accounts.

Raw agent markdown 
# ShipEngine

Namespace: `shipengine`

ShipEngine tools map one-to-one to the official ShipEngine OpenAPI 3.0 operation set. ShipEngine's public docs note that the service is being rebranded as ShipStation API, while existing ShipEngine endpoints continue to function unchanged.

Authentication uses an API key. The integration sends the configured key as the `API-Key` header.

## Request Shape

- Path and query parameters use snake_case tool keys while preserving ShipEngine's official HTTP parameter names internally.
- JSON payload endpoints accept a `body` object matching the documented ShipEngine request schema for that operation.
- Array query parameters use ShipEngine's OpenAPI serialization hints. Most arrays are repeated query keys; parameters marked `explode: false`, such as `refund_status`, are sent as comma-separated values.
- Returned data is the decoded ShipEngine JSON response. Empty successful responses return `{ success, status }`.

## Common Tools

- `shipengine_list_account_settings`: List Account Settings (`GET /v1/account/settings`)
- `shipengine_list_account_images`: List Account Images (`GET /v1/account/settings/images`)
- `shipengine_create_account_image`: Create an Account Image (`POST /v1/account/settings/images`)
- `shipengine_get_account_settings_images_by_id`: Get Account Image By ID (`GET /v1/account/settings/images/{label_image_id}`)
- `shipengine_update_account_settings_images_by_id`: Update Account Image By ID (`PUT /v1/account/settings/images/{label_image_id}`)
- `shipengine_delete_account_image_by_id`: Delete Account Image By Id (`DELETE /v1/account/settings/images/{label_image_id}`)
- `shipengine_parse_address`: Parse an address (`PUT /v1/addresses/recognize`)
- `shipengine_validate_address`: Validate An Address (`POST /v1/addresses/validate`)
- `shipengine_list_batches`: List Batches (`GET /v1/batches`)
- `shipengine_create_batch`: Create A Batch (`POST /v1/batches`)
- `shipengine_get_batch_by_external_id`: Get Batch By External ID (`GET /v1/batches/external_batch_id/{external_batch_id}`)
- `shipengine_delete_batch`: Delete Batch By Id (`DELETE /v1/batches/{batch_id}`)
- `shipengine_get_batch_by_id`: Get Batch By ID (`GET /v1/batches/{batch_id}`)
- `shipengine_update_batch`: Update Batch By Id (`PUT /v1/batches/{batch_id}`)

## Examples

```lua
local carriers = shipengine.shipengine_list_carriers({})

local shipments = shipengine.shipengine_list_shipments({
  shipment_status = "pending",
  page = 1,
  page_size = 25
})

local rates = shipengine.shipengine_calculate_rates({
  body = {
    rate_options = { carrier_ids = { "se-123456" } },
    shipment = {
      validate_address = "no_validation",
      ship_to = { name = "Receiver", address_line1 = "123 Example St", city_locality = "Austin", state_province = "TX", postal_code = "78701", country_code = "US" },
      ship_from = { name = "Sender", address_line1 = "456 Example Ave", city_locality = "Austin", state_province = "TX", postal_code = "78702", country_code = "US" },
      packages = { { weight = { value = 1, unit = "pound" } } }
    }
  }
})
```

Use sandbox or test credentials when validating label-purchase workflows. Some write operations can create billable shipments, labels, carrier connections, or insurance changes in live accounts.
Metadata-derived Lua example 
local result = app.integrations.shipengine.list_account_settings({})
print(result)

Functions

list_account_settings Read

List Account Settings Official ShipEngine endpoint: GET /v1/account/settings.

Lua path
app.integrations.shipengine.list_account_settings
Full name
shipengine.shipengine_list_account_settings
ParameterTypeRequiredDescription
No parameters.
list_account_images Read

List Account Images Official ShipEngine endpoint: GET /v1/account/settings/images.

Lua path
app.integrations.shipengine.list_account_images
Full name
shipengine.shipengine_list_account_images
ParameterTypeRequiredDescription
No parameters.
create_account_image Write

Create an Account Image Official ShipEngine endpoint: POST /v1/account/settings/images.

Lua path
app.integrations.shipengine.create_account_image
Full name
shipengine.shipengine_create_account_image
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create an Account Image.
get_account_image_by_id Read

Get Account Image By ID Official ShipEngine endpoint: GET /v1/account/settings/images/{label_image_id}.

Lua path
app.integrations.shipengine.get_account_image_by_id
Full name
shipengine.shipengine_get_account_settings_images_by_id
ParameterTypeRequiredDescription
label_image_id string yes Label Image Id
update_account_image_by_id Write

Update Account Image By ID Official ShipEngine endpoint: PUT /v1/account/settings/images/{label_image_id}.

Lua path
app.integrations.shipengine.update_account_image_by_id
Full name
shipengine.shipengine_update_account_settings_images_by_id
ParameterTypeRequiredDescription
label_image_id string yes Label Image Id
body object yes JSON request body matching the official ShipEngine schema for Update Account Image By ID.
delete_account_image_by_id Write

Delete Account Image By Id Official ShipEngine endpoint: DELETE /v1/account/settings/images/{label_image_id}.

Lua path
app.integrations.shipengine.delete_account_image_by_id
Full name
shipengine.shipengine_delete_account_image_by_id
ParameterTypeRequiredDescription
label_image_id string yes Label Image Id
parse_address Read

Parse an address Official ShipEngine endpoint: PUT /v1/addresses/recognize.

Lua path
app.integrations.shipengine.parse_address
Full name
shipengine.shipengine_parse_address
ParameterTypeRequiredDescription
body object yes The only required field is text, which is the text to be parsed. You can optionally also provide an address containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
validate_address Read

Validate An Address Official ShipEngine endpoint: POST /v1/addresses/validate.

Lua path
app.integrations.shipengine.validate_address
Full name
shipengine.shipengine_validate_address
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Validate An Address.
list_batches Read

List Batches Official ShipEngine endpoint: GET /v1/batches.

Lua path
app.integrations.shipengine.list_batches
Full name
shipengine.shipengine_list_batches
ParameterTypeRequiredDescription
status string no The possible batch status values
page integer no Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
page_size integer no The number of results to return per response.
sort_dir string no Controls the sort order of the query.
batch_number string no Batch Number
created_at_start string no Only return batches that were created on or after a specific date/time
created_at_end string no Only return batches that were created on or before a specific date/time
processed_at_start string no Only return batches that were processed on or after a specific date/time
processed_at_end string no Only return batches that were processed on or before a specific date/time
sort_by string no The possible batches sort by values
create_batch Write

Create A Batch Official ShipEngine endpoint: POST /v1/batches.

Lua path
app.integrations.shipengine.create_batch
Full name
shipengine.shipengine_create_batch
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create A Batch.
get_batch_by_external_id Read

Get Batch By External ID Official ShipEngine endpoint: GET /v1/batches/external_batch_id/{external_batch_id}.

Lua path
app.integrations.shipengine.get_batch_by_external_id
Full name
shipengine.shipengine_get_batch_by_external_id
ParameterTypeRequiredDescription
external_batch_id string yes path parameter `external_batch_id`.
delete_batch_by_id Write

Delete Batch By Id Official ShipEngine endpoint: DELETE /v1/batches/{batch_id}.

Lua path
app.integrations.shipengine.delete_batch_by_id
Full name
shipengine.shipengine_delete_batch
ParameterTypeRequiredDescription
batch_id string yes Batch ID
get_batch_by_id Read

Get Batch By ID Official ShipEngine endpoint: GET /v1/batches/{batch_id}.

Lua path
app.integrations.shipengine.get_batch_by_id
Full name
shipengine.shipengine_get_batch_by_id
ParameterTypeRequiredDescription
batch_id string yes Batch ID
update_batch_by_id Write

Update Batch By Id Official ShipEngine endpoint: PUT /v1/batches/{batch_id}.

Lua path
app.integrations.shipengine.update_batch_by_id
Full name
shipengine.shipengine_update_batch
ParameterTypeRequiredDescription
batch_id string yes Batch ID
add_batch Write

Add to a Batch Official ShipEngine endpoint: POST /v1/batches/{batch_id}/add.

Lua path
app.integrations.shipengine.add_batch
Full name
shipengine.shipengine_add_to_batch
ParameterTypeRequiredDescription
batch_id string yes Batch ID
body object yes JSON request body matching the official ShipEngine schema for Add to a Batch.
get_batch_errors Read

Get Batch Errors Official ShipEngine endpoint: GET /v1/batches/{batch_id}/errors.

Lua path
app.integrations.shipengine.get_batch_errors
Full name
shipengine.shipengine_list_batch_errors
ParameterTypeRequiredDescription
batch_id string yes Batch ID
page integer no Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
pagesize integer no query parameter `pagesize`.
process_batch_id_labels Read

Process Batch ID Labels Official ShipEngine endpoint: POST /v1/batches/{batch_id}/process/labels.

Lua path
app.integrations.shipengine.process_batch_id_labels
Full name
shipengine.shipengine_process_batch
ParameterTypeRequiredDescription
batch_id string yes Batch ID
body object yes JSON request body matching the official ShipEngine schema for Process Batch ID Labels.
remove_from_batch Write

Remove From Batch Official ShipEngine endpoint: POST /v1/batches/{batch_id}/remove.

Lua path
app.integrations.shipengine.remove_from_batch
Full name
shipengine.shipengine_remove_from_batch
ParameterTypeRequiredDescription
batch_id string yes Batch ID
body object yes JSON request body matching the official ShipEngine schema for Remove From Batch.
list_carriers Read

List Carriers Official ShipEngine endpoint: GET /v1/carriers.

Lua path
app.integrations.shipengine.list_carriers
Full name
shipengine.shipengine_list_carriers
ParameterTypeRequiredDescription
No parameters.
get_carrier_by_id Read

Get Carrier By ID Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}.

Lua path
app.integrations.shipengine.get_carrier_by_id
Full name
shipengine.shipengine_get_carrier_by_id
ParameterTypeRequiredDescription
carrier_id string yes Carrier ID
disconnect_carrier_by_id Read

Disconnect Carrier by ID Official ShipEngine endpoint: DELETE /v1/carriers/{carrier_id}.

Lua path
app.integrations.shipengine.disconnect_carrier_by_id
Full name
shipengine.shipengine_disconnect_carrier_by_id
ParameterTypeRequiredDescription
carrier_id string yes Carrier ID
add_funds_carrier Write

Add Funds To Carrier Official ShipEngine endpoint: PUT /v1/carriers/{carrier_id}/add_funds.

Lua path
app.integrations.shipengine.add_funds_carrier
Full name
shipengine.shipengine_add_funds_to_carrier
ParameterTypeRequiredDescription
carrier_id string yes Carrier ID
body object yes JSON request body matching the official ShipEngine schema for Add Funds To Carrier.
get_carrier_options Read

Get Carrier Options Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/options.

Lua path
app.integrations.shipengine.get_carrier_options
Full name
shipengine.shipengine_get_carrier_options
ParameterTypeRequiredDescription
carrier_id string yes Carrier ID
list_carrier_package_types Read

List Carrier Package Types Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/packages.

Lua path
app.integrations.shipengine.list_carrier_package_types
Full name
shipengine.shipengine_list_carrier_package_types
ParameterTypeRequiredDescription
carrier_id string yes Carrier ID
list_carrier_services Read

List Carrier Services Official ShipEngine endpoint: GET /v1/carriers/{carrier_id}/services.

Lua path
app.integrations.shipengine.list_carrier_services
Full name
shipengine.shipengine_list_carrier_services
ParameterTypeRequiredDescription
carrier_id string yes Carrier ID
connect_carrier_account Read

Connect a carrier account Official ShipEngine endpoint: POST /v1/connections/carriers/{carrier_name}.

Lua path
app.integrations.shipengine.connect_carrier_account
Full name
shipengine.shipengine_connect_carrier
ParameterTypeRequiredDescription
carrier_name string yes The carrier name, such as stamps_com, ups, fedex, or dhl_express.
body object yes JSON request body matching the official ShipEngine schema for Connect a carrier account.
disconnect_carrier Read

Disconnect a carrier Official ShipEngine endpoint: DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}.

Lua path
app.integrations.shipengine.disconnect_carrier
Full name
shipengine.shipengine_disconnect_carrier
ParameterTypeRequiredDescription
carrier_name string yes The carrier name, such as stamps_com, ups, fedex, or dhl_express.
carrier_id string yes Carrier ID
get_carrier_settings Read

Get carrier settings Official ShipEngine endpoint: GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings.

Lua path
app.integrations.shipengine.get_carrier_settings
Full name
shipengine.shipengine_get_carrier_settings
ParameterTypeRequiredDescription
carrier_name string yes The carrier name, such as ups, fedex, or dhl_express.
carrier_id string yes Carrier ID
update_carrier_settings Write

Update carrier settings Official ShipEngine endpoint: PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings.

Lua path
app.integrations.shipengine.update_carrier_settings
Full name
shipengine.shipengine_update_carrier_settings
ParameterTypeRequiredDescription
carrier_name string yes The carrier name, such as ups, fedex, or dhl_express.
carrier_id string yes Carrier ID
body object yes JSON request body matching the official ShipEngine schema for Update carrier settings.
disconnect_shipsurance_account Read

Disconnect a Shipsurance Account Official ShipEngine endpoint: DELETE /v1/connections/insurance/shipsurance.

Lua path
app.integrations.shipengine.disconnect_shipsurance_account
Full name
shipengine.shipengine_disconnect_insurer
ParameterTypeRequiredDescription
No parameters.
connect_shipsurance_account Read

Connect a Shipsurance Account Official ShipEngine endpoint: POST /v1/connections/insurance/shipsurance.

Lua path
app.integrations.shipengine.connect_shipsurance_account
Full name
shipengine.shipengine_connect_insurer
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Connect a Shipsurance Account.
created_combined_label_document Write

Created Combined Label Document Official ShipEngine endpoint: POST /v1/documents/combined_labels.

Lua path
app.integrations.shipengine.created_combined_label_document
Full name
shipengine.shipengine_create_combined_label_document
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Created Combined Label Document.
download_file Read

Download File Official ShipEngine endpoint: GET /v1/downloads/{dir}/{subdir}/{filename}.

Lua path
app.integrations.shipengine.download_file
Full name
shipengine.shipengine_download_file
ParameterTypeRequiredDescription
subdir string yes path parameter `subdir`.
filename string yes path parameter `filename`.
dir string yes path parameter `dir`.
download string no query parameter `download`.
rotation integer no query parameter `rotation`.
list_webhooks Read

List Webhooks Official ShipEngine endpoint: GET /v1/environment/webhooks.

Lua path
app.integrations.shipengine.list_webhooks
Full name
shipengine.shipengine_list_webhooks
ParameterTypeRequiredDescription
No parameters.
create_webhook Write

Create a Webhook Official ShipEngine endpoint: POST /v1/environment/webhooks.

Lua path
app.integrations.shipengine.create_webhook
Full name
shipengine.shipengine_create_webhook
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create a Webhook.
get_webhook_by_id Read

Get Webhook By ID Official ShipEngine endpoint: GET /v1/environment/webhooks/{webhook_id}.

Lua path
app.integrations.shipengine.get_webhook_by_id
Full name
shipengine.shipengine_get_webhook_by_id
ParameterTypeRequiredDescription
webhook_id string yes Webhook ID
update_webhook Write

Update a Webhook Official ShipEngine endpoint: PUT /v1/environment/webhooks/{webhook_id}.

Lua path
app.integrations.shipengine.update_webhook
Full name
shipengine.shipengine_update_webhook
ParameterTypeRequiredDescription
webhook_id string yes Webhook ID
body object yes JSON request body matching the official ShipEngine schema for Update a Webhook.
delete_webhook_by_id Write

Delete Webhook By ID Official ShipEngine endpoint: DELETE /v1/environment/webhooks/{webhook_id}.

Lua path
app.integrations.shipengine.delete_webhook_by_id
Full name
shipengine.shipengine_delete_webhook
ParameterTypeRequiredDescription
webhook_id string yes Webhook ID
add_funds_insurance Write

Add Funds To Insurance Official ShipEngine endpoint: PATCH /v1/insurance/shipsurance/add_funds.

Lua path
app.integrations.shipengine.add_funds_insurance
Full name
shipengine.shipengine_add_funds_to_insurance
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Add Funds To Insurance.
get_insurance_funds_balance Read

Get Insurance Funds Balance Official ShipEngine endpoint: GET /v1/insurance/shipsurance/balance.

Lua path
app.integrations.shipengine.get_insurance_funds_balance
Full name
shipengine.shipengine_get_insurance_balance
ParameterTypeRequiredDescription
No parameters.
list_labels Read

List labels Official ShipEngine endpoint: GET /v1/labels.

Lua path
app.integrations.shipengine.list_labels
Full name
shipengine.shipengine_list_labels
ParameterTypeRequiredDescription
label_status string no Only return labels that are currently in the specified status
service_code string no Only return labels for a specific
carrier_id string no Only return labels for a specific
tracking_number string no Only return labels with a specific tracking number
batch_id string no Only return labels that were created in a specific
rate_id string no Rate ID
shipment_id string no Shipment ID
warehouse_id string no Only return labels that originate from a specific
created_at_start string no Only return labels that were created on or after a specific date/time
created_at_end string no Only return labels that were created on or before a specific date/time
refund_status array no Only return labels with specific refund status/es.
page integer no Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
page_size integer no The number of results to return per response.
sort_dir string no Controls the sort order of the query.
sort_by string no Controls which field the query is sorted by.
purchase_label Write

Purchase Label Official ShipEngine endpoint: POST /v1/labels.

Lua path
app.integrations.shipengine.purchase_label
Full name
shipengine.shipengine_create_label
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Purchase Label.
get_label_by_external_shipment_id Read

Get Label By External Shipment ID Official ShipEngine endpoint: GET /v1/labels/external_shipment_id/{external_shipment_id}.

Lua path
app.integrations.shipengine.get_label_by_external_shipment_id
Full name
shipengine.shipengine_get_label_by_external_shipment_id
ParameterTypeRequiredDescription
external_shipment_id string yes path parameter `external_shipment_id`.
label_download_type string no There are two different ways to : Label Download Type Description -------------------------------------------------- url You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. inline You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.
purchase_label_with_rate_id Write

Purchase Label with Rate ID Official ShipEngine endpoint: POST /v1/labels/rates/{rate_id}.

Lua path
app.integrations.shipengine.purchase_label_with_rate_id
Full name
shipengine.shipengine_create_label_from_rate
ParameterTypeRequiredDescription
rate_id string yes Rate ID
body object yes JSON request body matching the official ShipEngine schema for Purchase Label with Rate ID.
purchase_label_from_rate_shopper Write

Purchase Label from Rate Shopper Official ShipEngine endpoint: POST /v1/labels/rate_shopper_id/{rate_shopper_id}.

Lua path
app.integrations.shipengine.purchase_label_from_rate_shopper
Full name
shipengine.shipengine_create_label_from_rate_shopper
ParameterTypeRequiredDescription
rate_shopper_id string yes The rate selection strategy for the Rate Shopper. This determines which carrier and service will be automatically selected from your wallet carriers based on the rates returned for the shipment.
body object yes Label creation details with inline shipment
purchase_label_with_shipment_id Write

Purchase Label with Shipment ID Official ShipEngine endpoint: POST /v1/labels/shipment/{shipment_id}.

Lua path
app.integrations.shipengine.purchase_label_with_shipment_id
Full name
shipengine.shipengine_create_label_from_shipment
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
body object yes JSON request body matching the official ShipEngine schema for Purchase Label with Shipment ID.
get_label_by_id Read

Get Label By ID Official ShipEngine endpoint: GET /v1/labels/{label_id}.

Lua path
app.integrations.shipengine.get_label_by_id
Full name
shipengine.shipengine_get_label_by_id
ParameterTypeRequiredDescription
label_id string yes Label ID
label_download_type string no There are two different ways to : Label Download Type Description -------------------------------------------------- url You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. inline You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.
create_return_label Write

Create a return label Official ShipEngine endpoint: POST /v1/labels/{label_id}/return.

Lua path
app.integrations.shipengine.create_return_label
Full name
shipengine.shipengine_create_return_label
ParameterTypeRequiredDescription
label_id string yes Label ID
body object yes JSON request body matching the official ShipEngine schema for Create a return label.
get_label_tracking_information Read

Get Label Tracking Information Official ShipEngine endpoint: GET /v1/labels/{label_id}/track.

Lua path
app.integrations.shipengine.get_label_tracking_information
Full name
shipengine.shipengine_get_tracking_log_from_label
ParameterTypeRequiredDescription
label_id string yes Label ID
void_label_by_id Read

Void a Label By ID Official ShipEngine endpoint: PUT /v1/labels/{label_id}/void.

Lua path
app.integrations.shipengine.void_label_by_id
Full name
shipengine.shipengine_void_label
ParameterTypeRequiredDescription
label_id string yes Label ID
cancel_label_refund_request Write

Cancel a label refund request Official ShipEngine endpoint: POST /v1/labels/{label_id}/cancel_refund.

Lua path
app.integrations.shipengine.cancel_label_refund_request
Full name
shipengine.shipengine_cancel_label_refund
ParameterTypeRequiredDescription
label_id string yes Label ID
list_manifests Read

List Manifests Official ShipEngine endpoint: GET /v1/manifests.

Lua path
app.integrations.shipengine.list_manifests
Full name
shipengine.shipengine_list_manifests
ParameterTypeRequiredDescription
warehouse_id string no Warehouse ID
ship_date_start string no ship date start range
ship_date_end string no ship date end range
created_at_start string no Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
created_at_end string no Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
carrier_id string no Carrier ID
page integer no Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
page_size integer no The number of results to return per response.
label_ids array no Array of label ids
create_manifest Write

Create Manifest Official ShipEngine endpoint: POST /v1/manifests.

Lua path
app.integrations.shipengine.create_manifest
Full name
shipengine.shipengine_create_manifest
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create Manifest.
get_manifest_by_id Read

Get Manifest By Id Official ShipEngine endpoint: GET /v1/manifests/{manifest_id}.

Lua path
app.integrations.shipengine.get_manifest_by_id
Full name
shipengine.shipengine_get_manifest_by_id
ParameterTypeRequiredDescription
manifest_id string yes The Manifest Id
get_manifest_request_by_id Read

Get Manifest Request By Id Official ShipEngine endpoint: GET /v1/manifests/requests/{manifest_request_id}.

Lua path
app.integrations.shipengine.get_manifest_request_by_id
Full name
shipengine.shipengine_get_manifest_request_by_id
ParameterTypeRequiredDescription
manifest_request_id string yes The Manifest Request Id
list_custom_package_types Read

List Custom Package Types Official ShipEngine endpoint: GET /v1/packages.

Lua path
app.integrations.shipengine.list_custom_package_types
Full name
shipengine.shipengine_list_package_types
ParameterTypeRequiredDescription
No parameters.
create_custom_package_type Write

Create Custom Package Type Official ShipEngine endpoint: POST /v1/packages.

Lua path
app.integrations.shipengine.create_custom_package_type
Full name
shipengine.shipengine_create_package_type
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create Custom Package Type.
get_custom_package_type_by_id Read

Get Custom Package Type By ID Official ShipEngine endpoint: GET /v1/packages/{package_id}.

Lua path
app.integrations.shipengine.get_custom_package_type_by_id
Full name
shipengine.shipengine_get_package_type_by_id
ParameterTypeRequiredDescription
package_id string yes Package ID
update_custom_package_type_by_id Write

Update Custom Package Type By ID Official ShipEngine endpoint: PUT /v1/packages/{package_id}.

Lua path
app.integrations.shipengine.update_custom_package_type_by_id
Full name
shipengine.shipengine_update_package_type
ParameterTypeRequiredDescription
package_id string yes Package ID
body object yes JSON request body matching the official ShipEngine schema for Update Custom Package Type By ID.
delete_custom_package_by_id Write

Delete A Custom Package By ID Official ShipEngine endpoint: DELETE /v1/packages/{package_id}.

Lua path
app.integrations.shipengine.delete_custom_package_by_id
Full name
shipengine.shipengine_delete_package_type
ParameterTypeRequiredDescription
package_id string yes Package ID
list_scheduled_pickups Read

List Scheduled Pickups Official ShipEngine endpoint: GET /v1/pickups.

Lua path
app.integrations.shipengine.list_scheduled_pickups
Full name
shipengine.shipengine_list_scheduled_pickups
ParameterTypeRequiredDescription
carrier_id string no Carrier ID
warehouse_id string no Warehouse ID
created_at_start string no Only return scheduled pickups that were created on or after a specific date/time
created_at_end string no Only return scheduled pickups that were created on or before a specific date/time
page integer no Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
page_size integer no The number of results to return per response.
schedule_pickup Read

Schedule a Pickup Official ShipEngine endpoint: POST /v1/pickups.

Lua path
app.integrations.shipengine.schedule_pickup
Full name
shipengine.shipengine_schedule_pickup
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Schedule a Pickup.
get_pickup_by_id Read

Get Pickup By ID Official ShipEngine endpoint: GET /v1/pickups/{pickup_id}.

Lua path
app.integrations.shipengine.get_pickup_by_id
Full name
shipengine.shipengine_get_pickup_by_id
ParameterTypeRequiredDescription
pickup_id string yes Pickup Resource ID
delete_scheduled_pickup Write

Delete a Scheduled Pickup Official ShipEngine endpoint: DELETE /v1/pickups/{pickup_id}.

Lua path
app.integrations.shipengine.delete_scheduled_pickup
Full name
shipengine.shipengine_delete_scheduled_pickup
ParameterTypeRequiredDescription
pickup_id string yes Pickup Resource ID
get_shipping_rates Read

Get Shipping Rates Official ShipEngine endpoint: POST /v1/rates.

Lua path
app.integrations.shipengine.get_shipping_rates
Full name
shipengine.shipengine_calculate_rates
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Get Shipping Rates.
get_bulk_rates Read

Get Bulk Rates Official ShipEngine endpoint: POST /v1/rates/bulk.

Lua path
app.integrations.shipengine.get_bulk_rates
Full name
shipengine.shipengine_compare_bulk_rates
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Get Bulk Rates.
estimate_rates Read

Estimate Rates Official ShipEngine endpoint: POST /v1/rates/estimate.

Lua path
app.integrations.shipengine.estimate_rates
Full name
shipengine.shipengine_estimate_rates
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Estimate Rates.
get_rate_by_id Read

Get Rate By ID Official ShipEngine endpoint: GET /v1/rates/{rate_id}.

Lua path
app.integrations.shipengine.get_rate_by_id
Full name
shipengine.shipengine_get_rate_by_id
ParameterTypeRequiredDescription
rate_id string yes Rate ID
list_service_points Read

List Service Points Official ShipEngine endpoint: POST /v1/service_points/list.

Lua path
app.integrations.shipengine.list_service_points
Full name
shipengine.shipengine_service_points_list
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for List Service Points.
get_service_point_by_id Read

Get Service Point By ID Official ShipEngine endpoint: GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}.

Lua path
app.integrations.shipengine.get_service_point_by_id
Full name
shipengine.shipengine_service_points_get_by_id
ParameterTypeRequiredDescription
carrier_code string yes Carrier code
country_code string yes A two-letter
service_point_id string yes path parameter `service_point_id`.
list_shipments Read

List Shipments Official ShipEngine endpoint: GET /v1/shipments.

Lua path
app.integrations.shipengine.list_shipments
Full name
shipengine.shipengine_list_shipments
ParameterTypeRequiredDescription
shipment_status string no The possible shipment status values
batch_id string no Batch ID
tag string no Search for shipments based on the custom tag added to the shipment object
created_at_start string no Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
created_at_end string no Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
modified_at_start string no Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
modified_at_end string no Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
page integer no Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
page_size integer no The number of results to return per response.
sales_order_id string no Sales Order ID
sort_dir string no Controls the sort order of the query.
sort_by string no The possible shipments sort by values
create_shipments Write

Create Shipments Official ShipEngine endpoint: POST /v1/shipments.

Lua path
app.integrations.shipengine.create_shipments
Full name
shipengine.shipengine_create_shipments
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create Shipments.
get_shipment_by_external_id Read

Get Shipment By External ID Official ShipEngine endpoint: GET /v1/shipments/external_shipment_id/{external_shipment_id}.

Lua path
app.integrations.shipengine.get_shipment_by_external_id
Full name
shipengine.shipengine_get_shipment_by_external_id
ParameterTypeRequiredDescription
external_shipment_id string yes path parameter `external_shipment_id`.
parse_shipping_info Read

Parse shipping info Official ShipEngine endpoint: PUT /v1/shipments/recognize.

Lua path
app.integrations.shipengine.parse_shipping_info
Full name
shipengine.shipengine_parse_shipment
ParameterTypeRequiredDescription
body object yes The only required field is text, which is the text to be parsed. You can optionally also provide a shipment containing any already-known values. For example, you probably already know the ship_from address, and you may also already know what carrier and service you want to use.
get_shipment_by_id Read

Get Shipment By ID Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}.

Lua path
app.integrations.shipengine.get_shipment_by_id
Full name
shipengine.shipengine_get_shipment_by_id
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
update_shipment_by_id Write

Update Shipment By ID Official ShipEngine endpoint: PUT /v1/shipments/{shipment_id}.

Lua path
app.integrations.shipengine.update_shipment_by_id
Full name
shipengine.shipengine_update_shipment
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
body object yes JSON request body matching the official ShipEngine schema for Update Shipment By ID.
cancel_shipment Write

Cancel a Shipment Official ShipEngine endpoint: PUT /v1/shipments/{shipment_id}/cancel.

Lua path
app.integrations.shipengine.cancel_shipment
Full name
shipengine.shipengine_cancel_shipments
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
get_shipment_rates Read

Get Shipment Rates Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}/rates.

Lua path
app.integrations.shipengine.get_shipment_rates
Full name
shipengine.shipengine_list_shipment_rates
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
created_at_start string no Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
update_shipments_tags Write

Update Shipments Tags Official ShipEngine endpoint: PUT /v1/shipments/tags.

Lua path
app.integrations.shipengine.update_shipments_tags
Full name
shipengine.shipengine_shipments_update_tags
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Update Shipments Tags.
get_shipment_tags Read

Get Shipment Tags Official ShipEngine endpoint: GET /v1/shipments/{shipment_id}/tags.

Lua path
app.integrations.shipengine.get_shipment_tags
Full name
shipengine.shipengine_shipments_list_tags
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
add_tag_shipment Read

Add Tag to Shipment Official ShipEngine endpoint: POST /v1/shipments/{shipment_id}/tags/{tag_name}.

Lua path
app.integrations.shipengine.add_tag_shipment
Full name
shipengine.shipengine_tag_shipment
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
tag_name string yes Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
remove_tag_from_shipment Read

Remove Tag from Shipment Official ShipEngine endpoint: DELETE /v1/shipments/{shipment_id}/tags/{tag_name}.

Lua path
app.integrations.shipengine.remove_tag_from_shipment
Full name
shipengine.shipengine_untag_shipment
ParameterTypeRequiredDescription
shipment_id string yes Shipment ID
tag_name string yes Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
get_tags Read

Get Tags Official ShipEngine endpoint: GET /v1/tags.

Lua path
app.integrations.shipengine.get_tags
Full name
shipengine.shipengine_list_tags
ParameterTypeRequiredDescription
No parameters.
create_new_tag Write

Create a New Tag Official ShipEngine endpoint: POST /v1/tags.

Lua path
app.integrations.shipengine.create_new_tag
Full name
shipengine.shipengine_create_tag
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create a New Tag.
create_new_tag Write

Create a New Tag Official ShipEngine endpoint: POST /v1/tags/{tag_name}.

Lua path
app.integrations.shipengine.create_new_tag
Full name
shipengine.shipengine_create_tag_2
ParameterTypeRequiredDescription
tag_name string yes Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
delete_tag Write

Delete Tag Official ShipEngine endpoint: DELETE /v1/tags/{tag_name}.

Lua path
app.integrations.shipengine.delete_tag
Full name
shipengine.shipengine_delete_tag
ParameterTypeRequiredDescription
tag_name string yes Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
update_tag_name Read

Update Tag Name Official ShipEngine endpoint: PUT /v1/tags/{tag_name}/{new_tag_name}.

Lua path
app.integrations.shipengine.update_tag_name
Full name
shipengine.shipengine_rename_tag
ParameterTypeRequiredDescription
tag_name string yes Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
new_tag_name string yes Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
get_ephemeral_token Read

Get Ephemeral Token Official ShipEngine endpoint: POST /v1/tokens/ephemeral.

Lua path
app.integrations.shipengine.get_ephemeral_token
Full name
shipengine.shipengine_tokens_get_ephemeral_token
ParameterTypeRequiredDescription
redirect string no Include a redirect url to the application formatted with the ephemeral token.
get_tracking_information Read

Get Tracking Information Official ShipEngine endpoint: GET /v1/tracking.

Lua path
app.integrations.shipengine.get_tracking_information
Full name
shipengine.shipengine_get_tracking_log
ParameterTypeRequiredDescription
carrier_code string no A , such as fedex, dhl_express, stamps_com, etc.
tracking_number string no The tracking number associated with a shipment
carrier_id string no Carrier ID
start_tracking_package Read

Start Tracking a Package Official ShipEngine endpoint: POST /v1/tracking/start.

Lua path
app.integrations.shipengine.start_tracking_package
Full name
shipengine.shipengine_start_tracking
ParameterTypeRequiredDescription
carrier_code string no A , such as fedex, dhl_express, stamps_com, etc.
tracking_number string no The tracking number associated with a shipment
carrier_id string no Carrier ID
stop_tracking_package Read

Stop Tracking a Package Official ShipEngine endpoint: POST /v1/tracking/stop.

Lua path
app.integrations.shipengine.stop_tracking_package
Full name
shipengine.shipengine_stop_tracking
ParameterTypeRequiredDescription
carrier_code string no A , such as fedex, dhl_express, stamps_com, etc.
tracking_number string no The tracking number associated with a shipment
carrier_id string no Carrier ID
list_warehouses Read

List Warehouses Official ShipEngine endpoint: GET /v1/warehouses.

Lua path
app.integrations.shipengine.list_warehouses
Full name
shipengine.shipengine_list_warehouses
ParameterTypeRequiredDescription
No parameters.
create_warehouse Write

Create Warehouse Official ShipEngine endpoint: POST /v1/warehouses.

Lua path
app.integrations.shipengine.create_warehouse
Full name
shipengine.shipengine_create_warehouse
ParameterTypeRequiredDescription
body object yes JSON request body matching the official ShipEngine schema for Create Warehouse.
get_warehouse_by_id Read

Get Warehouse By Id Official ShipEngine endpoint: GET /v1/warehouses/{warehouse_id}.

Lua path
app.integrations.shipengine.get_warehouse_by_id
Full name
shipengine.shipengine_get_warehouse_by_id
ParameterTypeRequiredDescription
warehouse_id string yes Warehouse ID
update_warehouse_by_id Write

Update Warehouse By Id Official ShipEngine endpoint: PUT /v1/warehouses/{warehouse_id}.

Lua path
app.integrations.shipengine.update_warehouse_by_id
Full name
shipengine.shipengine_update_warehouse
ParameterTypeRequiredDescription
warehouse_id string yes Warehouse ID
body object yes JSON request body matching the official ShipEngine schema for Update Warehouse By Id.
delete_warehouse_by_id Write

Delete Warehouse By ID Official ShipEngine endpoint: DELETE /v1/warehouses/{warehouse_id}.

Lua path
app.integrations.shipengine.delete_warehouse_by_id
Full name
shipengine.shipengine_delete_warehouse
ParameterTypeRequiredDescription
warehouse_id string yes Warehouse ID
update_warehouse_settings Write

Update Warehouse Settings Official ShipEngine endpoint: PUT /v1/warehouses/{warehouse_id}/settings.

Lua path
app.integrations.shipengine.update_warehouse_settings
Full name
shipengine.shipengine_update_warehouse_settings
ParameterTypeRequiredDescription
warehouse_id string yes Warehouse ID
body object yes JSON request body matching the official ShipEngine schema for Update Warehouse Settings.