Internal Webservice

Send shipment shipped email

Send shipment shipped email notification

post/api/internal/sendShipmentShippedEmail

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/internal/sendShipmentShippedEmail
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

salesforceOppIdstring nullable

Salesforce opportunity ID for the shipment email

Example request

{
  "salesforceOppId": "0061234567890ABC"
}

Response

OK

customerShipmentEmailState'SHIPPING_CONFIRMATION_SUCCESS' | 'SHIPPING_CONFIRMATION_FAILURE' | 'SHIPPING_SHIPPED_SUCCESS' | 'SHIPPING_SHIPPED_FAILURE' | 'UNKNOWN'
errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
legacyMsgstring nullable

Legacy message for the shipment email

trackingIdentifierstring nullable

Tracking identifier for the shipment

warningMsgstring nullable

Example response

{
  "legacyMsg": "Shipment has been processed",
  "trackingIdentifier": "1Z999AA1234567890"
}

Changes

No recorded changes to this operation across all 1 revision of this API.