Web Service Details: OrderManagementService

Seekda Community Feedback

• OrderManagementServicePort (Protocol: SOAP11_HTTP)

  • AddOrderItems
    Adds order items to an order. Each order item consists of information about a catalog item that is intended to be ordered. You cannot use this operation to update an already existing order item in the specified order. To update an order item within an order, use the operation UpdateOrderItems. The operation will fail if any selected items are not permitted to order or have been deleted by the provider. In this case, these items can not be added into the order. The following fields are ignored in the order items when they are added Guid ProviderOrderGuid OrderItemState The option selection on the order items is optional when adding the item. The selection will be validated if present; however it will be ignored if it is not present. When the order is validated, any order items missing a required option selection will be rejected. The item guids returned from this operation will not be in any particular order; therefore a client should not assume that the guids are in the same order as the items that were added. A client can use the GetOrderItemNamesByOrder operation to retrieve the pairing of catalog item guids to order item guids.
    Input: AddOrderItems
    Output: AddOrderItemsResponse
  • CancelOrder
    Requests the cancellation of an order that has been submitted and has not yet been fulfilled. There may be a cost associated with cancelling the order which will be determined by the particular providers. If a provider does not support cancelling, the provider order will continue to be processing while other providers that do support cancelling will be cancelled. A single provider can also be cancelled directly using another operation. Only a user owns the order can cancel their provider order with this operation.
    Input: CancelOrder
    Output: CancelOrderResponse
  • CancelProviderOrder
    Cancels a single provider order. A provider may not support this operation. Only orders that have been submitted but not yet fulfilled can be cancelled. Only a user owns the order can cancel their provider order with this operation. If the provider does not support cancelling, this operation will raise a fault.
    Input: CancelProviderOrder
    Output: CancelProviderOrderResponse
  • CreateAndSubmitOrder
    This is a convenience method that creates the order, adds items, sets user information, and submits the order all in one call. The following fields are ignored in the order items when they are added to the order Guid ProviderOrderGuid OrderItemState
    Input: CreateAndSubmitOrder
    Output: CreateAndSubmitOrderResponse
  • CreateOrder
    Creates an order. Items may also be added to the newly created order with this call. The following fields are ignored in the order items when they are added Guid ProviderOrderGuid OrderItemState The option selection on the order items is optional when creating the item. The selection will be validated if present; however it will be ignored if it is not present. When the order is validated, any order items missing a required option selection will be rejected.
    Input: CreateOrder
    Output: CreateOrderResponse
  • GetCatalogItemOrderInformation
    Returns information about one or more catalog items. This includes the information available for a catalog item including the type and description of the item, which provider owns it, its price (if any) and a list of the options for the item. These options may include shipping and packaging options, or the information necessary for the fulfillment of a service.
    Input: GetCatalogItemOrderInformation
    Output: GetCatalogItemOrderInformationResponse
  • GetOrderGuidsByStateAndOwner
    Returns all the order guids that are in one of the states given. This applies only to orders created by the current user.
    Input: GetOrderGuidsByStateAndOwner
    Output: GetOrderGuidsByStateAndOwnerResponse
  • GetOrderItemNamesByOrder
    Returns the order item guids and the catalog item guids of all the order items in the specified order if the user who owns the order is calling this. If the user is acting as a provider and does not own the order then the items from the provider order will be returned.
    Input: GetOrderItemNamesByOrder
    Output: GetOrderItemNamesByOrderResponse
  • GetOrderItemNamesByProviderOrder
    Returns the order item guids and the catalog item guids of all the order items in the specified provider orders.
    Input: GetOrderItemNamesByProviderOrder
    Output: GetOrderItemNamesByProviderOrderResponse
  • GetOrderItems
    Gets order items by their guids. This method can be called by a user who owns the order or a user acting as a provider with items in the provider order for that provider.
    Input: GetOrderItems
    Output: GetOrderItemsResponse
  • GetOrders
    Gets orders. This returns orders with the provider orders. The order items are retrieved with separate calls. Regular users can call this to get orders they own. A user acting as a provider can call this to get orders they own and orders with provider orders for the provider they are acting as. If the user does not own the order the other provider orders will be removed from the returned object.
    Input: GetOrders
    Output: GetOrdersResponse
  • GetProviderOrderGuidsByStateAndOwner
    Returns all of the provider guids that are in one of the given states owned by the current user.
    Input: GetProviderOrderGuidsByStateAndOwner
    Output: GetProviderOrderGuidsByStateAndOwnerResponse
  • GetProviderOrderGuidsByStateAndProvider
    Returns all of the provider guids that are in one of the given states for the provider being acted as. Only users acting as providers can access this operation. In ECHO v9 only the following provider order states can be searched by providers PROCESSING CANCELLING SUBMIT_FAILED SUBMIT_REJECTED CANCELLED CLOSED
    Input: GetProviderOrderGuidsByStateAndProvider
    Output: GetProviderOrderGuidsByStateAndProviderResponse
  • QuoteOrder
    Sends each provider order of the order to the provider for a quote. A quoted order provides a binding price for the order as a whole. A quote request is an asynchronous call, as the binding quote response from each of the necessary providers may take a day or more to receive. No changes may be made to an order while it is in the quoting process. Also, a change to the order subsequent to the receipt of a quote may invalidate the quoted price. Validation is performed internally prior to quotation to make sure the items are not deleted and orderable.
    Input: QuoteOrder
    Output: QuoteOrderResponse
  • RemoveOrderItems
    Removes one or more order items from a their order. If multiple order items are specified, and just one of them either does not exist in the order or is invalid in some way, then none of the order line items will be deleted, and a fault will be returned.
    Input: RemoveOrderItems
    Output: RemoveOrderItemsResponse
  • RemoveOrders
    Removes orders. This deletes the entire order, including all associated provider orders. To delete a specific provider order(s), a user should use the RemoveProviderOrders operation. Only owners of the order or administrators can remove it.
    Input: RemoveOrders
    Output: RemoveOrdersResponse
  • RemoveProviderOrders
    Removes provider orders. It will only delete the specified provider order (and thus all of the order line items associated with that provider) from the bigger order. All other non-specified provider sub-orders will stay intact.
    Input: RemoveProviderOrders
    Output: RemoveProviderOrdersResponse
  • SetAuthenticationKey
    Sets the authentication key for a provider order. The authentication key is created in the user service based on a template structure defined by the provider. This operation is only available for registered ECHO users.
    Input: SetAuthenticationKey
    Output: SetAuthenticationKeyResponse
  • SetUserInformationForOrder
    Sets the user's shipping, billing and contact information for a particular order. The email address specified in the contact information will be used to notify the user of any order status update including provider contact information. Any existing data will be overridden. All addresses must contain a city name. The user domain and region cannot be set to unspecified.
    Input: SetUserInformationForOrder
    Output: SetUserInformationForOrderResponse
  • SubmitOrder
    Submits an order. The order is validated first, the operation returns, and then the order is processed asynchronously. Each provider order in the order is sent to the provider for processing. If the provider order is accepted by the provider, it is assumed that the provider order will be fulfilled, and if necessary payment will be received. The user can set notification level which defines conditions that email notification will be sent upon order status changes. The status can be checked by retrieving the order periodically.
    Input: SubmitOrder
    Output: SubmitOrderResponse
  • UpdateOrderItems
    Updates existing order items in an order. The option selection on the order items is optional when updating the item. The selection will be validated if present; however it will be ignored if it is not present. When the order is validated, any order items missing a required option selection will be rejected.
    Input: UpdateOrderItems
    Output: UpdateOrderItemsResponse
  • ValidateOrder
    Validates an order. This is convenience method is not necessary to call to submit or quote an order. The order is valid if all of the required options for each order line item, provider order, or order are specified, and the user has provided adequate contact information. If this operation is successful, it will change the order's state to VALIDATED. This fails if any items in the order are no longer permitted to order due to permission/restriction changes by the provider or have been deleted by the provider. In this case, these items must be removed from the order.
    Input: ValidateOrder
    Output: ValidateOrderResponse