KosmoKrator

data

Shippo Lua API for KosmoKrator Agents

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

Lua Namespace

Agents call this integration through app.integrations.shippo.*. Use lua_read_doc("integrations.shippo") 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 Shippo workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.shippo.list_all_addresses({page = 1, results = 1, shippo_api_version = "example_shippo_api_version"}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("shippo"))' --json
kosmo integrations:lua --eval 'print(docs.read("shippo.list_all_addresses"))' --json

Workflow file

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

workflow.lua 
local shippo = app.integrations.shippo
local result = shippo.list_all_addresses({page = 1, results = 1, shippo_api_version = "example_shippo_api_version"})

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.shippo, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.shippo.default.* or app.integrations.shippo.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Shippo, 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.

Shippo

Namespace: shippo

Shippo tools map one-to-one to the official Shippo OpenAPI 3.1 operation set for API version 2018-02-08. Use these tools to manage addresses, parcels, shipments, rates, labels, tracking, customs data, refunds, carrier accounts, manifests, pickups, service groups, Shippo accounts, and webhooks.

Authentication uses a Shippo live or test API token. The integration sends Authorization: ShippoToken {token} and defaults SHIPPO-API-VERSION to 2018-02-08 unless a different configured version or per-tool shippo_api_version argument is supplied.

Request Shape

  • Path and query parameters use snake_case tool keys even when Shippo’s HTTP parameter is camel/Pascal case, bracketed, or hyphenated.
  • JSON payload endpoints accept a body object matching Shippo’s documented request schema for that operation.
  • Array query parameters are serialized as repeated query keys, including Shippo’s documented bracketed names such as order_status[].
  • Returned data is the decoded Shippo JSON response. Empty successful responses return { success, status }.

Common Tools

  • shippo_list_addresses: List all addresses (GET /addresses)
  • shippo_create_address: Create a new address (POST /addresses)
  • shippo_get_address: Retrieve an address (GET /addresses/{AddressId})
  • shippo_validate_address: Validate an address (GET /addresses/{AddressId}/validate)
  • shippo_create_batch: Create a batch (POST /batches)
  • shippo_get_batch: Retrieve a batch (GET /batches/{BatchId})
  • shippo_add_shipments_to_batch: Add shipments to a batch (POST /batches/{BatchId}/add_shipments)
  • shippo_purchase_batch: Purchase a batch (POST /batches/{BatchId}/purchase)
  • shippo_remove_shipments_from_batch: Remove shipments from a batch (POST /batches/{BatchId}/remove_shipments)
  • shippo_list_carrier_accounts: List all carrier accounts (GET /carrier_accounts)
  • shippo_create_carrier_account: Create a new carrier account (POST /carrier_accounts)
  • shippo_get_carrier_account: Retrieve a carrier account (GET /carrier_accounts/{CarrierAccountId})

Examples

local addresses = shippo.shippo_list_addresses({ results = 5 })

local address = shippo.shippo_create_address({
  body = {
    name = "Test Sender",
    street1 = "123 Example St",
    city = "San Francisco",
    state = "CA",
    zip = "94103",
    country = "US",
    email = "[email protected]"
  }
})

local shipment = shippo.shippo_create_shipment({
  body = {
    address_from = { object_id = "adr_from_example" },
    address_to = { object_id = "adr_to_example" },
    parcels = { { object_id = "prcl_example" } },
    async = false
  }
})

Keep test-mode and production-mode tokens separate. Shippo test tokens can create test labels and tracking scenarios without purchasing live postage.

Raw agent markdown 
# Shippo

Namespace: `shippo`

Shippo tools map one-to-one to the official Shippo OpenAPI 3.1 operation set for API version `2018-02-08`. Use these tools to manage addresses, parcels, shipments, rates, labels, tracking, customs data, refunds, carrier accounts, manifests, pickups, service groups, Shippo accounts, and webhooks.

Authentication uses a Shippo live or test API token. The integration sends `Authorization: ShippoToken {token}` and defaults `SHIPPO-API-VERSION` to `2018-02-08` unless a different configured version or per-tool `shippo_api_version` argument is supplied.

## Request Shape

- Path and query parameters use snake_case tool keys even when Shippo's HTTP parameter is camel/Pascal case, bracketed, or hyphenated.
- JSON payload endpoints accept a `body` object matching Shippo's documented request schema for that operation.
- Array query parameters are serialized as repeated query keys, including Shippo's documented bracketed names such as `order_status[]`.
- Returned data is the decoded Shippo JSON response. Empty successful responses return `{ success, status }`.

## Common Tools

- `shippo_list_addresses`: List all addresses (`GET /addresses`)
- `shippo_create_address`: Create a new address (`POST /addresses`)
- `shippo_get_address`: Retrieve an address (`GET /addresses/{AddressId}`)
- `shippo_validate_address`: Validate an address (`GET /addresses/{AddressId}/validate`)
- `shippo_create_batch`: Create a batch (`POST /batches`)
- `shippo_get_batch`: Retrieve a batch (`GET /batches/{BatchId}`)
- `shippo_add_shipments_to_batch`: Add shipments to a batch (`POST /batches/{BatchId}/add_shipments`)
- `shippo_purchase_batch`: Purchase a batch (`POST /batches/{BatchId}/purchase`)
- `shippo_remove_shipments_from_batch`: Remove shipments from a batch (`POST /batches/{BatchId}/remove_shipments`)
- `shippo_list_carrier_accounts`: List all carrier accounts (`GET /carrier_accounts`)
- `shippo_create_carrier_account`: Create a new carrier account (`POST /carrier_accounts`)
- `shippo_get_carrier_account`: Retrieve a carrier account (`GET /carrier_accounts/{CarrierAccountId}`)

## Examples

```lua
local addresses = shippo.shippo_list_addresses({ results = 5 })

local address = shippo.shippo_create_address({
  body = {
    name = "Test Sender",
    street1 = "123 Example St",
    city = "San Francisco",
    state = "CA",
    zip = "94103",
    country = "US",
    email = "[email protected]"
  }
})

local shipment = shippo.shippo_create_shipment({
  body = {
    address_from = { object_id = "adr_from_example" },
    address_to = { object_id = "adr_to_example" },
    parcels = { { object_id = "prcl_example" } },
    async = false
  }
})
```

Keep test-mode and production-mode tokens separate. Shippo test tokens can create test labels and tracking scenarios without purchasing live postage.
Metadata-derived Lua example 
local result = app.integrations.shippo.list_all_addresses({page = 1, results = 1, shippo_api_version = "example_shippo_api_version"})
print(result)

Functions

list_all_addresses Read

List all addresses Official Shippo endpoint: GET /addresses.

Lua path
app.integrations.shippo.list_all_addresses
Full name
shippo.shippo_list_addresses
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100, default 5)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_address Write

Create a new address Official Shippo endpoint: POST /addresses.

Lua path
app.integrations.shippo.create_new_address
Full name
shippo.shippo_create_address
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Address details.
retrieve_address Read

Retrieve an address Official Shippo endpoint: GET /addresses/{AddressId}.

Lua path
app.integrations.shippo.retrieve_address
Full name
shippo.shippo_get_address
ParameterTypeRequiredDescription
address_id string yes Object ID of the address
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
validate_address Read

Validate an address Official Shippo endpoint: GET /addresses/{AddressId}/validate.

Lua path
app.integrations.shippo.validate_address
Full name
shippo.shippo_validate_address
ParameterTypeRequiredDescription
address_id string yes Object ID of the address
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_batch Write

Create a batch Official Shippo endpoint: POST /batches.

Lua path
app.integrations.shippo.create_batch
Full name
shippo.shippo_create_batch
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Batch details.
retrieve_batch Read

Retrieve a batch Official Shippo endpoint: GET /batches/{BatchId}.

Lua path
app.integrations.shippo.retrieve_batch
Full name
shippo.shippo_get_batch
ParameterTypeRequiredDescription
batch_id string yes Object ID of the batch
page integer no The page number you want to select
results integer no The number of results to return per page (max 100, default 5)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
add_shipments_batch Write

Add shipments to a batch Official Shippo endpoint: POST /batches/{BatchId}/add_shipments.

Lua path
app.integrations.shippo.add_shipments_batch
Full name
shippo.shippo_add_shipments_to_batch
ParameterTypeRequiredDescription
batch_id string yes Object ID of the batch
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Array of shipments to add to the batch
purchase_batch Read

Purchase a batch Official Shippo endpoint: POST /batches/{BatchId}/purchase.

Lua path
app.integrations.shippo.purchase_batch
Full name
shippo.shippo_purchase_batch
ParameterTypeRequiredDescription
batch_id string yes Object ID of the batch
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
remove_shipments_from_batch Write

Remove shipments from a batch Official Shippo endpoint: POST /batches/{BatchId}/remove_shipments.

Lua path
app.integrations.shippo.remove_shipments_from_batch
Full name
shippo.shippo_remove_shipments_from_batch
ParameterTypeRequiredDescription
batch_id string yes Object ID of the batch
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Array of shipments object ids to remove from the batch
list_all_carrier_accounts Read

List all carrier accounts Official Shippo endpoint: GET /carrier_accounts.

Lua path
app.integrations.shippo.list_all_carrier_accounts
Full name
shippo.shippo_list_carrier_accounts
ParameterTypeRequiredDescription
service_levels boolean no Appends the property `service_levels` to each returned carrier account
carrier string no Filter the response by the specified carrier
account_id string no Filter the response by the specified carrier account Id
page integer no The page number you want to select
results integer no The number of results to return per page (max 100, default 5)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_carrier_account Write

Create a new carrier account Official Shippo endpoint: POST /carrier_accounts.

Lua path
app.integrations.shippo.create_new_carrier_account
Full name
shippo.shippo_create_carrier_account
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Examples.
retrieve_carrier_account Read

Retrieve a carrier account Official Shippo endpoint: GET /carrier_accounts/{CarrierAccountId}.

Lua path
app.integrations.shippo.retrieve_carrier_account
Full name
shippo.shippo_get_carrier_account
ParameterTypeRequiredDescription
carrier_account_id string yes Object ID of the carrier account
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
update_carrier_account Write

Update a carrier account Official Shippo endpoint: PUT /carrier_accounts/{CarrierAccountId}.

Lua path
app.integrations.shippo.update_carrier_account
Full name
shippo.shippo_update_carrier_account
ParameterTypeRequiredDescription
carrier_account_id string yes Object ID of the carrier account
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object no Examples.
connect_existing_carrier_account_using_oauth_2_0 Read

Connect an existing carrier account using OAuth 2.0 Official Shippo endpoint: GET /carrier_accounts/{CarrierAccountObjectId}/signin/initiate.

Lua path
app.integrations.shippo.connect_existing_carrier_account_using_oauth_2_0
Full name
shippo.shippo_initiate_oauth2_signin
ParameterTypeRequiredDescription
carrier_account_object_id string yes The carrier account ID (UUID) to start a signin process.
redirect_uri string yes Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.
state string no A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application checks that the same value is returned after the user authorizes Shippo.
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
add_carrier_account Read

Add a Shippo carrier account Official Shippo endpoint: POST /carrier_accounts/register/new.

Lua path
app.integrations.shippo.add_carrier_account
Full name
shippo.shippo_register_carrier_account
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes The body of the request.
get_carrier_registration_status Read

Get Carrier Registration status Official Shippo endpoint: GET /carrier_accounts/reg-status.

Lua path
app.integrations.shippo.get_carrier_registration_status
Full name
shippo.shippo_get_carrier_registration_status
ParameterTypeRequiredDescription
carrier string yes filter by specific carrier
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_customs_declarations Read

List all customs declarations Official Shippo endpoint: GET /customs/declarations.

Lua path
app.integrations.shippo.list_all_customs_declarations
Full name
shippo.shippo_list_customs_declarations
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100, default 5)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_customs_declaration Write

Create a new customs declaration Official Shippo endpoint: POST /customs/declarations.

Lua path
app.integrations.shippo.create_new_customs_declaration
Full name
shippo.shippo_create_customs_declaration
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes CustomsDeclaration details.
retrieve_customs_declaration Read

Retrieve a customs declaration Official Shippo endpoint: GET /customs/declarations/{CustomsDeclarationId}.

Lua path
app.integrations.shippo.retrieve_customs_declaration
Full name
shippo.shippo_get_customs_declaration
ParameterTypeRequiredDescription
customs_declaration_id string yes Object ID of the customs declaration
page integer no The page number you want to select
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_customs_items Read

List all customs items Official Shippo endpoint: GET /customs/items.

Lua path
app.integrations.shippo.list_all_customs_items
Full name
shippo.shippo_list_customs_items
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_customs_item Write

Create a new customs item Official Shippo endpoint: POST /customs/items.

Lua path
app.integrations.shippo.create_new_customs_item
Full name
shippo.shippo_create_customs_item
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes CustomsItem details.
retrieve_customs_item Read

Retrieve a customs item Official Shippo endpoint: GET /customs/items/{CustomsItemId}.

Lua path
app.integrations.shippo.retrieve_customs_item
Full name
shippo.shippo_get_customs_item
ParameterTypeRequiredDescription
customs_item_id string yes Object ID of the customs item
page integer no The page number you want to select
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
generate_live_rates_request Write

Generate a live rates request Official Shippo endpoint: POST /live-rates.

Lua path
app.integrations.shippo.generate_live_rates_request
Full name
shippo.shippo_create_live_rate
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Generate rates at checkout
show_current_default_parcel_template Read

Show current default parcel template Official Shippo endpoint: GET /live-rates/settings/parcel-template.

Lua path
app.integrations.shippo.show_current_default_parcel_template
Full name
shippo.shippo_get_default_parcel_template
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
update_default_parcel_template Write

Update default parcel template Official Shippo endpoint: PUT /live-rates/settings/parcel-template.

Lua path
app.integrations.shippo.update_default_parcel_template
Full name
shippo.shippo_update_default_parcel_template
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object no JSON request body matching the official Shippo schema for Update default parcel template.
clear_current_default_parcel_template Write

Clear current default parcel template Official Shippo endpoint: DELETE /live-rates/settings/parcel-template.

Lua path
app.integrations.shippo.clear_current_default_parcel_template
Full name
shippo.shippo_delete_default_parcel_template
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_manifests Read

List all manifests Official Shippo endpoint: GET /manifests.

Lua path
app.integrations.shippo.list_all_manifests
Full name
shippo.shippo_list_manifests
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100, default 5)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_manifest Write

Create a new manifest Official Shippo endpoint: POST /manifests.

Lua path
app.integrations.shippo.create_new_manifest
Full name
shippo.shippo_create_manifest
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Manifest details and contact info.
retrieve_manifest Read

Retrieve a manifest Official Shippo endpoint: GET /manifests/{ManifestId}.

Lua path
app.integrations.shippo.retrieve_manifest
Full name
shippo.shippo_get_manifest
ParameterTypeRequiredDescription
manifest_id string yes Object ID of the manifest to update
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_orders Read

List all orders Official Shippo endpoint: GET /orders.

Lua path
app.integrations.shippo.list_all_orders
Full name
shippo.shippo_list_orders
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
order_status array no Filter orders by order status
shop_app string no Filter orders by shop app
start_date string no Filter orders created after the input date and time (ISO 8601 UTC format). This is based on the `placed_at` field, meaning when the order has been placed, not when the order object was created.
end_date string no Filter orders created before the input date and time (ISO 8601 UTC format). This is based on the `placed_at` field, meaning when the order has been placed, not when the order object was created.
create_new_order Write

Create a new order Official Shippo endpoint: POST /orders.

Lua path
app.integrations.shippo.create_new_order
Full name
shippo.shippo_create_order
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Order details.
retrieve_order Read

Retrieve an order Official Shippo endpoint: GET /orders/{OrderId}.

Lua path
app.integrations.shippo.retrieve_order
Full name
shippo.shippo_get_order
ParameterTypeRequiredDescription
order_id string yes Object ID of the order
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_carrier_parcel_templates Read

List all carrier parcel templates Official Shippo endpoint: GET /parcel-templates.

Lua path
app.integrations.shippo.list_all_carrier_parcel_templates
Full name
shippo.shippo_list_carrier_parcel_templates
ParameterTypeRequiredDescription
include string no filter by user or enabled
carrier string no filter by specific carrier
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
retrieve_carrier_parcel_templates Read

Retrieve a carrier parcel templates Official Shippo endpoint: GET /parcel-templates/{CarrierParcelTemplateToken}.

Lua path
app.integrations.shippo.retrieve_carrier_parcel_templates
Full name
shippo.shippo_get_carrier_parcel_template
ParameterTypeRequiredDescription
carrier_parcel_template_token string yes The unique string representation of the carrier parcel template
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_parcels Read

List all parcels Official Shippo endpoint: GET /parcels.

Lua path
app.integrations.shippo.list_all_parcels
Full name
shippo.shippo_list_parcels
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_parcel Write

Create a new parcel Official Shippo endpoint: POST /parcels.

Lua path
app.integrations.shippo.create_new_parcel
Full name
shippo.shippo_create_parcel
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Parcel details.
retrieve_existing_parcel Read

Retrieve an existing parcel Official Shippo endpoint: GET /parcels/{ParcelId}.

Lua path
app.integrations.shippo.retrieve_existing_parcel
Full name
shippo.shippo_get_parcel
ParameterTypeRequiredDescription
parcel_id string yes Object ID of the parcel
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_pickup Write

Create a pickup Official Shippo endpoint: POST /pickups.

Lua path
app.integrations.shippo.create_pickup
Full name
shippo.shippo_create_pickup
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Shippos pickups endpoint allows you to schedule pickups with USPS and DHL Express for eligible shipments that you have already created.
retrieve_rate Read

Retrieve a rate Official Shippo endpoint: GET /rates/{RateId}.

Lua path
app.integrations.shippo.retrieve_rate
Full name
shippo.shippo_get_rate
ParameterTypeRequiredDescription
rate_id string yes Object ID of the rate
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_refund Write

Create a refund Official Shippo endpoint: POST /refunds.

Lua path
app.integrations.shippo.create_refund
Full name
shippo.shippo_create_refund
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Refund details
list_all_refunds Read

List all refunds Official Shippo endpoint: GET /refunds/.

Lua path
app.integrations.shippo.list_all_refunds
Full name
shippo.shippo_list_refunds
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
retrieve_refund Read

Retrieve a refund Official Shippo endpoint: GET /refunds/{RefundId}.

Lua path
app.integrations.shippo.retrieve_refund
Full name
shippo.shippo_get_refund
ParameterTypeRequiredDescription
refund_id string yes Object ID of the refund to update
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_service_groups Read

List all service groups Official Shippo endpoint: GET /service-groups.

Lua path
app.integrations.shippo.list_all_service_groups
Full name
shippo.shippo_list_service_groups
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_service_group Write

Create a new service group Official Shippo endpoint: POST /service-groups.

Lua path
app.integrations.shippo.create_new_service_group
Full name
shippo.shippo_create_service_group
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes JSON request body matching the official Shippo schema for Create a new service group.
update_existing_service_group Write

Update an existing service group Official Shippo endpoint: PUT /service-groups.

Lua path
app.integrations.shippo.update_existing_service_group
Full name
shippo.shippo_update_service_group
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object no JSON request body matching the official Shippo schema for Update an existing service group.
delete_service_group Write

Delete a service group Official Shippo endpoint: DELETE /service-groups/{ServiceGroupId}.

Lua path
app.integrations.shippo.delete_service_group
Full name
shippo.shippo_delete_service_group
ParameterTypeRequiredDescription
service_group_id string yes Object ID of the service group
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_shipments Read

List all shipments Official Shippo endpoint: GET /shipments.

Lua path
app.integrations.shippo.list_all_shipments
Full name
shippo.shippo_list_shipments
ParameterTypeRequiredDescription
page_token string no The page token for paginated results
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
object_created_gt string no Object(s) created greater than a provided date and time.
object_created_gte string no Object(s) created greater than or equal to a provided date and time.
object_created_lt string no Object(s) created lesser than a provided date and time.
object_created_lte string no Object(s) created lesser than or equal to a provided date and time.
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_shipment Write

Create a new shipment Official Shippo endpoint: POST /shipments.

Lua path
app.integrations.shippo.create_new_shipment
Full name
shippo.shippo_create_shipment
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Shipment details and contact info.
retrieve_shipment Read

Retrieve a shipment Official Shippo endpoint: GET /shipments/{ShipmentId}.

Lua path
app.integrations.shippo.retrieve_shipment
Full name
shippo.shippo_get_shipment
ParameterTypeRequiredDescription
shipment_id string yes Object ID of the shipment to update
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
retrieve_shipment_rates Read

Retrieve shipment rates Official Shippo endpoint: GET /shipments/{ShipmentId}/rates.

Lua path
app.integrations.shippo.retrieve_shipment_rates
Full name
shippo.shippo_list_shipment_rates
ParameterTypeRequiredDescription
shipment_id string yes Object ID of the shipment to update
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
retrieve_shipment_rates_currency Read

Retrieve shipment rates in currency Official Shippo endpoint: GET /shipments/{ShipmentId}/rates/{CurrencyCode}.

Lua path
app.integrations.shippo.retrieve_shipment_rates_currency
Full name
shippo.shippo_list_shipment_rates_by_currency_code
ParameterTypeRequiredDescription
shipment_id string yes Object ID of the shipment to update
currency_code string yes ISO currency code for the rates
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
register_tracking_webhook Write

Register a tracking webhook Official Shippo endpoint: POST /tracks.

Lua path
app.integrations.shippo.register_tracking_webhook
Full name
shippo.shippo_create_track
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes JSON request body matching the official Shippo schema for Register a tracking webhook.
get_tracking_status Read

Get a tracking status Official Shippo endpoint: GET /tracks/{Carrier}/{TrackingNumber}.

Lua path
app.integrations.shippo.get_tracking_status
Full name
shippo.shippo_get_track
ParameterTypeRequiredDescription
tracking_number string yes Tracking number
carrier string yes Name of the carrier
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_shipping_labels Read

List all shipping labels Official Shippo endpoint: GET /transactions.

Lua path
app.integrations.shippo.list_all_shipping_labels
Full name
shippo.shippo_list_transactions
ParameterTypeRequiredDescription
rate string no Filter by rate ID
object_status string no Filter by object status
tracking_status string no Filter by tracking status
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_shipping_label Write

Create a shipping label Official Shippo endpoint: POST /transactions.

Lua path
app.integrations.shippo.create_shipping_label
Full name
shippo.shippo_create_transaction
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes Examples.
retrieve_shipping_label Read

Retrieve a shipping label Official Shippo endpoint: GET /transactions/{TransactionId}.

Lua path
app.integrations.shippo.retrieve_shipping_label
Full name
shippo.shippo_get_transaction
ParameterTypeRequiredDescription
transaction_id string yes Object ID of the transaction to update
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
list_all_user_parcel_templates Read

List all user parcel templates Official Shippo endpoint: GET /user-parcel-templates.

Lua path
app.integrations.shippo.list_all_user_parcel_templates
Full name
shippo.shippo_list_user_parcel_templates
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_new_user_parcel_template Write

Create a new user parcel template Official Shippo endpoint: POST /user-parcel-templates.

Lua path
app.integrations.shippo.create_new_user_parcel_template
Full name
shippo.shippo_create_user_parcel_template
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes JSON request body matching the official Shippo schema for Create a new user parcel template.
delete_user_parcel_template Write

Delete a user parcel template Official Shippo endpoint: DELETE /user-parcel-templates/{UserParcelTemplateObjectId}.

Lua path
app.integrations.shippo.delete_user_parcel_template
Full name
shippo.shippo_delete_user_parcel_template
ParameterTypeRequiredDescription
user_parcel_template_object_id string yes Object ID of the user parcel template
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
retrieves_user_parcel_template Read

Retrieves a user parcel template Official Shippo endpoint: GET /user-parcel-templates/{UserParcelTemplateObjectId}.

Lua path
app.integrations.shippo.retrieves_user_parcel_template
Full name
shippo.shippo_get_user_parcel_template
ParameterTypeRequiredDescription
user_parcel_template_object_id string yes Object ID of the user parcel template
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
update_existing_user_parcel_template Write

Update an existing user parcel template Official Shippo endpoint: PUT /user-parcel-templates/{UserParcelTemplateObjectId}.

Lua path
app.integrations.shippo.update_existing_user_parcel_template
Full name
shippo.shippo_update_user_parcel_template
ParameterTypeRequiredDescription
user_parcel_template_object_id string yes Object ID of the user parcel template
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object no JSON request body matching the official Shippo schema for Update an existing user parcel template.
list_all_accounts Read

List all Shippo Accounts Official Shippo endpoint: GET /shippo-accounts.

Lua path
app.integrations.shippo.list_all_accounts
Full name
shippo.shippo_list_shippo_accounts
ParameterTypeRequiredDescription
page integer no The page number you want to select
results integer no The number of results to return per page (max 100)
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
create_account Write

Create a Shippo Account Official Shippo endpoint: POST /shippo-accounts.

Lua path
app.integrations.shippo.create_account
Full name
shippo.shippo_create_shippo_account
ParameterTypeRequiredDescription
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object yes JSON request body matching the official Shippo schema for Create a Shippo Account.
retrieve_account Read

Retrieve a Shippo Account Official Shippo endpoint: GET /shippo-accounts/{ShippoAccountId}.

Lua path
app.integrations.shippo.retrieve_account
Full name
shippo.shippo_get_shippo_account
ParameterTypeRequiredDescription
shippo_account_id string yes Object ID of the ShippoAccount
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
update_account Write

Update a Shippo Account Official Shippo endpoint: PUT /shippo-accounts/{ShippoAccountId}.

Lua path
app.integrations.shippo.update_account
Full name
shippo.shippo_update_shippo_account
ParameterTypeRequiredDescription
shippo_account_id string yes Object ID of the ShippoAccount
shippo_api_version string no Optional string used to pick a non-default API version to use. See our API version guide.
body object no JSON request body matching the official Shippo schema for Update a Shippo Account.
create_new_webhook Write

Create a new webhook Official Shippo endpoint: POST /webhooks.

Lua path
app.integrations.shippo.create_new_webhook
Full name
shippo.shippo_create_webhook
ParameterTypeRequiredDescription
body object yes JSON request body matching the official Shippo schema for Create a new webhook.
list_all_webhooks Read

List all webhooks Official Shippo endpoint: GET /webhooks.

Lua path
app.integrations.shippo.list_all_webhooks
Full name
shippo.shippo_list_webhooks
ParameterTypeRequiredDescription
No parameters.
retrieve_specific_webhook Read

Retrieve a specific webhook Official Shippo endpoint: GET /webhooks/{webhookId}.

Lua path
app.integrations.shippo.retrieve_specific_webhook
Full name
shippo.shippo_get_webhook
ParameterTypeRequiredDescription
webhook_id string yes Object ID of the webhook to retrieve
update_existing_webhook Write

Update an existing webhook Official Shippo endpoint: PUT /webhooks/{webhookId}.

Lua path
app.integrations.shippo.update_existing_webhook
Full name
shippo.shippo_update_webhook
ParameterTypeRequiredDescription
webhook_id string yes Object ID of the webhook to retrieve
body object yes JSON request body matching the official Shippo schema for Update an existing webhook.
delete_specific_webhook Write

Delete a specific webhook Official Shippo endpoint: DELETE /webhooks/{webhookId}.

Lua path
app.integrations.shippo.delete_specific_webhook
Full name
shippo.shippo_delete_webhook
ParameterTypeRequiredDescription
webhook_id string yes Object ID of the webhook to delete