Get Shipment by External ID

Query Shipments created using your own custom ID convention.

POST

Body

Arguments

stringrequired

The external id of the shipment. Example: 'SS-1234567890'

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/shipStationV2/actions/get-shipment-by-external-id/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "version": "0.0.98",
  "arguments": {
    "externalShipmentid": ""
  }
}'

{
  "success": true,
  "data": [
    {
      "advancedOptions": {
        "additionalHandling": true,
        "ancillaryEndorsementsOption": {},
        "billToAccount": "string",
        "billToCountryCode": "string",
        "billToParty": "string",
        "billToPostalCode": "string",
        "collectOnDelivery": {},
        "containsAlcohol": true,
        "customField1": "string",
        "customField2": "string",
        "customField3": "string",
        "deliveredDutyPaid": true,
        "dryIce": true,
        "dryIceWeight": {},
        "eventNotification": true,
        "fedexFreight": {},
        "freightClass": {},
        "limitedQuantity": true,
        "nonMachinable": true,
        "ownDocumentUpload": true,
        "returnPickupAttempts": {},
        "saturdayDelivery": true,
        "thirdPartyConsignee": true
      },
      "amountPaid": {
        "amount": 1,
        "currency": "string"
      },
      "assignedUser": {},
      "carrierId": "string",
      "comparisonRateType": {},
      "confirmation": "string",
      "createdAt": "2026-05-07T12:00:00.000Z",
      "customs": {},
      "externalOrderId": {},
      "externalShipmentId": "string",
      "holdUntilDate": "2026-05-07T12:00:00.000Z",
      "insuranceProvider": "string",
      "isGift": true,
      "isReturn": true,
      "items[]": {
        "asin": {},
        "externalOrderId": {},
        "externalOrderItemId": "string",
        "name": "Ava Chen",
        "orderSourceCode": {},
        "quantity": 1,
        "salesOrderId": {},
        "salesOrderItemId": {},
        "sku": "string"
      },
      "modifiedAt": "2026-05-07T12:00:00.000Z",
      "notesForGift": {},
      "notesFromBuyer": {},
      "orderSourceCode": {},
      "packages[]": {
        "contentDescription": {},
        "dimensions": {
          "height": 1,
          "length": 1,
          "unit": "string",
          "width": 1
        },
        "externalPackageId": {},
        "insuredValue": {
          "amount": 1,
          "currency": "string"
        },
        "labelMessages": {
          "reference1": {},
          "reference2": {},
          "reference3": {}
        },
        "packageCode": "string",
        "packageId": "string",
        "packageName": "string",
        "products": {},
        "shipmentPackageId": {},
        "weight": {
          "unit": "string",
          "value": 1
        }
      },
      "requestedShipmentService": {},
      "retailRate": {},
      "returnTo": {
        "addressLine1": "string",
        "addressLine2": {},
        "addressLine3": {},
        "addressResidentialIndicator": "string",
        "cityLocality": "string",
        "companyName": "string",
        "countryCode": "string",
        "email": {},
        "instructions": {},
        "name": "Ava Chen",
        "phone": "string",
        "postalCode": "string",
        "stateProvince": "string"
      },
      "serviceCode": "string",
      "shipByDate": "2026-05-07T12:00:00.000Z",
      "shipDate": "2026-05-07T12:00:00.000Z",
      "shipFrom": {
        "addressLine1": "string",
        "addressLine2": {},
        "addressLine3": {},
        "addressResidentialIndicator": "string",
        "cityLocality": "string",
        "companyName": "string",
        "countryCode": "string",
        "email": {},
        "instructions": {},
        "name": "Ava Chen",
        "phone": "string",
        "postalCode": "string",
        "stateProvince": "string"
      },
      "shipmentId": "string",
      "shipmentNumber": "string",
      "shipmentStatus": "string",
      "shippingPaid": {
        "amount": 1,
        "currency": "string"
      },
      "shippingRuleId": {},
      "shipTo": {
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "addressResidentialIndicator": "string",
        "cityLocality": "string",
        "companyName": {},
        "countryCode": "string",
        "email": {},
        "geolocation": {},
        "instructions": {},
        "name": "Ava Chen",
        "phone": {},
        "postalCode": "string",
        "stateProvince": "string"
      },
      "taxPaid": {
        "amount": 1,
        "currency": "string"
      },
      "totalWeight": {
        "unit": "string",
        "value": 1
      },
      "warehouseId": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.