HemiKnowledge BaseHemiIntegrations
Related Articles
Knowledge Base
Hemi System Administration Integrations Hemi PRD Library Hemi Content Stream General Information Custom additions Core Integrations & Marketplace Documentation Hemi Advanced Functionalities Data Management MP Tokens generation Hemi Technology Trainings Hemi Platform Integrations Release Notes
FAQs

Marketplaces / eBay / GetOrders Statuses

GetOrders Statuses

Status management

eBay orders have 4 status fields that need to be taken in consideration when deciding the internal status of the order. These are as follows

  • OrderStatus
  • CheckoutStatus > Status
  • CheckoutStatus > eBayPaymentStatus
  • CancelStatus

These work in relation to each other having higher and lower priority and working based on an insert or update functionality. Please see detailed explanation below

  1. OrderStatus
    1. eBay docs
      1. http://developer.ebay.com/devzone/xml/docs/reference/ebay/getorders.html#Response.OrderArray.Order.OrderStatus
      2. http://developer.ebay.com/devzone/xml/docs/reference/ebay/extra/gtordrs.rspns.ordrarry.ordr.ordrstts.html
    2. Explanation by status
      1. Active - in the general case this is a status that indicates something is still pending on the order or it has had problems (an open case, is cancelled, etc.). It is to be mapped to 3 different tool statuses in Hemisphere based on the different case:
        1. Pending
          1. CancelStatus is "NotApplicable" / "CancelClosedForCommitment" / "CancelRejected" and at least one of the following is true
            1. CheckoutStatus > eBayPaymentStatus is one of the following values - "PaymentInProcess" / "PayPalPaymentInProcess"
            2. CheckoutStatus > Status is "Incomplete" / "Pending"
        2. Incomplete
          1. CancelStatus is ''CancelFailed" / "CancelPending" / "CancelRequested" / Other unexpected value
          2. CancelStatus is "NotApplicable" / "CancelClosedForCommitment" / "CancelRejected" and at least one of the following is true
            1. CheckoutStatus > eBayPaymentStatus is "BuyerCreditCardFailed" / "BuyerECheckBounced" / "BuyerFailedPaymentReportedBySeller" / Other unexpected value
            2. CheckoutStatus > Status is Other unexpected value
        3. Cancelled
          1. CancelStatus is "CancelClosedNoRefund" / "CancelClosedUnknownRefund" / "CancelClosedWithRefund" / "CancelComplete"
      2. Completed - in the general case this is a status that indicates that the order should be completed, nothing else can be changed on it and with payment checks it should be ready for fulfillment. It is to be mapped to 3 different statuses
        1. Pending
          1. Every data validation and status of the order are on end statuses - CancelStatus is "NotApplicable" / "CancelClosedForCommitment" / "CancelRejected", CheckoutStatus > eBayPaymentStatus is "NoPaymentFailure", CheckoutStatus > Status is "Complete" and PayPal active is true
          2. CancelStatus is "NotApplicable" / "CancelClosedForCommitment" / "CancelRejected" and at least one of the following is true
            1. CheckoutStatus > eBayPaymentStatus is "PaymentInProcess" / "PayPalPaymentInProcess"
            2. CheckoutStatus > Status is "Incomplete" / "Pending"
        2. Incomplete
          1. CheckoutStatus > eBayPaymentStatus is Other unexpected value
          2. CheckoutStatus > Status is Other unexpected value
          3. CancelStatus is Other unexpected value
        3. ReadyForShipping
          1. Every data validation and status of the order are on end statuses (CancelStatus is "NotApplicable" / "CancelClosedForCommitment" / "CancelRejected", CheckoutStatus > eBayPaymentStatus is "NoPaymentFailure", CheckoutStatus > Status is "Complete") and PayPal active is false
      3. Every other status should be treated as Incomplete tool status in Hemisphere
  2. CheckoutStatus > Status
    1. eBay docs
      1. http://developer.ebay.com/devzone/xml/docs/reference/ebay/getorders.html#Response.OrderArray.Order.CheckoutStatus.Status
    2. Explanation by status
      1. Complete - in general status showing the payment process is finished successfully
        1. The only status under which we should move to a ReadyForShipping tool status (or Pending in the case of PayPal active true)
      2. Incomplete - in general status showing the payment process is yet to be initiated
        1. This status should be a marker for Pending tool status
      3. Pending - in general status showing the payment process has been initiated but yet to be fully processed
        1. This status should be a marker for Pending tool status
  3. ChekoutStatus > eBayPaymentStatus
    1. eBay docs
      1. http://developer.ebay.com/devzone/xml/docs/reference/ebay/getorders.html#Response.OrderArray.Order.CheckoutStatus.eBayPaymentStatus
      2. http://developer.ebay.com/devzone/xml/docs/reference/ebay/extra/gtordrs.rspns.ordrarry.ordr.chcktstts.bypymntstts.html
    2. Explanation by status
      1. BuyerCreditCardFailed - Credit Card Payment Failed - applicable only when CC payments are allowed
        1. This status should be a marker for Incomplete tool status (expectation is for such statuses to be seen only with the "Active" OrderStatus)
      2. BuyerECheckBounced - ECheck Payment Failed - applicable only when ECheck payments are allowed
        1. This status should be a marker for Incomplete tool status (expectation is for such statuses to be seen only with the "Active" OrderStatus)
      3. BuyerFailedPaymentReportedBySeller - Other Payment (CashOnDelivery) Failed - an option only triggered by the Seller (expectation is to never see this)
        1. This status should be a marker for Incomplete tool status (expectation is for such statuses to be seen only with the "Active" OrderStatus)
      4. NoPaymentFailure - end status for the field
        1. This status should be a marker that should be used in combination with Status = "Complete" to mark a Checkout on eBay as completed and be used for a ReadyForShipping tool status (Pending when PayPal active is true)
      5. PaymentInProcess - Payment is still in Process - applicable only when using different than PayPal payments (rare occasion)
        1. This status should be a marker for Pending tool status (expectation is for such statuses to be seen mostly with the "Completed" OrderStatus)
      6. PayPalPaymentInProcess - PayPal Payment is still in Process - applicable only when using PayPal payments (most cases)
        1. This status should be a marker for Pending tool status (expectation is for such statuses to be seen mostly with the "Completed" OrderStatus)
  4. CancelStatus
    1. eBay docs
      1. http://developer.ebay.com/devzone/xml/docs/reference/ebay/getorders.html#Response.OrderArray.Order.CancelStatus
      2. http://developer.ebay.com/devzone/xml/docs/reference/ebay/extra/gtordrs.rspns.ordrarry.ordr.cnclstts.html
    2. Explanation by status
      1. CancelClosedForCommitment - Buyer has requested cancellation at some point but has thought over and decided to continue with the order
        1. This status should be a marker for continuing with the logic following the other higher priority statuses (treating as a "NotApplicable status" as potentially the client should've agreed to continue with the order and whatever the previous status of the order has been this should come with a status letting us to continue with the fulfillment of the order)
      2. CancelClosedNoRefund - Cancellation is completed with no refund being processed to the Buyer
        1. This status should be a marker for Cancelled tool status - following the logic of other higher priority statuses
      3. CancelClosedUnknownRefund - Cancellation is completed without knowledge whether or not a refund has been processed to the Buyer
        1. This status should be a marker for Cancelled tool status - following the logic of other higher priority statuses
      4. CancelClosedWithRefund - Cancellation is completed and a refund has been processed to the Buyer
        1. This status should be a marker for Cancelled tool status - following the logic of other higher priority statuses
      5. CancelComplete - Cancellation is completed
        1. This status should be a marker for Cancelled tool status - following the logic of other higher priority statuses
      6. CancelFailed - Cancellation has failed
        1. This status should be a marker for Incomplete tool status
      7. CancelPending - Cancellation request is approved but Pending to be completed
        1. This status should be a marker for Incomplete tool status
      8. CancelRejected - Cancellation requested by the Buyer has been Rejected
        1. This status should be a marker for continuing with the logic following the other higher priority statuses (treating as a "NotApplicable status" as potentially the client's cancellation request has been rejected and whatever the previous status of the order has been this should come with a status letting us to continue with the fulfillment of the order)
      9. CancelRequested - Cancellation has been requested by the Buyer
        1. This status should be a marker for Incomplete tool status
      10. Invalid - The order Cancellation request is invalid
        1. This status should be a marker for Incomplete tool status
      11. NotApplicable - Not applicable to this order
        1. This status should be a marker for continuing with the logic following the other higher priority statuses as there are no cancellations on the order

How to handle the order statuses

Handling the eBay statuses in Hemisphere will take more than the mapping to the tool statuses. This includes inserts versus updates and what information to be actually updated when making changes. To make sure proper information is downloaded and stored in Hemisphere we should follow the next few rules:

  • General order information (order items, addresses, totals, etc.) should be updated with new information only if an order is still on any of the flows explained in points 1.b.i.1, 1.b.i.2 and 1.b.ii
  • Other updates based on the flows logic should be done only to the status fields in Hemisphere - this includes Order Payment statuses which are to be introduced as Payment Details are to be stored directly coming from eBay and just be confirmed by the PayPal integration
  • As we are to confirm a payment when PayPal active is true directly with PayPal but there is also a new option where we might have tool status Pending and MP order status Completed we must change the selection for PayPal to fire a payment check call. The MP integration (eBay in this case) needs to make a check with it's statuses and raise a flag in the Payment details record created to enable PayPal to make the check. For eBay this means a that the following statuses should be:
    • PayPal active = true
    • OrderStatus = "Completed"
    • CheckoutStatus > eBayPaymentStatus = "NoPaymentFailure"
    • CheckoutStatus > Status = "Complete"
  • Last but not least we must do a change to the marking of OutOfStock orders. This should be taken separately to a simple flag on Order level to be marked when we are updating/inserting an order as flows explained in points 1.b.ii.1.a and 1.b.ii.3. This way simple out of stock products will not mess with the standard order flow and status change and Incomplete can be used as what it is meant to be used - a problem order. To expand on the new OutOfStock flag on order level this needs to be raised only by the eBay integration (nothing to do with PayPal now that it is not a status)
Is this article helpful?
0 0 0