shipengine-openapi-agent/skills/labels/SKILL.md

name, description

name	description
labels-routes	Handle 11 OpenAPI operation(s) under /v1/labels for the labels route group.

labels API Routes

Handle 11 OpenAPI operation(s) under /v1/labels for the labels route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

list_labels

• Operation ID: list_labels
• Route: GET /v1/labels
• Mode: READ
• Summary: List labels
• Parameters:
  • label_status in query
  • service_code in query
  • carrier_id in query
  • tracking_number in query
  • batch_id in query
  • rate_id in query
  • shipment_id in query
  • warehouse_id in query
  • created_at_start in query
  • created_at_end in query
  • refund_status in query
  • page in query
  • page_size in query
  • sort_dir in query
  • sort_by in query

create_label

• Operation ID: create_label
• Route: POST /v1/labels
• Mode: WRITE
• Summary: Purchase Label
• Body: JSON request body accepted.

get_label_by_external_shipment_id

• Operation ID: get_label_by_external_shipment_id
• Route: GET /v1/labels/external_shipment_id/{external_shipment_id}
• Mode: READ
• Summary: Get Label By External Shipment ID
• Parameters:
  • external_shipment_id in path required
  • label_download_type in query

create_label_from_rate

• Operation ID: create_label_from_rate
• Route: POST /v1/labels/rates/{rate_id}
• Mode: WRITE
• Summary: Purchase Label with Rate ID
• Parameters:
  • rate_id in path required
• Body: JSON request body accepted.

create_label_from_rate_shopper

• Operation ID: create_label_from_rate_shopper
• Route: POST /v1/labels/rate_shopper_id/{rate_shopper_id}
• Mode: WRITE
• Summary: Purchase Label from Rate Shopper
• Parameters:
  • rate_shopper_id in path required
• Body: JSON request body accepted.

create_label_from_shipment

• Operation ID: create_label_from_shipment
• Route: POST /v1/labels/shipment/{shipment_id}
• Mode: WRITE
• Summary: Purchase Label with Shipment ID
• Parameters:
  • shipment_id in path required
• Body: JSON request body accepted.

get_label_by_id

• Operation ID: get_label_by_id
• Route: GET /v1/labels/{label_id}
• Mode: READ
• Summary: Get Label By ID
• Parameters:
  • label_id in path required
  • label_download_type in query

create_return_label

• Operation ID: create_return_label
• Route: POST /v1/labels/{label_id}/return
• Mode: WRITE
• Summary: Create a return label
• Parameters:
  • label_id in path required
• Body: JSON request body accepted.

get_tracking_log_from_label

• Operation ID: get_tracking_log_from_label
• Route: GET /v1/labels/{label_id}/track
• Mode: READ
• Summary: Get Label Tracking Information
• Parameters:
  • label_id in path required

void_label

• Operation ID: void_label
• Route: PUT /v1/labels/{label_id}/void
• Mode: WRITE
• Summary: Void a Label By ID
• Parameters:
  • label_id in path required

cancel_label_refund

• Operation ID: cancel_label_refund
• Route: POST /v1/labels/{label_id}/cancel_refund
• Mode: WRITE
• Summary: Cancel a label refund request
• Parameters:
  • label_id in path required