@shipengine/connect-order-source-runtime
TypeScript icon, indicating that this package has built-in type declarations

1.27.6 • Public • Published

Developer Experience Order App Runtime

🚫 This package is deprecated. Only legacy (v1) connect apps use this package, v2 does not need it. 🚫

This is an HTTP runtime host for the ShipEngine Integration Platform's Order App.

In default mode this runtime exposes the eCommerce API 1.0 HTTP specification and serves as a mapping layer between that specification, and the function calls that an Order App implements. ShipStation ultimately makes calls to this API with the ModuleClient, but are first routed through a Gateway using the HTTP header api-code as the discriminator.

The ShipEngine Integration Platform Loader loads the Order App from a directory specified by the environment variable DX_APP_PATH.

The runtime can run Order Apps of two types:

  1. ShipEngine Order App (default)
  2. A proxy for HTTP requests
    1. Set config.runtime_proxy: true in the App package.json
    2. Implement and default export the ProxyApp interface. See ecom-proxy for an example
    3. Mapping is not performed with the proxy app type

Developing

This runtime is invisible to a user of the ShipEngine Integration Platform ecosystem, as it is deployed by an app:publish triggering a build and deployment within the Function Manager.

To run this project locally you must set the DX_APP_PATH env variable to the root directory of your App. You can use .env.local, a .gitignore file.

An example order export of the eCommerce 1.0 specification

curl -X POST 'http://localhost:3006/export_sales_orders' \
    -H 'Content-Type: application/json' \
    -d '{
        "transaction_id": "754e4fc9-a7cd-4718-b029-9876c89267c2",
        "auth": {
            "base_url": "http://mock-custom-store-stage.kubedev.sslocal.com/"
        },
        "from_date_time": "2020-01-27T17:00:00.000Z",
        "to_date_time": "2020-01-27T18:00:00.000Z"
    }'

See Also

This project is based on the Shipping App Runtime found here.

Readme

Keywords

none

Package Sidebar

Install

npm i @shipengine/connect-order-source-runtime

Weekly Downloads

13

Version

1.27.6

License

Apache-2.0

Unpacked Size

168 kB

Total Files

95

Last publish

Collaborators

  • bibhusan-shah
  • alvarofidalgomoran
  • arjun.modi
  • christian.casado
  • lzhang
  • lukasz.parala
  • deeepawesome
  • akowalczyk
  • ddygas
  • pspringerauct
  • dangnguyen91
  • arapicki
  • prasadjoshi29
  • zjaholkowska
  • maciej_sabik_auctane
  • kdobrzynskiactn
  • bmusielak
  • mmilowska
  • bartoszzurawski
  • mspiaczka-auctane
  • maciej_adamek
  • marcin_karwat_auctane
  • krzysztof.malcher
  • auctome
  • sushithegreat
  • agustin.martin.auctane
  • brock.bouchard.auctane
  • auctane.joshua.semar
  • romofel
  • chunter-auctane
  • luxehahn
  • jeffrysparrow
  • uiuxdeveloper
  • ckroutterauctane
  • shipengine_it
  • kaseycantu-se
  • joshuaflanagan
  • anthonyshull
  • binkard-auctane
  • dlblom
  • rickyr
  • dbernazal
  • auc-rhibbeler
  • harris.butler