HemiOS - Hemi API changes and additions - Phase 1

The purpose of this page is to hold the specifics needed for our Open API to cover the project of connecting Hemi and OS as Phase1

Background - Hemi and OS are to be connected with the business purpose to deliver a new product proposition to the market of HemiOS capturing all flows for marketplace management. The business flow will be delivered in a phased approach.

• Phase 1 - Showcase in OS UI information populated from Hemi through integration via ChannelReply. Potentially have some functions created / updated back into Hemi?
• Phase2 - Build a fully fledged Hemi<>OS integration to deliver additional functionality and experience to the end user market

This document will be addressing only the needs for Phase1

What is needed - OS need to showcase information from Hemi in their right hand CR panel to enrich the experience and allow for a single UI management and handling of the Customer Support requests.

This means that OS need to be able to obtain the following information as easy as possible

• Orders
  • Main info
  • Order Items
  • Order Shipments
  • Order Refunds
  • Order Claims
• Product information
  • Main info
  • Product Accounts

Information needs to be as close as possible and as easy as possible obtainable between the two main section so it will be good if we can easily pick information from products based on the SKU and Account of the order (the order will always be the main starting driver)

The idea is to be able to pull info per order separately to enrich the info in OS (via CR)

At a later stage we should introduce also actions:

• Update claims
• Create refunds
• Create shipment
• Create a new order to simulate exchange

<v1.1>

Authentication changes

For every request an extra header is required. Along with the Authorization: Bearer {token} the new header is X-Hemi-Account-Id: {threecoltsAccountIdFromSSO}. For every request this will be required so that the information is pulled for the correct client. The access token is the same for every client. It is per API user.

Access to clients is provided manually by request for now.

</v1.1>

EXAMPLE FIELDS to pull:

• Orders
  • IDs
    • Hemi
    • Marketplace
  • Totals
    • Total
    • Subtotal
    • Shipping cost
    • Tax
  • Account
  • Statuses
    • Hemi
    • Marketplace
  • Shipping address
  • Billing address
  • Order Items
    • Identifiers
      • ID
      • SKU
    • Title
    • Quantity
    • Prices
      • Trans Price
      • Original
      • Discount
      • Tax
    • Dimensions
    • Statuses
      • Hemi
      • Marketplace
    • Bundle info
      • Is Bundle
      • Is Component
      • Check for bundle
    • Order Item Lines
      • All fields
  • Order Shipments
    • ID
    • Tracking
    • Courier
    • URL
    • Status
    • Shipment Rows
      • All fields
      • Row Lines
        • All fields
  • Order Payments
    • ID
    • Type
    • Total
    • Status
    • Reason
    • Internal Reason
    • Refund Rows
      • All fields
      • Row Lines
        • All fields
  • Order Claims
    • All fields
    • Claim lines
      • All fields
    • Claim Shipment
      • All fields
• Products
  • Item Information
    • Identifiers
      • SKU
      • EAN
      • UPC
      • MPN
    • Images
    • Title
    • Dimensions
    • Bundle info
    • Bundle Components
      • All fields
    • Product Listings
      • Title
      • Account
      • Category
      • ChannelItemID
      • ProductStatus
      • ListingStatus
      • Price
      • RRP
      • Original Price
      • Closed
      • Update status fields
      • Quantity
      • Description
      • Attributes
        • IS
        • VS
      • Protection flags
        • Stock
        • Price
        • Item
      • Description