Web Service: DOP

Port type DOPSoapSource code

1. CancelOrder
   Source code
   Description:
   To cancel an order which is not yet shipped from the vendor ("cancel_success", "status_description").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#CancelOrder
   Input:
   CancelOrderRequest (soap:body, use = literal)Source code
   guid type string
   order_id type string
   po_number type string
   customer_id type string
   order_cancel_items type cancel_itemArray - array of type string
   Output:
   CancelOrderResponse (soap:body, use = literal)Source code
   CancelOrderResult type CancelOrderResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • order_cancel_response type cancel_response
     • order_id type string
     • po type string
     • cancel_success type string
     • status_description type string
2. CreateOrder
   Source code
   Description:
   To create a purchase order into the vendor system ("order_id" ,"dop_order_id" ,"order_success" ,"status_description" ,"order_item_lines.order_item_line.line_id" ,"order_item_lines.order_item_line.product_id" ,"order_item_lines.order_item_line.quantity" ,"order_item_lines.order_item_line.price" ,"order_item_lines.order_item_line. quantity_on_hand" ,"order_item_lines.order_item_line. next_receiving_date" ,"order_item_lines.order_item_line.alt_product_id").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#CreateOrder
   Input:
   CreateOrderRequest (soap:body, use = literal)Source code
   guid type string
   order type Order

   • order_header type order_header
     • order_id type string
     • po type string
     • customer_id type string
     • shipping_code_id type string
     • notes type string
     • billing_info type billing_info
       • company_name type string
       • company_address type string
       • company_address2 type string
       • company_city type string
       • company_state type string
       • company_zip type string
     • shipping_info type shipping_info
       • company_name type string
       • company_address type string
       • company_address2 type string
       • company_city type string
       • company_state type string
       • company_zip type string
   • item_list type Order_item - array of type order_item
     • product_id type string
     • quantity type int
     • price type string
   Output:
   CreateOrderResponse (soap:body, use = literal)Source code
   CreateOrderResult type CreateOrderResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • order_id type string
   • dop_order_id type string
   • order_success type string
   • status_description type string
   • order_item_lines type OrderItemLines - array of type order_item_line
     • line_id type int
     • product_id type string
     • quantity type int
     • price type string
     • quantity_on_hand type int
     • next_receiving_date type string
     • alt_product_id type string
   Fault:
   Error (soap:fault, use = literal)Source code
   fault type Error
3. GetCategories
   Source code
   Description:
   Fetch array of Categories ("id", "name").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#GetCategories
   Input:
   GetCategoriesRequest (soap:body, use = literal)Source code
   guid type string
   Output:
   GetCategoriesResponse (soap:body, use = literal)Source code
   GetCategoriesResult type GetCategoriesResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • category_list type CategoryArray - array of type category
     • category_id type int
     • category_name type string
4. GetOrderStatus
   Source code
   Description:
   To retrieves the status of the purchase order from the vendor system ("order_id", "customer_id", "po_number", "description", "ship_date", "tracking_number", "invoice_number", "item_list.item_shipped.product_id", "item_list.item_shipped.quantity_shipped", "item_list.item_shipped.Cost", "item_list.item_shipped.status_code", "no_shipment_list.item_not_shipped.product_id", "no_shipment_list.item_not_shipped.quantity_ordered", "no_shipment_list.item_not_shipped.disposition", "no_shipment_list.item_not_shipped.status_code").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#GetOrderStatus
   Input:
   GetOrderStatusRequest (soap:body, use = literal)Source code
   guid type string
   po_number type string
   order_id type string
   customer_id type string
   Output:
   GetOrderStatusResponse (soap:body, use = literal)Source code
   GetOrderStatusResult type GetOrderStatusResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • order_list type order_status_info
     • order_status_info type order_status_info_detail
       • order_id type string
       • customer_id type string
       • po_number type string
       • description type string
       • shipment_list type ShipmentsArray - array of type shipments
         • ship_date type string
         • tracking_number type string
         • invoice_number type string
         • item_list type ShippedArray - array of type item_shipped
           • product_id type string
           • quantity_shipped type int
           • cost type string
           • status_code type int
           • ship_date type string
           • tracking_number type string
       • no_shipment_list type NotShippedArray - array of type item_not_shipped
         • product_id type string
         • quantity_ordered type int
         • disposition type string
         • status_code type int
5. GetProductCatalog
   Source code
   Description:
   To retrieve complete list of Catalog information from the respective Accessory Vendor ("product_id", "product_barcode", "manufacturer_part_number", "product_dateadded", "product_datemodified", "product_shortdesc", "product_detail", "price", "product_msrp", "product_weight", "Quantity", "quantity_on_order", "next_receiving_date", "product_manufacture", "product_universal", "product_25mm", "product_35mm", "product_bluetooth", "product_mono_bluetooth", "product_stereo_bluetooth", "product_micro_sd", "product_micro_usb", "product_discontinued", "product_status", "product_video", "picture_list", "model_list", "category_list", "product_parentId", "product_color").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#GetProductCatalog
   Input:
   GetProductCatalogRequest (soap:body, use = literal)Source code
   guid type string
   as_of_date type string
   carrier_id type string
   mpn type string
   Output:
   GetProductCatalogResponse (soap:body, use = literal)Source code
   GetProductCatalogResult type GetProductCatalogResponseObject

   • responseCode - optional; type int
   • responseMessage - optional; type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • item_list type Items - array of type item
     • product_id type string
     • product_barcode type string
     • manufacturer_part_number type string
     • product_dateadded type string
     • product_datemodified type string
     • product_name type string
     • product_clearance type string
     • product_shortdesc type string
     • product_detail type string
     • price type string
     • product_msrp type string
     • product_weight type string
     • quantity type string
     • quantity_on_order type string
     • next_receiving_date type string
     • product_manufacture type string
     • product_universal type string
     • product_25mm type string
     • product_35mm type string
     • product_bluetooth type string
     • product_mono_bluetooth type string
     • product_stereo_bluetooth type string
     • product_micro_sd type string
     • product_micro_usb type string
     • product_discontinued type string
     • product_status type string
     • product_video type string
     • picture_list type PicturesArray - array of type string
     • model_list type ModelsArray - array of type item_models
       • model_id type string
       • manufacturer_part_number type string
     • category_list type categories
       • int type int
       • string type string
     • product_IsParent type string
     • product_parentId type string
     • product_color type string
6. GetProductCatalogList
   Source code
   Description:
   To retrieve list of items from the Catalog with limited data ("product_id", "product_barcode", "manufacturer_part_number", "product_date_added", "product_date_updated", "product_detail", "product_parentId", "product_color").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#GetProductCatalogList
   Input:
   GetProductCatalogListRequest (soap:body, use = literal)Source code
   guid type string
   as_of_date type string
   mpn type string
   Output:
   GetProductCatalogListResponse (soap:body, use = literal)Source code
   GetProductCatalogListResult type GetProductCatalogListResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • item_only_list type item_onlys - array of type item_only
     • product_id type string
     • product_barcode type string
     • manufacturer_part_number type string
     • product_date_added type string
     • product_date_updated type string
7. GetQuantityOnHand
   Source code
   Description:
   To retrieve the current quantity of an item from the Catalog ("product_id", "quantity_on_hand", "as_of_date", "quantity_on_order", "next_receiving_date").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#GetQuantityOnHand
   Input:
   GetQuantityOnHandRequest (soap:body, use = literal)Source code
   guid type string
   product_id type string
   Output:
   GetQuantityOnHandResponse (soap:body, use = literal)Source code
   GetQuantityOnHandResult type GetQuantityOnHandResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • item_quantity_list type ItemQuantities - array of type item_quantities
     • product_id type string
     • quantity_on_hand type int
     • as_of_date type string
     • quantity_on_order type int
     • next_receiving_date type string
8. GetSingleProduct
   Source code
   Description:
   To retrieve the details for a single product from the Catalog ("product_detail", "price", "product_msrp", "product_weight", "Quantity", "product_manufacture", "product_universal", "product_25mm", "product_35mm", "product_bluetooth", "product_mono_bluetooth", "product_stereo_bluetooth", "product_micro_sd", "product_micro_usb", "product_discontinued", "product_parentId", "product_color").
   Style:
   rpc
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   SOAP action:
   http://api.superiorcommunications.com/SuperiorServices/#GetSingleProduct
   Input:
   GetSingleProductRequest (soap:body, use = literal)Source code
   guid type string
   product_id type string
   Output:
   GetSingleProductResponse (soap:body, use = literal)Source code
   GetSingleProductResult type GetSingleProductResponseObject

   • responseCode type int
   • responseMessage type string
   • description type Descriptions
     • title type string
     • version type string
     • author type string
     • author_link type string
     • faq_link type string
     • link type string
     • image_url - optional; type string
     • file_date type string
   • item_list type singleItems - array of type singleitem
     • product_detail type string
     • price type string
     • product_msrp type string
     • product_weight type string
     • quantity type string
     • quantity_on_order type int
     • product_universal type string
     • product_25mm type string
     • product_35mm type string
     • product_bluetooth type string
     • product_mono_bluetooth type string
     • product_stereo_bluetooth type string
     • product_micro_sd type string
     • product_micro_usb type string
     • product_discontinued type string
     • product_parentId type string
     • product_color type string