Interface Orders

All Known Implementing Classes:
OrdersImpl
public interface Orders
Client interface for managing colocation orders in the Equinix Customer Portal.

Backed by the Orders v2 API at /colocations/v2/orders/{orderId}. Orders cannot be created or listed through this API (use OrderHistory for historical listings); they are retrieved by id and acted upon through negotiations, notes, and cancellation.

  • Method Details

    • getByUuid

      Order getByUuid(String orderId)
      Retrieves a specific order by its unique identifier.
      Parameters:
      orderId - the identifier of the order
      Returns:
      the matching order

    • getByUuid

      Order getByUuid(String orderId, List<String> ibxs)
      Retrieves a specific order by its unique identifier, scoped to the supplied IBXs.

      Maps to GET /colocations/v2/orders/{orderId} with the ibxs query parameter.

      Parameters:
      orderId - the identifier of the order
      ibxs - the IBX codes to scope the order to, or null/empty for all
      Returns:
      the matching order

    • getNegotiations

      List<? extends OrderNegotiation> getNegotiations(String orderId)
      Retrieves the negotiation messages for an order, each proposing an alternative date and time for fulfilling the order request.
      Parameters:
      orderId - the identifier of the order
      Returns:
      the list of negotiation messages

    • replyNegotiation

      Boolean replyNegotiation(String orderId, NegotiationAction action, String referenceId)
      Replies to an order negotiation, approving or cancelling the proposed schedule.
      Parameters:
      orderId - the identifier of the order
      action - the action to perform (APPROVE, APPROVE_NON_EXPEDITE, or CANCEL)
      referenceId - the reference id of the activity or order line
      Returns:
      true if the reply was accepted

    • replyNegotiation

      Boolean replyNegotiation(String orderId, NegotiationAction action, String referenceId, String reason)
      Replies to an order negotiation, approving or cancelling the proposed schedule, with an optional reason (used when cancelling).
      Parameters:
      orderId - the identifier of the order
      action - the action to perform (APPROVE, APPROVE_NON_EXPEDITE, or CANCEL)
      referenceId - the reference id of the activity or order line
      reason - the reason for the action (used when cancelling)
      Returns:
      true if the reply was accepted

    • addNote

      Boolean addNote(String orderId, String text)
      Adds a note to an order.
      Parameters:
      orderId - the identifier of the order
      text - the text of the note
      Returns:
      true if the note was accepted

    • addNote

      Boolean addNote(String orderId, String text, String referenceId, List<AttachmentReference> attachments)
      Adds a note to an order with an optional reference id (for two-way notes) and attachments.
      Parameters:
      orderId - the identifier of the order
      text - the text of the note
      referenceId - the reference id associated with the note, or null
      attachments - references to previously uploaded attachments, or null
      Returns:
      true if the note was accepted

    • cancel

      Boolean cancel(String orderId, String reason)
      Cancels an order.
      Parameters:
      orderId - the identifier of the order
      reason - the reason for cancellation
      Returns:
      true if the cancellation was accepted

    • cancel

      Boolean cancel(String orderId, String reason, List<AttachmentReference> attachments, List<String> lineIds)
      Cancels an order, optionally restricting cancellation to specific order lines and attaching supporting documentation.
      Parameters:
      orderId - the identifier of the order
      reason - the reason for cancellation
      attachments - references to previously uploaded attachments, or null
      lineIds - the order line ids to cancel, or null to cancel the whole order
      Returns:
      true if the cancellation was accepted