Public REST/JSON reference

Shipping Profit Maximizer API

Compare carrier rates, select compliant low-cost shipping options, purchase labels, track shipments, and measure net margin after fulfillment cost for e-commerce orders. Part of the Logic Igniter E-commerce Operations bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/shippingprofit.json

Operations rendered

Response models rendered

GET/api/v1/shippingprofit/health

Service liveness

Liveness probe for Shipping Profit Maximizer API. Returns 200 when the public API route is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/shippingprofit/customers

List customers

List customers record for the customer workspace used by Shipping Profit Maximizer API.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CustomerList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

PUT/api/v1/shippingprofit/customers/{id}

Update customer

Update customer record for the customer workspace used by Shipping Profit Maximizer API.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string	Id

Request body (required)

Schema: CustomerInput

Sample JSON payload for evaluation.

{
  "companyName": "Mira Home Goods",
  "email": "[email protected]"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/shippingprofit/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"companyName":"Mira Home Goods","email":"[email protected]"}'

Responses

200Customer

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

GET/api/v1/shippingprofit/analyses

List shipping analyses

List recent shipping profitability analyses.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/analyses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ShippingAnalysisList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/shippingprofit/analyses/{id}

Get shipping analysis

Read a saved shipping profitability analysis.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string	Id

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/analyses/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ShippingAnalysis

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/shippingprofit/orders/{order_id}/rates

Rate order

Compare carrier services and costs for an order package and destination.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`order_id`required	path	string	Order Id

Request body (required)

Schema: RateOrderRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "RateOrderRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/shippingprofit/orders/:order_id/rates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"RateOrderRequest"}'

Responses

200RateQuoteList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/shippingprofit/orders/{order_id}/carrier

Select carrier

Select the cheapest compliant carrier service for an order.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`order_id`required	path	string	Order Id

Request body (required)

Schema: SelectCarrierRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "SelectCarrierRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/shippingprofit/orders/:order_id/carrier" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"SelectCarrierRequest"}'

Responses

200CarrierSelection

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/shippingprofit/orders/{order_id}/label

Purchase label

Purchase a shipping label for the selected carrier service.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`order_id`required	path	string	Order Id

Request body (required)

Schema: PurchaseLabelRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "PurchaseLabelRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/shippingprofit/orders/:order_id/label" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"PurchaseLabelRequest"}'

Responses

200ShippingLabel

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

GET/api/v1/shippingprofit/labels/{id}

Get label

Retrieve purchased label metadata and download URLs.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string	Id

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/labels/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ShippingLabel

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/shippingprofit/labels/{id}/void

Void label

Void an unused label and record the refund state.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string	Id

Request body (required)

Schema: VoidLabelRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "VoidLabelRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/shippingprofit/labels/:id/void" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"VoidLabelRequest"}'

Responses

200VoidLabelResult

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

GET/api/v1/shippingprofit/shipments/{tracking_number}/track

Track shipment

Return current carrier tracking status and events.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`tracking_number`required	path	string	Tracking Number

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/shipments/:tracking_number/track" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ShipmentTracking

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/shippingprofit/orders/sync

Sync orders

Import orders awaiting shipment from the storefront.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: OrderSyncRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "OrderSyncRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/shippingprofit/orders/sync" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"OrderSyncRequest"}'

Responses

200OrderSyncResult

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/shippingprofit/orders/pending

List pending orders

List orders that still need carrier selection or labels.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/orders/pending" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200PendingOrderList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/shippingprofit/orders/{order_id}/shipping

Get order shipping

Read selected service, label, cost, and tracking data for an order.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`order_id`required	path	string	Order Id

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/orders/:order_id/shipping" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200OrderShipping

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

GET/api/v1/shippingprofit/savings/summary

Get savings summary

Summarize shipping savings and net margin preservation.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/savings/summary" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SavingsSummary

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/shippingprofit/savings/by-carrier

Get savings by carrier

Break down savings, spend, and average delivery time by carrier.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/savings/by-carrier" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CarrierSavingsList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/shippingprofit/orders/{order_id}/savings

Get order savings

Read selected-versus-alternative savings for one order.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`order_id`required	path	string	Order Id

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/shippingprofit/orders/:order_id/savings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200OrderSavings

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

Data models

Customer

Field	Type	Notes
`id`required	string	Example: "cus_mira_home"
`companyName`required	string	Example: "Mira Home Goods"
`email`required	string (email)	Example: "[email protected]"
`bundle`required	string	Example: "ecommerce-operations"
`createdAt`	string (date-time)

CustomerInput

Field	Type	Notes
`companyName`required	string	Example: "Mira Home Goods"
`email`required	string (email)	Example: "[email protected]"
`bundle`	string	Example: "ecommerce-operations"

CustomerList

Field	Type	Notes
`customers`	array<Customer>

Error

Field	Type	Notes
`error`required	string	Example: "validation failed"
`message`	string	Example: "sku is required"
`requestId`	string	Example: "req_01HX9E2M7K8Q4J3V"

CarrierSavingsList

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "CarrierSavingsList"

CarrierSelection

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "CarrierSelection"

OrderSavings

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "OrderSavings"

OrderShipping

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "OrderShipping"

OrderSyncRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "OrderSyncRequest"

OrderSyncResult

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "OrderSyncResult"

PendingOrderList

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "PendingOrderList"

PurchaseLabelRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "PurchaseLabelRequest"

RateOrderRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "RateOrderRequest"

RateQuoteList

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "RateQuoteList"

SavingsSummary

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SavingsSummary"

SelectCarrierRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SelectCarrierRequest"

ShipmentTracking

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ShipmentTracking"

ShippingAnalysis

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ShippingAnalysis"

ShippingAnalysisList

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ShippingAnalysisList"

ShippingAnalysisRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ShippingAnalysisRequest"

ShippingLabel

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ShippingLabel"

VoidLabelRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "VoidLabelRequest"

VoidLabelResult

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "VoidLabelResult"