eBay Fulfilment OC Technical Scope Phase 1

The purpose of this document is to give good understanding how eBay fulfilment will be integrated with Hemi

Latest API spec and connection guidelines: https://mf-seller-static-hk.orangeconnex.com/static/website/document/UK//20211117/1637147111937/OCERP Connection Guidelines v1.0.pdf

Latest version of seller manual:  https://www.orangeconnex.co.uk/sellermanual.html

Shipping services and weight/dimensions restrictions:  at the bottom of page: https://www.orangeconnex.co.uk/fulfillment.html API Documentation:

3PP API Document_beta_v4.1.xlsx

Test Credentials:

1. Authorization

STEP 1

To begin the authorization flow, the 3PP constructs a URL like the following

Request:

POST: https://authorization-server.com/oauth/authorize?response_type=code&client_id=a74877d520200ae841a2cfc34c46e208&redirect_uri=https%3A%2F%2Fexample-app.com%2Fcallback&state=xcoiv98y2kd22vusuye3kch
Content-Type: application/x-www-form-urlencoded;charset=UTF-8

When the user visits this URL, the authorization server will present them with a prompt asking if they would like to authorize this application’s request. If the user approves the request, OC will redirect the browser back to the redirect_uri specified by the application, adding a code and state to the query string.

Response:

https%3A%2F%2Fexample-app.com%2Fcallback?code=g0ZGZmNjVmOWIjNTk2NTk4ZTYyZGI3&state=xcoiv98y2kd22vusuye3kch

STEP 2 Once we get the authorization code,  we need to exchange the authorization token for an access token and refresh token.

POST: /oauth/token?grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcallback&client_td=409uioe809eoiuo434
Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Request:

Response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODc4OTg4OTQsInVzZXJfbmFtZSI6IjE1NzY0NzcwNDY4NzAwMjEiLCJjbGllbnRfaWQiOiJjYzE3YzMwY2QxMTFjNzIxNWZjOGY1MWY4NzkwZTBlMSIsInNjb3BlIjpbImFsbCJdfQ.L_u1FA-sIy5ure4z-j18_mqkfT4ZslwliHgC6UHFcF7zAUtrI5vrrK_weIyGGhE3r_9V8GFLhp-GPNtezLQdOGsD12DbnBYmBeHLHPbmHFZ3a4KX2gyz4FzocL-A6Kj633TlL5vIhCc2jBV9iXUiR0yCmLSsQbISnowVz8vdJT4ltd6KGwVpAZQZ6QtB6WwLOrDViyxEmFrIpGAd-Lc2p53vEJvCfUdJu_JyUUaGVow7k2amuaPu6LRfCvFTOy75kp51Pwy2Y_rTYJ5halY5Orh0qTEYSKEEiBElfR-oAytwYqJ8UuvjGBL0TnBrsiKp5TJGu9Cd72Z8fRhbF4oEq4P2Dr9zCS3pyoZMYjSwuEfNxaAvlzQMs_oWb9KxACi5SYlSfryEmltnY1yNSvPrKXu-lb37JtHIisAZqMXLb4vkRz86NgMNOXHmQewRCzKgeNpDVjVrqnUhlwfJy0hwNa71hFMTi9RvOooBfJIo2gqAMnliucTtpAfotq1gdullwFRkZZTXoQGzHovMkkibzQrglQlIqfghyGAnGC7X9oR2YWvF0enMuIpb3yB4hpIB48S8wfbntZDw_sLCibYA7IEqdyfyOrDiy8QBUn4ltIO2uizwgwJXz1Y-Ty5PzVA_2vGH00Bj7ElFReb0IEtt9wfNqtqSfIGZge9hGRrEFmU",
  "token_type": "bearer",
  "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MTc1MjQyNTcsInVzZXJfbmFtZSI6IjE1NzY0NzcwNDY4NzAwMjEiLCJjbGllbnRfaWQiOiJjYzE3YzMwY2QxMTFjNzIxNWZjOGY1MWY4NzkwZTBlMSIsInNjb3BlIjpbImFsbCJdfQ.BjXrwlXlsNvi2-r8dXkEnAvUbtOXFSRdYSgC181uE1XZP6mbYLPHfAX2Xp_KstlUjC_W9Iw5XzZUz9PrGoZhtkEan96kdlZ0RpW_BBs_ikYnkRJ_8IgASvHTpQNu-jcYnaVRiyoSHyqs1TXdv97cru3tMXReanKkEtEt8RUMiLfoJ-T7OZ8fjIcVW1mfIRGcFmvmI3hTsDSOSPSCiFtFeyR1FKXghq2Qjlcms8paZCNr-qucdvxi9Iexs-Z6y8hDJ27HUTz1tYxL0icOx67-GPsUGqW6gThOwDV1Cwc7pQUKjROXJXcxAMi94m_TddgSHvcZb0euAw6Yy6A72lNh8whTQ9URQoD_9jL_OUNfxma6bYsqjeajR01efhpKSu9igSJLzTDmFmNGKEdGXDCoN4k5sqtoPA_YRSDqM0SdMk0xCRAbkFJg9ZesrpqPGvH1Ny566yQPfGWkrQ_T8xhz990K1BT_3TYqpwEU1X6Obkzzb6MNYHf-phMMfwPzFDQlqHZjTUuwjV8Q5yQG2h_jz4rd8q83L0DFFv0lQHwS5Xjx8t21m0aQFHHwphGWhOTxoHvqqpNjzRM3IRsfe_-dJlMmzoe9YsrIECeh8WZB5_hR5g2YhfQZl5QvXOZ21mPz4neRq-XlVcDnRGlm9c9CDf8OsihTTXv0vLzZTRarkIY"f,
  "expires_in": 3600
}

STEP3

Once we have generated the access and the refresh token every 3600 seconds we will need to regenerate the Access Token using the following Request:

POST /oauth/token?grant_type=refresh_token&refresh_token=SplxlOBeZQQYbYS6WxSbIA&client_id=409uioe809eoiuo434 Content-Type: application/x-www-form-urlencoded

Response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODc4OTg4OTQsInVzZXJfbmFtZSI6IjE1NzY0NzcwNDY4NzAwMjEiLCJjbGllbnRfaWQiOiJjYzE3YzMwY2QxMTFjNzIxNWZjOGY1MWY4NzkwZTBlMSIsInNjb3BlIjpbImFsbCJdfQ.L_u1FA-sIy5ure4z-j18_mqkfT4ZslwliHgC6UHFcF7zAUtrI5vrrK_weIyGGhE3r_9V8GFLhp-GPNtezLQdOGsD12DbnBYmBeHLHPbmHFZ3a4KX2gyz4FzocL-A6Kj633TlL5vIhCc2jBV9iXUiR0yCmLSsQbISnowVz8vdJT4ltd6KGwVpAZQZ6QtB6WwLOrDViyxEmFrIpGAd-Lc2p53vEJvCfUdJu_JyUUaGVow7k2amuaPu6LRfCvFTOy75kp51Pwy2Y_rTYJ5halY5Orh0qTEYSKEEiBElfR-oAytwYqJ8UuvjGBL0TnBrsiKp5TJGu9Cd72Z8fRhbF4oEq4P2Dr9zCS3pyoZMYjSwuEfNxaAvlzQMs_oWb9KxACi5SYlSfryEmltnY1yNSvPrKXu-lb37JtHIisAZqMXLb4vkRz86NgMNOXHmQewRCzKgeNpDVjVrqnUhlwfJy0hwNa71hFMTi9RvOooBfJIo2gqAMnliucTtpAfotq1gdullwFRkZZTXoQGzHovMkkibzQrglQlIqfghyGAnGC7X9oR2YWvF0enMuIpb3yB4hpIB48S8wfbntZDw_sLCibYA7IEqdyfyOrDiy8QBUn4ltIO2uizwgwJXz1Y-Ty5PzVA_2vGH00Bj7ElFReb0IEtt9wfNqtqSfIGZge9hGRrEFmU",
  "token_type": "bearer",
  "expires_in": 3600
}

2.Get StockSnapshot

Because we are not creating products directly from Hemi to OC system will be using their interface for product management and with the use of this call we will be able to get all the internal OCSKU for each of our Hemi SKUs and be able to identify which products are currently part of the OC fulfilment. Please note the stock levels stored for OC in Hemi are just for reference. Per OCSKU, OC will provide a location-specific inventory snapshot of the request time. If this field is null, OC returns all the SKUs' inventory snapshot of the request time. POST https://openapi-uk.orangeconnex.com/openapi/3pp/inventory/v1/snapshot

Request body:

{
  "data": [
    {
      "MFSKUID": null
      }
  ],
  "messageId": "20200430030118653",
  "timestamp": 1588230078677
}

Response:

{
    "code": 0,
    "data": [
        {
            "MFSKUID": "OC0000000400371",
            "serviceRegionList": [
                {
                    "serviceRegion": "DE",
                    "inventoryList": [
                        {
                            "actualCount": 3,
                            "inventoryStatus": "INTRAN"
                        },
                        {
                            "actualCount": 300,
                            "inventoryStatus": "AVL"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RCVD"
                        },
                        {
                            "actualCount": 5,
                            "inventoryStatus": "RSVALOC"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RSVHO"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RSVAS"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "UNF"
                        }
                    ]
                },
                {
                    "serviceRegion": "UK",
                    "inventoryList": [
                        {
                            "actualCount": 0,
                            "inventoryStatus": "INTRAN"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "AVL"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RCVD"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RSVALOC"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RSVHO"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "RSVAS"
                        },
                        {
                            "actualCount": 0,
                            "inventoryStatus": "UNF"
                        }
                    ]
                }
            ],
            "snapshotTime": "2021-10-22T09:56:41+0800",
            "sellerSkuId": "GY0005886"
        }
    ],
    "message": "test",
    "messageId": "20200430030118653"
}

We skip it and just return it in the terminal if you manually run the cron. If we are missing item account this is what we want to do. Basically should return just for “SKU 123456 item account for eBay UK is missing” | | | | | message | | | | N/A | | | | | | messageId | | | | N/A | | | | | | | | | | Product Account Orange Connex > Created in OC | Checkbox which indicated if the SKU is created in the OC portal. Will be set on “yes” if we receive matching sellerSkuId in the response. Consequetly if we have a product which is on “Yes” and is missing from the response we need to set it as “No” | | | |

3. GetOrders Amendments

Since we will need to identify which orders will be fulfilled by eBay and which with other courier we will need to start storing the Fulfillment type which we receives for every eBay order. eBay will separate orders depending on whether they are eBayFulfiled or seller fulfilled – please see explanation below

     <Fulfillment>
              <FulfillmentBy> string </FulfillmentBy>
              <FulfillmentRefId> string </FulfillmentRefId>
    </Fulfillment>

The new fields will be stored in Order Item eBay and also we will need to set the correct Order Item eBay > Type - Fulfilled by eBay. If all

4. Ship Orders Amendments

All order item with Orders > Marketplace Fulfillment Channel = “Fulfilled by eBay” will need to be skipped and not shipped from Hemi. Thus we need to add this logic in the current eBay shipping cron and skip such orders: cron_ebay_007_shipped_orders_update.php

Q&A

Can an order be with eBay Fulfilled items and seller fulfilled items? No, we will have either Seller Fulfilled Order or eBay Fulfilled Order and the order will be separated.