How It Works

This documentation will guide you through building an integration between products powered by ShipEngine (including ShipStation, ShippingEasy, ShipWorks) and another service provider.

Your project implements and exposes a set of functions that can be consumed by our internal systems. For development, your project is embedded in an HTTP web application. This demonstrates how your functions might be invoked within our systems, while making it accessible to common tools like curl or Postman. The development server will pass the body of the HTTP request as input to your function, and your function's result will be serialized and returned as the HTTP response.

Product Visibility

When an application is promoted to production it becomes available to consumers of the ShipEngine platform including products like ShipWorks, ShippingEasy, ShipStation, etc.

This however does not guarantee that a product will choose to include your integration in their service offerings.

For more details on product availability, please reach out to your business contact with Auctane or the ShipEngine Connect Team.

The SDK contains a TypeScript type definition for each schema in the API documentation.

methods/acknowledge-orders/index.jsmethods/acknowledge-orders/index.ts

Copy

Copied

const { logger } = require('@shipengine/connect-runtime');

/**
 * request will be the body of the http request
 */ 
module.exports.AcknowledgeOrders = (request) => {
  logger.info(
    'This is a log that I can find using the `shipengine-connect logs` command after publishing.'
  );
  return {
    responses: [
      {
        order_id: 'example_order_1',
        succeeded: true,
      },
      {
        order_id: 'example_order_2',
        succeeded: false,
        failure_reason: 'Invalid Order Id'
      },
    ]
  };
  /**
   * This will be serialized as this json response
   {
    "responses": [
        {
          "order_id": 'example_order_1',
          "succeeded": true,
        },
        {
          "order_id": 'example_order_2',
          "succeeded": false,
          "failure_reason": 'Invalid Order Id'
        },
      ]
   }
   */
}

Copy

Copied

import {
  AcknowledgeOrdersRequest,
  AcknowledgeOrdersResponse,
} from "@shipengine/connect-order-source-api";
import { logger } from "@shipengine/connect-runtime";
/**
 * request will be the body of the http request
 */ 
export const AcknowledgeOrders = async (
  request: AcknowledgeOrdersRequest
): Promise<AcknowledgeOrdersResponse> => {
  logger.info(
    "This is a log that I can find using the `shipengine-connect logs` command after publishing."
  );
  return {
    responses: [
      {
        order_id: 'example_order_1',
        succeeded: true,
      },
      {
        order_id: 'example_order_2',
        succeeded: false,
        failure_reason: 'Invalid Order Id'
      },
    ]
  };
  /**
   * This will be serialized as this json response
   {
    "responses": [
        {
          "order_id": 'example_order_1',
          "succeeded": true,
        },
        {
          "order_id": 'example_order_2',
          "succeeded": false,
          "failure_reason": 'Invalid Order Id'
        },
      ]
   }
   */
};

Recommendation

If you use TypeScript, the tooling can help make sure you adhere to the specification. For example, it can provide compiler errors when the object you return from your function does not match the expected schema: type error