Skip to main content
POST
Send shipment shipped email

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for sending shipment shipped email notification.

salesforceOppId
string | null

Salesforce opportunity ID for the shipment email

Example:

"0061234567890ABC"

Response

200 - application/json

OK

Response object for shipment email operations.

customerShipmentEmailState
enum<string>
Available options:
SHIPPING_CONFIRMATION_SUCCESS,
SHIPPING_CONFIRMATION_FAILURE,
SHIPPING_SHIPPED_SUCCESS,
SHIPPING_SHIPPED_FAILURE,
UNKNOWN
error
boolean | null
errorMsg
string | null
legacyMsg
string | null

Legacy message for the shipment email

Example:

"Shipment has been processed"

trackingIdentifier
string | null

Tracking identifier for the shipment

Example:

"1Z999AA1234567890"

warningMsg
string | null
Last modified on August 19, 2026