How it works

×

The BirdDog E-Automate connector listens for incoming requests from ECI™ E-Automate's Purchase Order Processor™ (also known as PO Processor or POP) and responds with the appropriate information:

  • Authorization
    • If no authorization is sent then the responses will be based upon the security of an anonymous user
    • Basic authorization can be used to authenticate as an website user
  • Available Probes
    • GET url api/probes
    • Returns a list of available probes
  • Probe Top
    • GET url api/probes/top
    • Ensures light weight and fast running indicator of API availability
  • Probe Bottom
    • GET url api/probes/bottom
    • Ensures the API can reach all of the systems, databases, files, and other resources required to operate normally.
  • Available Shipping Methods Check
    • Notes
      • GET URL api/freight/shipmethods
      • Returns the ship via code and name of all available shipping methods from Site Settings>Ecommerce>Ship Vias
    • Mapping
      • Ship Via Code -> reference.code
      • Ship Via Description -> reference.name
  • Stock Check
    • Notes
      • POST URL api/inventory/stockcheck
      • Returns the quantity available and price for the locations configured in Global Settings>Security
      • If Show Zero Quantity Locations is not set then the item/location must have quantity available to be returned
      • A Stock Check can consist of one or more items. A cart is built to hold the request and can also be used for reporting stock check activity
      • All stock check requests are logged with a category of API Inventory Stock/Price Check Request
      • Sample request
    • Mapping:
      • Cart.ID -> reference.code
      • "ID" -> reference.name
      • Seller -> reference.type
      • Lines -> Items - Note that an item will be returned for each location in return locations at which it is stocked
        • Item Number -> reference.code
        • "Seller" -> reference.type
        • Description -> description
        • Price -> cost
        • Quantity Available -> quantity.value
        • Location.Description -> location.rcp
        • Location.Address 1-> location.dal
        • Location.Address 2-> location.alt
        • Location.City-> location.city
        • Location.State-> location.region
        • Location.Zip-> location.postalCode
        • Location.Country-> location.country
  • Price Check
    • Notes
      • POST URL api/inventory/pricecheck
      • Returns the price for the first available location configured in Global Settings>Security
      • If Show Zero Quantity Locations is not set then the item/location must have quantity available to be returned
      • A Price Check can consist of one or more items. A cart is built to hold the request and can also be used for reporting price check activity
      • All price check requests are logged with a category of API Inventory Stock/Price Check Request
      • Sample request
    • Mapping:
      • Cart.ID -> reference.code
      • "ID" -> reference.name
      • Seller -> reference.type
      • Lines -> Items - Note that an item will be returned for each location in return locations at which it is stocked
        • Item Number -> reference.code
        • "Seller" -> reference.type
        • Description -> description
        • Price -> cost
        • Quantity Available -> quantity.value
        • Location.Description -> location.rcp
        • Location.Address 1-> location.dal
        • Location.Address 2-> location.alt
        • Location.City-> location.city
        • Location.State-> location.region
        • Location.Zip-> location.postalCode
        • Location.Country-> location.country
  • Order Request
    • Notes
      • POST url api/orders/order
      • Places a new order based upon a purchase order
      • All order requests are logged with a category of API Sales Order Request
      • Sample request
    • New Order:
      • Purchase Order Number -> reference.code
      • Buyer.Reference.Code when Buyer.Reference.Type=Seller -> RemoteID on customer linkage used when sending an invoice
      • Customer and Bill To information defaults to the user's customer
      • currency.code -> Currency Code
      • shippingMethod.code -> Ship Via Code
        • If shippingMethod.code is not sent then we use the Customer's Default Ship To's Ship Via
        • If the customer doesn't have a Default Ship To then the Customer's Ship Via is used
        • If the customer or ship to ship via is not in the list from Site Settings>Ecommerce>Ship Vias then the first ship via from that list will be used
      • shipTo.email -> Orderedy By Email
      • shipTo.phone -> Orderedy By Phone
      • shipTo.location.rcp -> Ship To Name
      • shipTo.location.dal -> Ship To Address 1
      • shipTo.location.alt -> Ship To Address 2
      • shipTo.location.city -> Ship To City
      • shipTo.location.region -> Ship To State
      • shipTo.location.postalCode -> Ship To Zip
      • shipTo.location.country -> Ship To Country
      • Items -> Lines
        • reference.code-> Item Number  - Note that the user placing the order must have buy permissions
        • cost -> Price - Note that the behavior of cost to price mapping is affected by the setting Site Settings>cXML>Price below contract price
        • quantity.value -> Quantity Ordered
        • location.remarks -> Comments
    • Response:
      • Order Number -> reference.code
      • "orderNumber" -> reference.name
      • Seller -> reference.type
      • Currency Code -> currency.code
      • Ship Via Code -> shippingMethod.code
      • Ship Via Description -> shippingMethod.name
      • Estimated Delivery Date -> whenExpected
      • Orderedy By Email -> shipTo.email
      • Orderedy By Phone -> shipTo.phone
      • Ship To Name -> shipTo.location.rcp
      • Ship To Address 1 -> shipTo.location.dal
      • Ship To Address 2 -> shipTo.location.alt
      • Ship To City -> shipTo.location.city
      • Ship To State -> shipTo.location.region
      • Ship To Zip -> shipTo.location.postalCode
      • Ship To Country -> shipTo.location.country
      • Lines -> Items
        • Item Number -> reference.code
        • "Seller" -> reference.type
        • Description -> description
        • Price -> cost
        • Quantity Available -> quantity.value
        • Location.Description -> location.rcp
        • Location.Addr_1 -> location.dal
        • Location.Addr_2 -> location.alt
        • Location.City -> location.city
        • Location.Zip -> location.zip
        • Location.Country -> location.country
      • total.amount = Sub Total by Ordered
      • total.freightAmount = Freight by Ordered
      • total.taxes = Tax by Ordered

Once an order from E-Automate has been fulfilled the connector will upload the invoice and tracking information.

  •  Invoice
    • Sent to {Connector.URL}/apis/v1/receipt-service/sellers/{Connector.Company}/buyers/{RemoteID from the customer linkage}/receipts