Partner

Get client shipments

POST/api/partner/getShipments

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting client shipments within a time range.

clientOrgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

endTimeSecinteger<int64> | nullbody

End time for shipment search (seconds since epoch)

Example: 1640995200

startTimeSecinteger<int64> | nullbody

Start time for shipment search (seconds since epoch)

Example: 1640908800

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partner/getShipments' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "endTimeSec": 1640995200,
    "startTimeSec": 1640908800
  }'

import requests

url = "https://api2.rhombussystems.com/api/partner/getShipments"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "endTimeSec": 1640995200,
    "startTimeSec": 1640908800
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partner/getShipments', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "endTimeSec": 1640995200,
    "startTimeSec": 1640908800
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "endTimeSec": 1640995200,
              "startTimeSec": 1640908800
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partner/getShipments"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "customerShipmentList": [
    {
      "ait-aitTrackingNumber": "<string>",
      "ait-carrierTrackingNumber": "<string>",
      "ait-depositorOrderNumber": "<string>",
      "ait-destinationAddress": "<string>",
      "ait-isIngramDistributorShipment": true,
      "ait-shipmentDate": "2026-01-01T00:00:00Z",
      "ait-shippedItems": [
        {
          "partNumber": "<string>",
          "quantityShipped": 0,
          "serialNumber": "<string>"
        }
      ],
      "interchangeControlNumber": "<string>",
      "lastStateUpdateSec": 0,
      "rhombus-additionalEmails": "<string>",
      "rhombus-chosenCarrierName": "<string>",
      "rhombus-claimKeyToLicenseMap": {
        "<key>": [
          "<string>"
        ]
      },
      "rhombus-claimKeyToLicenseMapV2": {
        "<key>": {
          "<key>": {}
        }
      },
      "rhombus-customerEmails": "<string>",
      "rhombus-customerName": "<string>",
      "rhombus-orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-partnerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-purchaseOrderNumber": "<string>",
      "rhombus-rmaReturnTrackingNumber": "<string>",
      "rhombus-rmaUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rhombus-rmaUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombus-salesForceOpportunityId": "<string>",
      "rhombus-zendeskTicketNumber": "<string>",
      "shipmentCategory": "RMA",
      "shipmentEmailState": "SHIPPING_CONFIRMATION_SUCCESS",
      "shipmentState": "CREATED",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response object containing client shipments within the specified time range.

customerShipmentListobject[] | null

List of customer shipments

Show child attributes

ait-aitTrackingNumberstring | null

ait-carrierTrackingNumberstring | null

ait-depositorOrderNumberstring | null

ait-destinationAddressstring | null

ait-isIngramDistributorShipmentboolean | null

ait-shipmentDatestring<date-time> | null

ait-shippedItemsobject[] | null

Show child attributes

partNumberstring | null

quantityShippedinteger<int32> | null

serialNumberstring | null

interchangeControlNumberstring | null

lastStateUpdateSecinteger<int64> | null

rhombus-additionalEmailsstring | null

rhombus-chosenCarrierNamestring | null

rhombus-claimKeyToLicenseMapobject | null

rhombus-claimKeyToLicenseMapV2object | null

Show child attributes

contractEndDateTimestring | null

contractStartDateTimestring | null

rhombus-customerEmailsstring | null

rhombus-customerNamestring | null

rhombus-orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

rhombus-partnerOrgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

rhombus-purchaseOrderNumberstring | null

rhombus-rmaReturnTrackingNumberstring | null

rhombus-rmaUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

rhombus-rmaUuidsstring<RUUID>[] | null

rhombus-salesForceOpportunityIdstring | null

rhombus-zendeskTicketNumberstring | null

shipmentCategoryenum<string>

Available options: RMA, PURCHASE_ORDER, TRIAL, UNKNOWN

shipmentEmailStateenum<string>

Available options: SHIPPING_CONFIRMATION_SUCCESS, SHIPPING_CONFIRMATION_FAILURE, SHIPPING_SHIPPED_SUCCESS, SHIPPING_SHIPPED_FAILURE, UNKNOWN

shipmentStateenum<string>

Available options: CREATED, SHIPPED, DELIVERED, RETURN_REGISTERED, RETURN_SENT, RETURN_DELIVERED, COMPLETE, UNKNOWN

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

errorboolean | null

errorCodestring | null

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

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.