Skip to main content
POST
/
api
/
internal
/
sendShipmentShippedEmail
Send shipment shipped email
curl --request POST \
  --url https://api2.rhombussystems.com/api/internal/sendShipmentShippedEmail \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "salesforceOppId": "0061234567890ABC"
}
'
{
  "customerShipmentEmailState": "SHIPPING_CONFIRMATION_SUCCESS",
  "error": true,
  "errorMsg": "<string>",
  "legacyMsg": "Shipment has been processed",
  "trackingIdentifier": "1Z999AA1234567890",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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