SHshipium
plans

Endpoint to retrieve an existing plan.

Changed on
get/api/v1/fe/plans/{planId}

Request

Path parameters

planIdstring required

Query parameters

asOfDateTimestring date-time

Response

Details on existing plan, shipment candidates calculated.

partnerIdstring

Unique id of the partner.

urnstring

The uniform resource name for identifying this fe asset. The format is `urn:fe:<asset-name>:<assetId>:<version>

namestring

The human readable name describing this fe asset.

descriptionstring

Extra explanatory information about this fe asset.

activeboolean

Indication of whether this fe asset is active.

archivedboolean

Indication of whether this fe asset is archived.

planIdstring required

Unique id of the plan generated by Shipium.

partnerPlanIdstring

Optional Id allowing partners to set their own Id for looking up plans.

resultingInventoryobject required

Status of inventory after inventory assigned for use in proposed shipments. productId -> ProductInventoryStatus

requestTenantIdstring

Either the shipium tenant ID or the partner provided tenant ID. When present, this is the tenant Id sent on the request.

shipiumTenantIdstring

The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the plan.

partnerTenantIdstring

The partner provided tenant ID. When present, this is used to indicate the tenant associated with the plan.

assumeQuantityAvailableInfiniteboolean

Echoes the request-level assumeQuantityAvailableInfinite when it was submitted as true. Purely diagnostic — it lets a plan be interpreted from its response alone. Mirrors the tenant echo.

Example response

{
  "urn": "urn:fe:global-config:FE91F3A8-6838-469A-B9F8-2D82127573DC:1",
  "auditInfo": {
    "version": 1
  },
  "proposedShipments": [
    {
      "cost": {
        "performance": {
          "estimatedDeliveryDateLocal": "2007-12-03T10:15:30"
        }
      },
      "destinationAddress": {
        "name": "Wile E. Coyote",
        "company": "ACME",
        "street1": "123 Main St.",
        "street2": "Suite 42",
        "city": "Albuquerque",
        "region": "NM",
        "countryCode": "US",
        "postalCode": "\"87121\"",
        "addressType": "commercial"
      },
      "packagingType": {
        "linearDimensions": {
          "linearUnit": "in",
          "length": 13,
          "width": 12,
          "height": 10
        },
        "weight": {
          "weightUnit": "lb",
          "weight": 50
        },
        "maxContentWeight": {
          "weightUnit": "lb",
          "weight": 50
        }
      },
      "shipmentItems": [
        {
          "productId": "RN03947--Z43121",
          "linearDimensions": {
            "linearUnit": "in",
            "length": 13,
            "width": 12,
            "height": 10
          },
          "weight": {
            "weightUnit": "lb",
            "weight": 50
          }
        }
      ],
      "totalWeight": {
        "weightUnit": "lb",
        "weight": 50
      }
    }
  ],
  "unfulfillableItems": [
    {
      "orderItem": {
        "productId": "RN03947--Z43121"
      }
    }
  ]
}

Changes