Interface Shipments

All Known Implementing Classes:
ShipmentsImpl
public interface Shipments
Client interface for scheduling equipment shipments in the Equinix Customer Portal.

Combines the shipment order APIs at /colocations/v2/orders/shipments and /v1/orders/shipment. Shipments are scheduled and updated as orders; the resulting order is tracked through Orders and OrderHistory, and a shipment is cancelled via Orders.cancel(String, String).

order(ShipmentOrderRequest) and update(String, ShipmentUpdateRequest) return the generated order id (parsed from the Location header). The typed inbound/outbound/pending-storage submissions (orderInbound(InboundShipmentOrderRequest), orderOutbound(OutboundShipmentOrderRequest), orderPendingStorage(PendingStorageOrderRequest)) return the order number(s) in the response body. The IBX locations where the current user may place shipment orders are available via listLocations().

  • Method Details

    • order

      OrderResponse order(ShipmentOrderRequest request)
      Schedules an inbound or outbound shipment.

      Maps to POST /colocations/v2/orders/shipments (Schedule inbound or outbound shipment).

      Parameters:
      request - the shipment order request body
      Returns:
      the order submission result carrying the generated order id

    • update

      OrderResponse update(String orderId, ShipmentUpdateRequest request)
      Updates a pending shipment order.

      Maps to PATCH /colocations/v2/orders/shipments/{orderId} (Update inbound or outbound shipment).

      Parameters:
      orderId - the identifier of the shipment order
      request - the update request body
      Returns:
      the order submission result carrying the order id

    • orderInbound

      ShipmentOrderResponse orderInbound(InboundShipmentOrderRequest request)
      Submits an inbound shipment order.

      Maps to POST /v1/orders/shipment/inbound (shipment-inbound).

      Parameters:
      request - the inbound shipment order request body
      Returns:
      the order submission result carrying the generated order number

    • orderOutbound

      ShipmentOrderResponse orderOutbound(OutboundShipmentOrderRequest request)
      Submits an outbound shipment order.

      Maps to POST /v1/orders/shipment/outbound (outbound_shipment_submit).

      Parameters:
      request - the outbound shipment order request body
      Returns:
      the order submission result carrying the generated order number

    • orderPendingStorage

      List<? extends PendingStorageOrderResponse> orderPendingStorage(PendingStorageOrderRequest request)
      Submits a pending inbound shipment (pending storage) order.

      Maps to POST /v1/orders/shipment/pendingStorage (shipment-pending).

      Parameters:
      request - the pending storage order request body
      Returns:
      one submission result per stored shipment submitted

    • listLocations

      List<? extends ShipmentLocation> listLocations()
      Lists the IBX locations, cages and cabinets where the current user may place shipment orders.
      Returns:
      the list of permitted locations

    • listLocations

      List<? extends ShipmentLocation> listLocations(Boolean detail, String ibxs, String cages)
      Lists the IBX locations, cages and cabinets where the current user may place shipment orders, optionally filtered.

      Maps to GET /v1/orders/shipment/locations (getLocation).

      Parameters:
      detail - when true, returns detailed permission with cages and cabinets, or null for the default
      ibxs - a comma-separated list of IBX codes to filter by (e.g. AM1,AM2), or null
      cages - a comma-separated list of cage ids to filter by (e.g. AM1:02:002MC1), or null
      Returns:
      the list of permitted locations